echopoint.template
Class ResourceTemplateDataSource

java.lang.Object
  echopoint.template.AbstractTemplateDataSource
      echopoint.template.ResourceTemplateDataSource

All Implemented Interfaces:

TemplateDataSource, Serializable

public class ResourceTemplateDataSource
extends AbstractTemplateDataSource

ResourceTemplateDataSource takes it template data from a Class Resource

See Also:

Serialized Form

Field Summary

Fields inherited from class echopoint.template.AbstractTemplateDataSource

DEFAULT_CONTENT_TYPE, DEFAULT_ENCODING

Constructor Summary

ResourceTemplateDataSource()
Constructs a ResourceTemplateDataSource with no template resousrce.

ResourceTemplateDataSource(String resource)
Constructs a ResourceTemplateDataSource using the named class resource as template data.

ResourceTemplateDataSource(String resource, ClassLoader classLoader)
Constructs a ResourceTemplateDataSource with the specified class resource as template data.

Method Summary

String	getCanonicalName() Returns a canonical name of this TemplateDataSource.
ClassLoader	getClassLoader()
InputStream	getInputStream() Gets an InputStream of this TemplateDataSource.
String	getResource()
void	setClassLoader(ClassLoader classLoader)
void	setResource(String resource)

Methods inherited from class echopoint.template.AbstractTemplateDataSource

getCachingHints, getCharacterEncoding, getCompilerHints, getContentType, setCachingHints, setCharacterEncoding, setCompilerHints, setContentType

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceTemplateDataSource

public ResourceTemplateDataSource(String resource,
                                  ClassLoader classLoader)

Constructs a ResourceTemplateDataSource with the specified class resource as template data.

Parameters:

resource - - the name of the class resource to load template data from

classLoader - - the class loader to load resources from

ResourceTemplateDataSource

public ResourceTemplateDataSource(String resource)

Constructs a ResourceTemplateDataSource using the named class resource as template data.

Parameters:

resource - - the name of the class resource to load template data from

ResourceTemplateDataSource

public ResourceTemplateDataSource()

Constructs a ResourceTemplateDataSource with no template resousrce.

Method Detail

getCanonicalName

public String getCanonicalName()

Description copied from interface: TemplateDataSource

Returns a canonical name of this TemplateDataSource.

The name returned here is used to look up the parsing result of the internal caching, so it should differ for all different TemplateDataSource objects :-)

May return null if this TemplateDataSource is supposed to be parsed each time. The canonical name would be something like a filename or an URL.

Returns:

a unique name of the TemplateDataSource

See Also:

TemplateDataSource.getCanonicalName()

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: TemplateDataSource

Gets an InputStream of this TemplateDataSource.

Note that this method may be called multiple times in the life of the TemplateDataSource. So you probably have to implement a buffer if your underlying data source is transient ..

Returns:

a InputStream containing the template data

Throws:

IOException

See Also:

TemplateDataSource.getInputStream()

getClassLoader

public ClassLoader getClassLoader()

Returns:

Returns the classLoader.

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Parameters:

classLoader - The classLoader to set.

getResource

public String getResource()

Returns:

Returns the resource.

setResource

public void setResource(String resource)

Parameters:

resource - The resource to set.