fr.opensagres.xdocreport.template.velocity.internal

Class VelocityTemplateEngine

java.lang.Object

fr.opensagres.xdocreport.template.AbstractTemplateEngine

fr.opensagres.xdocreport.template.velocity.internal.VelocityTemplateEngine

All Implemented Interfaces:

ITemplateEngine, VelocityConstants

public class VelocityTemplateEngine
extends AbstractTemplateEngine
implements VelocityConstants

Velocity template engine implementation.

Field Summary

Fields inherited from interface fr.opensagres.xdocreport.template.velocity.VelocityConstants

DESCRIPTION_DISCOVERY, ID_DISCOVERY, VELOCITY_TEMPLATE_ENGINE_KEY

Constructor Summary

Constructors

Constructor and Description
VelocityTemplateEngine(java.util.Properties velocityEngineProperties)

Method Summary

Modifier and Type	Method and Description
IContext	createContext()
IContext	createContext(java.util.Map<java.lang.String,java.lang.Object> contextMap)
void	extractFields(java.io.Reader reader, java.lang.String entryName, FieldsExtractor extractor)
IDocumentFormatter	getDocumentFormatter()
java.lang.String	getId()
java.lang.String	getKind()
protected org.apache.velocity.app.VelocityEngine	getVelocityEngine()
void	initializeVelocityEngine(java.util.Properties velocityEngineProperties)
boolean	isFieldNameStartsWithUpperCase()
void	process(java.lang.String templateName, IContext context, java.io.Writer writer)
protected void	processNoCache(java.lang.String templateName, IContext context, java.io.Reader reader, java.io.Writer writer)
protected void	processWithCache(java.lang.String templateName, IContext context, java.io.Writer writer)
void	setConfiguration(ITemplateEngineConfiguration configuration)

Methods inherited from class fr.opensagres.xdocreport.template.AbstractTemplateEngine

extractFields, getConfiguration, getTemplateCacheInfoProvider, isUseTemplateCache, process, process, process, setTemplateCacheInfoProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityTemplateEngine

public VelocityTemplateEngine(java.util.Properties velocityEngineProperties)

Method Detail

getKind

public java.lang.String getKind()

Specified by:

getKind in interface ITemplateEngine

getId

public java.lang.String getId()

Specified by:

getId in interface ITemplateEngine

createContext

public IContext createContext()

Specified by:

createContext in interface ITemplateEngine

createContext

public IContext createContext(java.util.Map<java.lang.String,java.lang.Object> contextMap)

Specified by:

createContext in interface ITemplateEngine

processWithCache

protected void processWithCache(java.lang.String templateName,
                                IContext context,
                                java.io.Writer writer)
                         throws XDocReportException,
                                java.io.IOException

Specified by:

processWithCache in class AbstractTemplateEngine

Throws:

XDocReportException

java.io.IOException

processNoCache

protected void processNoCache(java.lang.String templateName,
                              IContext context,
                              java.io.Reader reader,
                              java.io.Writer writer)
                       throws XDocReportException,
                              java.io.IOException

Specified by:

processNoCache in class AbstractTemplateEngine

Throws:

XDocReportException

java.io.IOException

getVelocityEngine

protected org.apache.velocity.app.VelocityEngine getVelocityEngine()
                                                            throws XDocReportException

Throws:

XDocReportException

initializeVelocityEngine

public void initializeVelocityEngine(java.util.Properties velocityEngineProperties)
                              throws XDocReportException

Throws:

XDocReportException

setConfiguration

public void setConfiguration(ITemplateEngineConfiguration configuration)

Specified by:

setConfiguration in interface ITemplateEngine

Overrides:

setConfiguration in class AbstractTemplateEngine

getDocumentFormatter

public IDocumentFormatter getDocumentFormatter()

Specified by:

getDocumentFormatter in interface ITemplateEngine

extractFields

public void extractFields(java.io.Reader reader,
                          java.lang.String entryName,
                          FieldsExtractor extractor)
                   throws XDocReportException

Specified by:

extractFields in interface ITemplateEngine

Throws:

XDocReportException

process

public void process(java.lang.String templateName,
                    IContext context,
                    java.io.Writer writer)
             throws java.io.IOException,
                    XDocReportException

Specified by:

process in interface ITemplateEngine

Throws:

java.io.IOException

XDocReportException

isFieldNameStartsWithUpperCase

public boolean isFieldNameStartsWithUpperCase()

Specified by:

isFieldNameStartsWithUpperCase in interface ITemplateEngine