Package com.nomagic.magicreport.engine.velocity

Class RTFEngine

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.AbstractTemplateEngine

com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

com.nomagic.magicreport.engine.velocity.RTFEngine

All Implemented Interfaces:

IExtensionTemplateEngine, com.nomagic.magicreport.engine.IRuntimeInstanceVelocityEngine, ITemplateEngine, StyledDocument

@OpenApiAll
public class RTFEngine
extends DefaultTemplateEngine
implements StyledDocument

This class provides an instance of the Velocity template engine.

Since:

Jun 11, 2007 10:49:57 PM

Version:

1.0 Jun 11, 2007

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

velocityContext

Fields inherited from class com.nomagic.magicreport.engine.AbstractTemplateEngine

context, isAborted, preProcessFile, processFile, properties

Fields inherited from interface com.nomagic.magicreport.format.html.StyledDocument

CHARACTER, COLOR, FONT, PARAGRAPH, TABLE

Constructor Summary

Constructors

Constructor	Description
RTFEngine()	Create instance of engine.

Method Summary

Modifier and Type	Method	Description
int	addColor(Color color)	Appends the specified color to the document's color table.
int	addFont(Font font)	Appends the specified font to the document's font table.
int	addList(List list)	Appends the specified list item to the document's style table.
int	addObject(Object object)	Appends object content into the document.
int	addStyle(Style style)	Appends the specified style to the document's style table.
protected String	createComment(String message)	Return a formatted comment from given message.
protected ParseErrorException	createParseErrorWrapper(ParseErrorException parseError, Reader source)	Create a ParseErrorException from the message.
protected void	handleForPage(Template template, StringBuilder inProcessBuffer)	Handle the #forpage directive.
protected void	handleForRow(Template template, StringBuilder inProcessBuffer)	Handle the #forrow directive.
protected void	handleSectionBegin(Template template, StringBuilder inProcessBuffer)	Handle the #sectionBegin directive.
protected int	lineCount(String content)	Count number of line from given content string.
protected void	postProcess(Template template)	Perform a post-processing after the template has been evaluated.
protected void	preProcess(Template template)	Perform a pre-processing before evaluate the template.
protected TemplateException	processVelocityException(Template template, org.apache.velocity.exception.ParseErrorException e)	Call this method to process an Velocity exception and return in new format.
void	setProperty(String key, Object value)	Set an engine Runtime property.
protected void	translate(Template template, StringBuilder inProcessBuffer)	Translate the RTF document into valid VTL document.

Methods inherited from class com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

abort, checkFileNotFoundException, clearTools, createTemplate, createTemplate, createTemplate, destroy, getClassLoader, getFormatter, getResolvedSectionName, handleImport, handleIncludeSection, isNoSpaceException, process, process, processException, processVelocityException, setClassLoader, setFormatter, setLatestLocation, setLocation, setWriterForEvaluate, trimTrailSpace

Methods inherited from class com.nomagic.magicreport.engine.AbstractTemplateEngine

addContext, addInvalidReferenceHandler, addObserver, addReferenceInsertionHandler, evaluate, evaluate, getConcurrentToolException, getContext, getCurrentRuntimeInstance, getInvalidReferenceHandler, getProcessSize, getProperties, getProperty, getReferenceInsertionHandler, isMemoryMode, notifyObservers, observers, setConcurrentToolException, setContext, setCurrentRuntimeInstance

Methods inherited from class java.util.Observable

clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Constructor Details

RTFEngine

public RTFEngine()

Create instance of engine.

Method Details

setProperty

public void setProperty(String key,
 Object value)

Set an engine Runtime property.

Specified by:

setProperty in interface ITemplateEngine

Overrides:

setProperty in class DefaultTemplateEngine

Parameters:

key - the key to be placed into this property list.

value - the value corresponding to key.

See Also:

• ITemplateEngine.getProperty(String)

lineCount

protected int lineCount(String content)

Count number of line from given content string.

Overrides:

lineCount in class DefaultTemplateEngine

Parameters:

content - the input string

Returns:

number of line

translate

protected void translate(Template template,
 StringBuilder inProcessBuffer)
                  throws ParseErrorException,
IOException

Translate the RTF document into valid VTL document.

Overrides:

translate in class DefaultTemplateEngine

Parameters:

template - template

inProcessBuffer - in process buffer

Throws:

ParseErrorException - if a syntax or other error which prevents it from being parsed.

IOException - if IO Error occurs while reading template.

See Also:

• DefaultTemplateEngine.translate(com.nomagic.magicreport.Template, java.lang.StringBuilder)

handleForPage

protected void handleForPage(Template template,
 StringBuilder inProcessBuffer)
                      throws ParseErrorException

Handle the #forpage directive.

Overrides:

handleForPage in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleForRow

protected void handleForRow(Template template,
 StringBuilder inProcessBuffer)
                     throws ParseErrorException

Handle the #forrow directive.

Overrides:

handleForRow in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

handleSectionBegin

protected void handleSectionBegin(Template template,
 StringBuilder inProcessBuffer)
                           throws ParseErrorException

Handle the #sectionBegin directive.

Overrides:

handleSectionBegin in class DefaultTemplateEngine

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

ParseErrorException - when error while translation, or syntax not recognized.

createComment

protected String createComment(String message)

Return a formatted comment from given message. The default comment format return from this method is "{\\*\\ {0}}" where {0} is message;

Overrides:

createComment in class DefaultTemplateEngine

Parameters:

message - message to put in document comment

Returns:

comment

processVelocityException

protected TemplateException processVelocityException(Template template,
 org.apache.velocity.exception.ParseErrorException e)

Call this method to process an Velocity exception and return in new format. Override DefaultTemplateEngine.processVelocityException(Template, org.apache.velocity.exception.ParseErrorException) to return exception with valid RTF line count.

Overrides:

processVelocityException in class DefaultTemplateEngine

Parameters:

template - Template

e - Velocity exception

Returns:

TemplateException

createParseErrorWrapper

protected ParseErrorException createParseErrorWrapper(ParseErrorException parseError,
 Reader source)

Create a ParseErrorException from the message.

Parameters:

parseError - root cause

source - source template

Returns:

instance of ParseErrorException

preProcess

protected void preProcess(Template template)
                   throws TemplateException

Perform a pre-processing before evaluate the template.

Overrides:

preProcess in class DefaultTemplateEngine

Parameters:

template - template before evaluated.

Throws:

ParseErrorException - if a syntax or other error which prevents it from being parsed.

InitializationEngineException - error while initializing engine

TemplateException - other error while processing the template

See Also:

• AbstractTemplateEngine.preProcess(com.nomagic.magicreport.Template)

postProcess

protected void postProcess(Template template)
                    throws TemplateException

Perform a post-processing after the template has been evaluated.

Overrides:

postProcess in class DefaultTemplateEngine

Parameters:

template - template after evaluated.

Throws:

ParseErrorException - if a syntax or other error which prevents it from being parsed.

InitializationEngineException - error while initializing engine

TemplateException - other error while processing the template

See Also:

• AbstractTemplateEngine.postProcess(com.nomagic.magicreport.Template)

addColor

public int addColor(Color color)

Appends the specified color to the document's color table. Returns an index of color from table.

Specified by:

addColor in interface StyledDocument

Parameters:

color - specified color.

Returns:

index of color from color table in document.

addFont

public int addFont(Font font)

Appends the specified font to the document's font table. Returns an index of font from table.

Specified by:

addFont in interface StyledDocument

Parameters:

font - specified font.

Returns:

index of font from font table in document.

addList

public int addList(List list)

Appends the specified list item to the document's style table. Returns an index of list from table.

Specified by:

addList in interface StyledDocument

Parameters:

list - type of list

Returns:

listTableSize index of list

addStyle

public int addStyle(Style style)

Appends the specified style to the document's style table. Return an index of style from table.

Specified by:

addStyle in interface StyledDocument

Parameters:

style - a style. Reproduce from StyleContext.NamedStyle

Returns:

index of style from style table in document.

addObject

public int addObject(Object object)

Appends object content into the document.

Specified by:

addObject in interface StyledDocument

Parameters:

object - adding object

Returns:

index to object