Package com.nomagic.magicreport.engine.velocity

Class TextEngine

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.AbstractTemplateEngine

com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

com.nomagic.magicreport.engine.velocity.TextEngine

All Implemented Interfaces:

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

@OpenApiAll
public class TextEngine
extends DefaultTemplateEngine

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

Constructor Summary

Constructors

Constructor	Description
TextEngine()	Create instance of engine.

Method Summary

Modifier and Type	Method	Description
void	evaluate(Template template)	Merge a template with current context and rendered stream into the writer.
protected void	preProcess(Template template)	Perform a pre-processing before evaluate template.

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

abort, checkFileNotFoundException, clearTools, createComment, createTemplate, createTemplate, createTemplate, destroy, getClassLoader, getFormatter, getResolvedSectionName, handleForPage, handleForRow, handleImport, handleIncludeSection, handleSectionBegin, isNoSpaceException, lineCount, postProcess, process, process, processException, processVelocityException, processVelocityException, setClassLoader, setFormatter, setLatestLocation, setLocation, setProperty, setWriterForEvaluate, translate, trimTrailSpace

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

addContext, addInvalidReferenceHandler, addObserver, addReferenceInsertionHandler, 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

TextEngine

public TextEngine()

Create instance of engine.

Method Details

preProcess

protected void preProcess(Template template)
                   throws TemplateException

Perform a pre-processing before evaluate template. This method do nothing. The process will be pass directly to Velocity.

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)

evaluate

public void evaluate(Template template)
              throws TemplateException

Merge a template with current context and rendered stream into the writer. Overwrite default process so this engine is pure velocity processing.

Specified by:

evaluate in interface ITemplateEngine

Overrides:

evaluate 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:

• ITemplateEngine.evaluate(Template)