net.sourceforge.rtf

Interface ITemplateEngine

All Known Implementing Classes:

AbstractTemplateEngine, FreemarkerTemplateEngineImpl, VelocityTemplateEngineImpl

public interface ITemplateEngine

Method Summary

Modifier and Type	Method and Description
IContext	getContext()
IContext	initializeContext() Initialize context.
void	merge(File file) Merge.
void	merge(String file) Merge.
void	merge(Writer writer) Merge.
IContext	newContext()
void	put(String key, Object value) Put a value for the given key.
void	setDefaultFormat(Class clazz, Format format) Set the default format for a given class.
void	setGlobalContext(IContext globalContext) Use a pre-populated Context.
void	setTemplate(Reader template) Set the template to use

Method Detail

initializeContext

IContext initializeContext()

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

Returns:

the result.

getContext

IContext getContext()

setTemplate

void setTemplate(Reader template)

Set the template to use

Parameters:

template - the template.

put

void put(String key,
         Object value)

Put a value for the given key.

Parameters:

key - the key.

value - the value.

merge

void merge(String file)
    throws Exception

Merge.

Parameters:

file - name of file to merge into

Throws:

Exception - the exception.

merge

void merge(File file)
    throws Exception

Merge.

Parameters:

file - file to merge into

Throws:

Exception - the exception.

merge

void merge(Writer writer)
    throws Exception

Merge.

Parameters:

writer - writer to merge into

Throws:

Exception - the exception.

newContext

IContext newContext()

Returns:

the result.

setGlobalContext

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

Parameters:

globalContext - the globalContext.

setDefaultFormat

void setDefaultFormat(Class clazz,
                      Format format)

Set the default format for a given class.

Parameters:

clazz - class to set format for

format - format to use for instances of the given class