org.milyn.templating.freemarker

Class FreeMarkerTemplateProcessor

java.lang.Object

org.milyn.templating.AbstractTemplateProcessor

org.milyn.templating.freemarker.FreeMarkerTemplateProcessor

All Implemented Interfaces:

org.milyn.delivery.ContentHandler, org.milyn.delivery.dom.DOMElementVisitor, org.milyn.delivery.dom.DOMVisitAfter, org.milyn.delivery.dom.DOMVisitBefore, org.milyn.delivery.dom.DOMVisitor, org.milyn.delivery.ordering.Consumer, org.milyn.delivery.ordering.Producer, org.milyn.delivery.sax.SAXElementVisitor, org.milyn.delivery.sax.SAXVisitAfter, org.milyn.delivery.sax.SAXVisitBefore, org.milyn.delivery.sax.SAXVisitChildren, org.milyn.delivery.sax.SAXVisitor, org.milyn.delivery.Visitor

public class FreeMarkerTemplateProcessor
extends AbstractTemplateProcessor
implements org.milyn.delivery.sax.SAXElementVisitor, org.milyn.delivery.ordering.Consumer

FreeMarker template application ProcessingUnit.

See FreeMarkerContentHandlerFactory.

NOTE that this visitor supports the extra "useNodeModel" parameter when using DOM based filtering. When set to true (default=false), the targeted DOM element will be attached to the model that is passed to the FreeMarker templating engine. This allows the DOM model to be referenced from within the FreeMarker template, with the targeted element name being the "root" name when forming expressions. See freemarker.org for more info.

Author:

tfennelly

Nested Class Summary

Nested classes/interfaces inherited from class org.milyn.templating.AbstractTemplateProcessor

AbstractTemplateProcessor.Action, AbstractTemplateProcessor.ActionDecoder

Field Summary

Fields inherited from class org.milyn.templating.AbstractTemplateProcessor

TEMPLATE_SPLIT_PI

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FreeMarkerTemplateProcessor() Default constructor.
	FreeMarkerTemplateProcessor(TemplatingConfiguration templatingConfiguration) Programmatically configure the FreeMarker Templating Visitor.

Method Summary

Modifier and Type	Method and Description
boolean	consumes(Object object)
protected void	loadTemplate(org.milyn.cdr.SmooksResourceConfiguration config)
void	onChildElement(org.milyn.delivery.sax.SAXElement element, org.milyn.delivery.sax.SAXElement childElement, org.milyn.container.ExecutionContext executionContext)
void	onChildText(org.milyn.delivery.sax.SAXElement element, org.milyn.delivery.sax.SAXText childText, org.milyn.container.ExecutionContext executionContext)
protected void	visit(Element element, org.milyn.container.ExecutionContext executionContext) Apply the template for DOM.
void	visitAfter(Element element, org.milyn.container.ExecutionContext executionContext)
void	visitAfter(org.milyn.delivery.sax.SAXElement element, org.milyn.container.ExecutionContext executionContext)
void	visitBefore(Element element, org.milyn.container.ExecutionContext executionContext)
void	visitBefore(org.milyn.delivery.sax.SAXElement element, org.milyn.container.ExecutionContext executionContext)

Methods inherited from class org.milyn.templating.AbstractTemplateProcessor

applyTemplateBefore, getAction, getBindBeanId, getBindId, getEncoding, getOutputStreamResource, getProducts, initialize, processTemplateAction, processTemplateAction, setTemplatingConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeMarkerTemplateProcessor

protected FreeMarkerTemplateProcessor()

Default constructor.

FreeMarkerTemplateProcessor

public FreeMarkerTemplateProcessor(TemplatingConfiguration templatingConfiguration)

Programmatically configure the FreeMarker Templating Visitor.

Parameters:

templatingConfiguration - The templating configuration.

Method Detail

loadTemplate

protected void loadTemplate(org.milyn.cdr.SmooksResourceConfiguration config)
                     throws IOException

Specified by:

loadTemplate in class AbstractTemplateProcessor

Throws:

IOException

consumes

public boolean consumes(Object object)

Specified by:

consumes in interface org.milyn.delivery.ordering.Consumer

visitBefore

public void visitBefore(Element element,
                        org.milyn.container.ExecutionContext executionContext)
                 throws org.milyn.SmooksException

Specified by:

visitBefore in interface org.milyn.delivery.dom.DOMVisitBefore

Overrides:

visitBefore in class AbstractTemplateProcessor

Throws:

org.milyn.SmooksException

visitAfter

public void visitAfter(Element element,
                       org.milyn.container.ExecutionContext executionContext)
                throws org.milyn.SmooksException

Specified by:

visitAfter in interface org.milyn.delivery.dom.DOMVisitAfter

Overrides:

visitAfter in class AbstractTemplateProcessor

Throws:

org.milyn.SmooksException

visit

protected void visit(Element element,
                     org.milyn.container.ExecutionContext executionContext)
              throws org.milyn.SmooksException

Apply the template for DOM.

Specified by:

visit in class AbstractTemplateProcessor

Parameters:

element - The targeted DOM Element.

executionContext - The Smooks execution context.

Throws:

org.milyn.SmooksException - Failed to apply template. See cause.

visitBefore

public void visitBefore(org.milyn.delivery.sax.SAXElement element,
                        org.milyn.container.ExecutionContext executionContext)
                 throws org.milyn.SmooksException,
                        IOException

Specified by:

visitBefore in interface org.milyn.delivery.sax.SAXVisitBefore

Throws:

org.milyn.SmooksException

IOException

onChildText

public void onChildText(org.milyn.delivery.sax.SAXElement element,
                        org.milyn.delivery.sax.SAXText childText,
                        org.milyn.container.ExecutionContext executionContext)
                 throws org.milyn.SmooksException,
                        IOException

Specified by:

onChildText in interface org.milyn.delivery.sax.SAXVisitChildren

Throws:

org.milyn.SmooksException

IOException

onChildElement

public void onChildElement(org.milyn.delivery.sax.SAXElement element,
                           org.milyn.delivery.sax.SAXElement childElement,
                           org.milyn.container.ExecutionContext executionContext)
                    throws org.milyn.SmooksException,
                           IOException

Specified by:

onChildElement in interface org.milyn.delivery.sax.SAXVisitChildren

Throws:

org.milyn.SmooksException

IOException

visitAfter

public void visitAfter(org.milyn.delivery.sax.SAXElement element,
                       org.milyn.container.ExecutionContext executionContext)
                throws org.milyn.SmooksException,
                       IOException

Specified by:

visitAfter in interface org.milyn.delivery.sax.SAXVisitAfter

Throws:

org.milyn.SmooksException

IOException