net.sourceforge.rtf.template

Class AbstractTemplateEngine

java.lang.Object

net.sourceforge.rtf.template.AbstractTemplateEngine

All Implemented Interfaces:

ITemplateEngine

Direct Known Subclasses:

FreemarkerTemplateEngineImpl, VelocityTemplateEngineImpl

public abstract class AbstractTemplateEngine
extends Object
implements ITemplateEngine

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	formats Formats to use for formatting of values.
protected Reader	template Reader that contains the template.

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateEngine()

Method Summary

Modifier and Type	Method and Description
protected Object	escapeSpecialCharacters(Object value) Escape special chracters { and } with \{ and \} otherwise, RTF document generated is not valid.
IContext	getContext()
Format	getDefaultFormat(Class clazz) Get the default format for a given class.
IContext	initializeContext() Initialize context.
void	merge(File file) Merge.
void	merge(String file) Merge.
void	merge(Writer writer) Merge.
protected abstract void	mergeWithTemplateEngine(Writer writer)
boolean	mustBeEscaped(Object value) Return true if value must be escaped and false otherwise
void	put(String key, Object value) Put a value for the given key.
protected void	setContext(IContext context)
void	setDefaultFormat(Class clazz, Format format) Set the default format for a given class.
void	setFormatMap(Map commonFormats) Use a pre-populated formats map as the map for this template
void	setGlobalContext(IContext globalContext) Use a pre-populated Context.
void	setTemplate(Reader template) Set the template to use

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.rtf.ITemplateEngine

newContext

Field Detail

formats

protected Map formats

Formats to use for formatting of values.

template

protected Reader template

Reader that contains the template.

Constructor Detail

AbstractTemplateEngine

public AbstractTemplateEngine()

Method Detail

put

public void put(String key,
                Object value)

Put a value for the given key.

Specified by:

put in interface ITemplateEngine

Parameters:

key -

value -

merge

public void merge(String file)
           throws Exception

Merge.

Specified by:

merge in interface ITemplateEngine

Parameters:

file - name of file to merge into

Throws:

Exception

merge

public void merge(File file)
           throws Exception

Merge.

Specified by:

merge in interface ITemplateEngine

Parameters:

file - file to merge into

Throws:

Exception

merge

public void merge(Writer writer)
           throws Exception

Description copied from interface: ITemplateEngine

Merge.

Specified by:

merge in interface ITemplateEngine

Parameters:

writer - writer to merge into

Throws:

Exception

setFormatMap

public void setFormatMap(Map commonFormats)

Use a pre-populated formats map as the map for this template

Parameters:

commonFormats - a pre-built map of formats

setDefaultFormat

public void setDefaultFormat(Class clazz,
                             Format format)

Set the default format for a given class.

Specified by:

setDefaultFormat in interface ITemplateEngine

Parameters:

clazz - class to set format for

format - format to use for instances of the given class

getDefaultFormat

public Format getDefaultFormat(Class clazz)

Get the default format for a given class.

Parameters:

clazz - class to get default format for

Returns:

format

setContext

protected void setContext(IContext context)

getContext

public IContext getContext()

Specified by:

getContext in interface ITemplateEngine

setTemplate

public void setTemplate(Reader template)

Description copied from interface: ITemplateEngine

Set the template to use

Specified by:

setTemplate in interface ITemplateEngine

mustBeEscaped

public boolean mustBeEscaped(Object value)

Return true if value must be escaped and false otherwise

Parameters:

value -

Returns:

escapeSpecialCharacters

protected Object escapeSpecialCharacters(Object value)

Escape special chracters { and } with \{ and \} otherwise, RTF document generated is not valid.

Parameters:

value -

Returns:

initializeContext

public IContext initializeContext()

Description copied from interface: ITemplateEngine

Initialize context. must be called if the same instance of template engine must be used for merge serveral RTF template model.

Specified by:

initializeContext in interface ITemplateEngine

setGlobalContext

public void setGlobalContext(IContext globalContext)

Use a pre-populated Context. This method treats any previously populated keys in the context kindly, so it won't act unpredictably if this is called late

Specified by:

setGlobalContext in interface ITemplateEngine

Parameters:

innerContext - a pre-populated Context object

mergeWithTemplateEngine

protected abstract void mergeWithTemplateEngine(Writer writer)
                                         throws Exception

Throws:

Exception