Package com.nomagic.magicreport.engine.velocity

Class DefaultTemplateEngine

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.AbstractTemplateEngine

com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

All Implemented Interfaces:

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

Direct Known Subclasses:

DOCXEngine, HTMLEngine, LaTeXEngine, PPTXEngine, RTFEngine, TextEngine, XLSXEngine, XMLEngine

@OpenApiAll
public class DefaultTemplateEngine
extends AbstractTemplateEngine
implements IExtensionTemplateEngine

Provide standard template engine for MagicReport. This engine performs directives translation during pre-processing, invoke Velocity evaluate method, and perform post-processing.

Since:

Mar 13, 2008

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.velocity.VelocityContext	velocityContext	Hold velocity context to abort engine.

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

context, isAborted, preProcessFile, processFile, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultTemplateEngine()	Create an instance of engine.

Method Summary

Modifier and Type	Method	Description
void	abort()	Call to abort Velocity context.
protected void	checkFileNotFoundException(Exception e, File file)
void	clearTools()
protected String	createComment(String message)	Return a formatted comment from given message.
Template	createTemplate()	Creates a new and empty Template for generating report by this engine.
Template	createTemplate(File input, File output)	Creates a new Template object.
Template	createTemplate(File input, File output, boolean ignoreLocation)	Creates a new Template object.
void	destroy()	Called by the application or TemplateEngineFactory to inform this engine that it should destroy any resources that it has allocated.
ClassLoader	getClassLoader()	Returns the class loader for the engine.
IFormatter	getFormatter()	Returns a formatter that can be used to create the object layout, and formats of state InsertionHandler.
protected String	getResolvedSectionName(String sectionName)
protected void	handleForPage(Template template, StringBuilder inProcessBuffer)	Handle the #forpage directive.
protected void	handleForRow(Template template, StringBuilder inProcessBuffer)	Handle the #forrow directive.
protected void	handleImport(Template template, StringBuilder inProcessBuffer)	Handle the #include directive.
protected void	handleIncludeSection(Template template, StringBuilder inProcessBuffer)	Handle the #includeSection directive.
protected void	handleSectionBegin(Template template, StringBuilder inProcessBuffer)	Handle the #sectionBegin directive.
protected boolean	isNoSpaceException(Exception e)
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 template.
void	process(Template template)	Process a template.
void	process(Template template, ITemplateEngine parentEngine)	Process a template.
protected TemplateException	processException(Template template, ParseErrorException e)	Call this method to process a ParseErrorException.
protected TemplateException	processVelocityException(Template template, org.apache.velocity.exception.MethodInvocationException e)	Call this method to process an Velocity exception and return in new format (ParseErrorException).
protected TemplateException	processVelocityException(Template template, org.apache.velocity.exception.ParseErrorException e)	Call this method to process an Velocity exception and return in new format (ParseErrorException).
void	setClassLoader(ClassLoader loader)	Sets the class loader for this engine.
void	setFormatter(IFormatter formatter)	Set the formatter to be used with this template engine.
protected void	setLatestLocation(File input, File output)	Call this method to set the latest input and output location from given input and output file.
protected void	setLocation(File input, File output)	Call this method to set the input and output location from given input and output file.
void	setProperty(String key, Object value)	Set an engine Runtime property.
protected BufferedWriter	setWriterForEvaluate(Template template)
protected void	translate(Template template, StringBuilder inProcessBuffer)	Process the template in inProcessBuffer into valid format.
int	trimTrailSpace(int currentEndCursor, StringBuilder inProcessBuffer)	Calculate and return the new cursor at the end of #hash statement after trim.

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

Field Details

velocityContext

protected org.apache.velocity.VelocityContext velocityContext

Hold velocity context to abort engine.

Constructor Details

DefaultTemplateEngine

protected DefaultTemplateEngine()

Create an instance of engine.

Method Details

createTemplate

public Template createTemplate()

Creates a new and empty Template for generating report by this engine.

Specified by:

createTemplate in interface ITemplateEngine

Returns:

an instance of Template

See Also:

• createTemplate(File, File)

createTemplate

public Template createTemplate(File input,
 File output)
                        throws IOException

Creates a new Template object.

Specified by:

createTemplate in interface ITemplateEngine

Parameters:

input - template file.

output - output file.

Returns:

an instance of Template

Throws:

FileNotFoundException - if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened.

IOException - If an I/O error occurs

createTemplate

public Template createTemplate(File input,
 File output,
 boolean ignoreLocation)
                        throws IOException

Creates a new Template object.

Parameters:

input - template file.

output - output file.

ignoreLocation - true to ignore location property for child document

Returns:

an instance of Template

Throws:

FileNotFoundException - if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened.

IOException - If an I/O error occurs

checkFileNotFoundException

protected void checkFileNotFoundException(Exception e,
 File file)
                                   throws FileNotFoundException

Throws:

FileNotFoundException

isNoSpaceException

protected boolean isNoSpaceException(Exception e)

setLocation

protected void setLocation(File input,
 File output)

Call this method to set the input and output location from given input and output file.

Parameters:

input - input template file

output - output report file

See Also:

• TemplateConstants.TEMPLATE_INPUT_FILE
• TemplateConstants.TEMPLATE_INPUT_LOCATION
• TemplateConstants.TEMPLATE_OUTPUT_FILE
• TemplateConstants.TEMPLATE_OUTPUT_LOCATION
• setProperty(String, Object)

setLatestLocation

protected void setLatestLocation(File input,
 File output)

Call this method to set the latest input and output location from given input and output file.

Parameters:

input - input template file

output - output report file

setProperty

public void setProperty(String key,
 Object value)

Set an engine Runtime property.

Specified by:

setProperty in interface ITemplateEngine

Overrides:

setProperty in class AbstractTemplateEngine

Parameters:

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

value - the value corresponding to key.

See Also:

• ITemplateEngine.getProperty(String)

getFormatter

public IFormatter getFormatter()

Returns a formatter that can be used to create the object layout, and formats of state InsertionHandler.

By default this class returns a DefaultFormatter. This formatter handle common text and no Bookmark, Link and Image support. The engine should override this method and return proper formatter implementation.

Specified by:

getFormatter in interface ITemplateEngine

Returns:

a formatter

setFormatter

public void setFormatter(IFormatter formatter)

Set the formatter to be used with this template engine.

Parameters:

formatter - a formatter

preProcess

protected void preProcess(Template template)
                   throws TemplateException

Perform a pre-processing before evaluate template. This step will translate the template into valid velocity format with additional directive recognize.

Specified by:

preProcess in class AbstractTemplateEngine

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)

translate

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

Process the template in inProcessBuffer into valid format.

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

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

IOException - if IO Error occurs while reading template.

handleForPage

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

Handle the #forpage directive.

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.

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.

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

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

handleIncludeSection

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

Handle the #includeSection directive.

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

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

handleImport

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

Handle the #include directive.

Parameters:

template - Template source.

inProcessBuffer - in process buffer.

Throws:

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

trimTrailSpace

public int trimTrailSpace(int currentEndCursor,
 StringBuilder inProcessBuffer)

Calculate and return the new cursor at the end of #hash statement after trim.

Parameters:

currentEndCursor - current end statement cursor

inProcessBuffer - in process buffer

Returns:

new cursor at the end of #hash statement

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;

Parameters:

message - message to put in document comment

Returns:

comment

process

public void process(Template template)
             throws TemplateException

Process a template. By default this method will call velocity engine to renders the input reader using the context into the output writer.

Specified by:

process in class AbstractTemplateEngine

Parameters:

template - template being 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.process(com.nomagic.magicreport.Template)

process

public void process(Template template,
 ITemplateEngine parentEngine)
             throws TemplateException

Process a template. By default this method will call velocity engine to renders the input reader using the context into the output writer.

Specified by:

process in class AbstractTemplateEngine

Parameters:

template - template being evaluated.

parentEngine - an engine to shared a runtime instance for evaluate

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.process(com.nomagic.magicreport.Template)

setWriterForEvaluate

protected BufferedWriter setWriterForEvaluate(Template template)

postProcess

protected void postProcess(Template template)
                    throws TemplateException

Perform a post-processing after the template has been evaluated. This process just copy output file directly from processing location to final output.

Specified by:

postProcess in class AbstractTemplateEngine

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)

processVelocityException

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

Call this method to process an Velocity exception and return in new format (ParseErrorException). By default, we can't get a nice error message from Velocity (Velocity error message containing in plain text and not readable by non-programmer.) And velocity itself doesn't provide any mechanism to get an message from ParseErrorException. This method will format the error message, remove unstructured text from velocity message e.g. "of" (with out appending text)

Parameters:

template - Template

e - MethodInvocationException

Returns:

TemplateException

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 (ParseErrorException). By default, we can't get a nice error message from Velocity (Velocity error message containing in plain text and not readable by non-programmer.) And velocity itself doesn't provide any mechanism to get an message from ParseErrorException. This method will format the error message, remove unstructured text from velocity message e.g. "of" (with out appending text)

Parameters:

template - Template

e - Velocity exception

Returns:

TemplateException

processException

protected TemplateException processException(Template template,
 ParseErrorException e)

Call this method to process a ParseErrorException. This method call internally by postProcess(Template). If code was performed by Velocity (process(Template)), uses method processVelocityException(Template, org.apache.velocity.exception.ParseErrorException). By default this method try to calculate line number from ParseErrorException.getSource().

Parameters:

template - Template

e - MagicReport parse error exception

Returns:

TemplateException

lineCount

protected int lineCount(String content)

Count number of line from given content string.

Parameters:

content - the input string

Returns:

number of line

getClassLoader

public ClassLoader getClassLoader()

Returns the class loader for the engine. This method will return null in such implementations if this class was loaded by the application class loader.

Specified by:

getClassLoader in interface IExtensionTemplateEngine

Returns:

the class loader that loaded the class or interface represented by this object.

setClassLoader

public void setClassLoader(ClassLoader loader)

Sets the class loader for this engine. The class loader must be set before a template is evaluated. This method allows the creator of the template to provide the appropriate class loader to code running in the template when loading classes and resources.

Specified by:

setClassLoader in interface IExtensionTemplateEngine

Parameters:

loader - Class loader for this engine

destroy

public void destroy()

Called by the application or TemplateEngineFactory to inform this engine that it should destroy any resources that it has allocated.

A subclass of engine should override this method if it has any operation that it wants to perform before it is destroyed.

Specified by:

destroy in interface ITemplateEngine

Overrides:

destroy in class AbstractTemplateEngine

abort

public void abort()

Call to abort Velocity context.

Specified by:

abort in interface ITemplateEngine

Overrides:

abort in class AbstractTemplateEngine

getResolvedSectionName

protected String getResolvedSectionName(String sectionName)

clearTools

public void clearTools()