org.milyn.templating.freemarker

Class FreeMarkerTemplateProcessor

java.lang.Object

org.milyn.templating.AbstractTemplateProcessor

org.milyn.templating.freemarker.FreeMarkerTemplateProcessor

All Implemented Interfaces:

ContentHandler, DOMElementVisitor, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Consumer, Producer, SAXElementVisitor, SAXVisitAfter, SAXVisitBefore, SAXVisitChildren, SAXVisitor, Visitor

public class FreeMarkerTemplateProcessor
extends AbstractTemplateProcessor
implements SAXElementVisitor, 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) Does this consumer consume the specified named object.
protected void	loadTemplate(SmooksResourceConfiguration config)
void	onChildElement(SAXElement element, SAXElement childElement, ExecutionContext executionContext) Process the onChildElement event for the targeted element.
void	onChildText(SAXElement element, SAXText childText, ExecutionContext executionContext) Process the onChildText event for the targeted element.
protected void	visit(Element element, ExecutionContext executionContext) Apply the template for DOM.
void	visitAfter(Element element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitAfter(SAXElement element, ExecutionContext executionContext) Visit the supplied element after visiting its child elements.
void	visitBefore(Element element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.
void	visitBefore(SAXElement element, ExecutionContext executionContext) Visit the supplied element before visiting its child elements.

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(SmooksResourceConfiguration config)
                     throws IOException

Specified by:

loadTemplate in class AbstractTemplateProcessor

Throws:

IOException

consumes

public boolean consumes(Object object)

Description copied from interface: Consumer

Does this consumer consume the specified named object.

The named object would be a product of a Producer that is executing on the same element. The consumer should only return false if it knows for certain that it doesn't consumer the specified named object. If uncertain, it should error on the side of saying that it does consume the object.

Specified by:

consumes in interface Consumer

Parameters:

object - The product representation

Returns:

True if the consumer consumes the specified product, otherwise false.

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: DOMVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface DOMVisitBefore

Overrides:

visitBefore in class AbstractTemplateProcessor

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: DOMVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface DOMVisitAfter

Overrides:

visitAfter in class AbstractTemplateProcessor

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visit

protected void visit(Element element,
                     ExecutionContext executionContext)
              throws SmooksException

Apply the template for DOM.

Specified by:

visit in class AbstractTemplateProcessor

Parameters:

element - The targeted DOM Element.

executionContext - The Smooks execution context.

Throws:

SmooksException - Failed to apply template. See cause.

visitBefore

public void visitBefore(SAXElement element,
                        ExecutionContext executionContext)
                 throws SmooksException,
                        IOException

Description copied from interface: SAXVisitBefore

Visit the supplied element before visiting its child elements.

Specified by:

visitBefore in interface SAXVisitBefore

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

onChildText

public void onChildText(SAXElement element,
                        SAXText childText,
                        ExecutionContext executionContext)
                 throws SmooksException,
                        IOException

Description copied from interface: SAXVisitChildren

Process the onChildText event for the targeted element.

Be careful when caching element data. This is not a DOM.

Specified by:

onChildText in interface SAXVisitChildren

Parameters:

element - The element containing the text (parent). The targeted element.

childText - The text.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

onChildElement

public void onChildElement(SAXElement element,
                           SAXElement childElement,
                           ExecutionContext executionContext)
                    throws SmooksException,
                           IOException

Description copied from interface: SAXVisitChildren

Process the onChildElement event for the targeted element.

Be careful when caching element data. This is not a DOM.

Specified by:

onChildElement in interface SAXVisitChildren

Parameters:

element - The element containing the child element (parent). The targeted element.

childElement - The child element just added to the targeted element.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.

visitAfter

public void visitAfter(SAXElement element,
                       ExecutionContext executionContext)
                throws SmooksException,
                       IOException

Description copied from interface: SAXVisitAfter

Visit the supplied element after visiting its child elements.

Specified by:

visitAfter in interface SAXVisitAfter

Parameters:

element - The SAX element being visited.

executionContext - Execution context.

Throws:

SmooksException - Event processing failure.

IOException - Error writing event to output writer.