org.ocltf.templateengine
Interface TemplateEngine

public interface TemplateEngine

The interface that all templates engines used within MDA must implement. It allows us to plug-in the template engine to use for processing of templates used by the system.

Author:

Chad Brandon

Method Summary

void	init(java.util.Map properties) Initializes the TempateEngine.
void	processTemplate(java.lang.String templateFile, java.util.Map templateObjects, java.io.StringWriter output) Processes a template.

Method Detail

init

public void init(java.util.Map properties)

Initializes the TempateEngine.

Parameters:

properties - any initialization properties to pass to the TemplateEngine.

processTemplate

public void processTemplate(java.lang.String templateFile,
                            java.util.Map templateObjects,
                            java.io.StringWriter output)
                     throws java.lang.Exception

Processes a template.

Parameters:

templateFile - the path to the template file that will be processed.

templateObjects - any additional objects we wish to make available to the translation template that is processed

output - the Writer to which to write the output of the processing.

Throws:

java.lang.Exception - any exception that may occur