org.apache.torque.generator.template
Class TemplateOutletImpl

java.lang.Object
  org.apache.torque.generator.outlet.OutletImpl
      org.apache.torque.generator.template.TemplateOutletImpl

All Implemented Interfaces:

Outlet, TemplateOutlet

Direct Known Subclasses:

VelocityOutlet

public abstract class TemplateOutletImpl
extends OutletImpl
implements TemplateOutlet

An implementation of the TemplateOutlet interface.

Constructor Summary

protected

TemplateOutletImpl(QualifiedName name, ConfigurationProvider configurationProvider, String path, String encoding, TemplateFilter templateFilter) Constructs a TemplateOutletImpl with the given name.

Method Summary

String	getContent(ControllerState controllerState) Returns the contents as a Template as a String.
protected String	load(InputStream inputStream, String encoding, TemplateFilter filter) Loads the template, possibly filtering the content..
String	toString() Returns a String representation of this outlet for debugging purposes.

Methods inherited from class org.apache.torque.generator.outlet.OutletImpl

addMergepointMapping, afterExecute, beforeExecute, execute, getInputElementName, getMergepointMapping, getMergepointMappings, getName, getVariable, mergepoint, setInputElementName, setMergepointMapping, setVariable, setVariable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.torque.generator.outlet.Outlet

addMergepointMapping, afterExecute, beforeExecute, execute, getInputElementName, getMergepointMapping, getMergepointMappings, getName, setInputElementName, setMergepointMapping

Constructor Detail

TemplateOutletImpl

protected TemplateOutletImpl(QualifiedName name,
                             ConfigurationProvider configurationProvider,
                             String path,
                             String encoding,
                             TemplateFilter templateFilter)
                      throws ConfigurationException

Constructs a TemplateOutletImpl with the given name.

Parameters:

name - the name of this outlet, not null.

configurationProvider - the provider for reading the templates, not null.

path - the path to the templates, not null. May contain tokens of the form ${....}, these are parsed.

encoding - the encoding of the file, or null if the system's default encoding should be used.

templateFilter - a possible filter for preprocessing the template, not null.

Throws:

NullPointerException - if name or inputStream are null.

ConfigurationException - if the template cannot be loaded.

Method Detail

getContent

public String getContent(ControllerState controllerState)
                  throws ConfigurationException

Description copied from interface: TemplateOutlet

Returns the contents as a Template as a String.

Specified by:

getContent in interface TemplateOutlet

Parameters:

controllerState - the state of the controller, not null.

Returns:

the template as a String.

Throws:

ConfigurationException - if the template cannot be read.

load

protected String load(InputStream inputStream,
                      String encoding,
                      TemplateFilter filter)
               throws IOException

Loads the template, possibly filtering the content..

Parameters:

inputStream - the stream to read from.

encoding - the encoding of the template, or null for auto detection.

filter - a filter for modifying the template, or null for no filtering.

Returns:

the content of the read and filtered template.

Throws:

IOException - if an error occurs while reading the template.

toString

public String toString()

Returns a String representation of this outlet for debugging purposes.

Overrides:

toString in class OutletImpl

Returns:

a String representation of this outlet, never null.

See Also:

Object.toString()