org.wandora.modules.servlet

Class AbstractTemplate

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.servlet.AbstractTemplate

All Implemented Interfaces:

Module, Template

Direct Known Subclasses:

VelocityTemplate

public abstract class AbstractTemplate
extends AbstractModule
implements Template

A base implementation for templates. Performs common actions to most templates. Among these, parses from the initialisation parameters values for many of the template variables, these are defined in variables named templateKey, templateVersion, templateMimeType and templateEncoding. Also templateCaching and templateFile which are not in the Template interface but are common template features.

A default template context can also be specified in the initialisation parameters using the parameter name prefix "context.". The rest of parameter name is used as the variable name in the context.

This base implementation automatically registers the template to a TemplateManager at module start, as all templates should do to be usable.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	templateCaching
protected java.util.HashMap<java.lang.String,java.lang.Object>	templateContext
protected java.lang.String	templateEncoding
protected java.lang.String	templateFile
protected java.lang.String	templateKey
protected TemplateManager	templateManager
protected java.lang.String	templateMime
protected java.lang.String	templateVersion

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
AbstractTemplate()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
java.lang.String	getEncoding() Returns the character encoding used by the returned content.
protected java.lang.String	getFullTemplatePath()
java.lang.String	getKey() Returns the template key.
java.lang.String	getMimeType() Returns the mime type of the content from this template.
java.util.HashMap<java.lang.String,java.lang.Object>	getTemplateContext() Returns the default context for this template.
java.lang.String	getVersion() Returns the template version.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
abstract void	process(java.util.HashMap<java.lang.String,java.lang.Object> params, java.io.OutputStream output) Processes the template with the given context and writes the resulting content in the output stream.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

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

Field Detail

templateManager

protected TemplateManager templateManager

templateKey

protected java.lang.String templateKey

templateVersion

protected java.lang.String templateVersion

templateMime

protected java.lang.String templateMime

templateEncoding

protected java.lang.String templateEncoding

templateCaching

protected boolean templateCaching

templateFile

protected java.lang.String templateFile

templateContext

protected java.util.HashMap<java.lang.String,java.lang.Object> templateContext

Constructor Detail

AbstractTemplate

public AbstractTemplate()

Method Detail

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class AbstractModule

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

getTemplateContext

public java.util.HashMap<java.lang.String,java.lang.Object> getTemplateContext()

Description copied from interface: Template

Returns the default context for this template. You may then add more content into the context before passing it on to process.

Specified by:

getTemplateContext in interface Template

Returns:

The default context of the template.

getFullTemplatePath

protected java.lang.String getFullTemplatePath()

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class AbstractModule

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class AbstractModule

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class AbstractModule

Parameters:

manager - The module manager handling this module.

getKey

public java.lang.String getKey()

Description copied from interface: Template

Returns the template key. The template key is how actions refer to this template.

Specified by:

getKey in interface Template

Returns:

The template key.

getVersion

public java.lang.String getVersion()

Description copied from interface: Template

Returns the template version. You may define several templates using the same key with different versions. For example, you could differentiate between language versions of the otherwise same template.

Specified by:

getVersion in interface Template

Returns:

The version identifier.

getMimeType

public java.lang.String getMimeType()

Description copied from interface: Template

Returns the mime type of the content from this template.

Specified by:

getMimeType in interface Template

Returns:

The mime type of the content returned by this template.

getEncoding

public java.lang.String getEncoding()

Description copied from interface: Template

Returns the character encoding used by the returned content.

Specified by:

getEncoding in interface Template

Returns:

The character encoding used by the content returned from this template.

process

public abstract void process(java.util.HashMap<java.lang.String,java.lang.Object> params,
                             java.io.OutputStream output)

Description copied from interface: Template

Processes the template with the given context and writes the resulting content in the output stream.

Specified by:

process in interface Template

Parameters:

params - The template context used for processing of the template.

output - The output stream where the result is written.