Package com.nomagic.magicreport.engine.velocity

Class HTMLEngine

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.AbstractTemplateEngine

com.nomagic.magicreport.engine.velocity.DefaultTemplateEngine

com.nomagic.magicreport.engine.velocity.HTMLEngine

All Implemented Interfaces:

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

@OpenApiAll
public class HTMLEngine
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
HTMLEngine()	Create instance of engine.

Method Summary

Modifier and Type	Method	Description
protected String	createComment(String message)	Return a formatted comment from given message.
protected void	handleForRow(Template template, StringBuilder inProcessBuffer)	Handle the #forrow directive.

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

abort, checkFileNotFoundException, clearTools, createTemplate, createTemplate, createTemplate, destroy, getClassLoader, getFormatter, getResolvedSectionName, handleForPage, handleImport, handleIncludeSection, handleSectionBegin, isNoSpaceException, lineCount, postProcess, preProcess, 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, 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

HTMLEngine

public HTMLEngine()

Create instance of engine.

Method Details

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.

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