org.smooks.cartridges.templating.freemarker

Class FreeMarkerTemplateProcessor

java.lang.Object

org.smooks.cartridges.templating.AbstractTemplateProcessor

org.smooks.cartridges.templating.freemarker.FreeMarkerTemplateProcessor

All Implemented Interfaces:

org.smooks.api.delivery.ContentHandler, org.smooks.api.delivery.ordering.Consumer, org.smooks.api.resource.visitor.sax.ng.AfterVisitor, org.smooks.api.resource.visitor.sax.ng.BeforeVisitor, org.smooks.api.resource.visitor.sax.ng.SaxNgVisitor, org.smooks.api.resource.visitor.Visitor

public class FreeMarkerTemplateProcessor
extends AbstractTemplateProcessor
implements org.smooks.api.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

Field Summary

Fields inherited from class org.smooks.cartridges.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
protected void	applyTemplate(Element element, org.smooks.api.ExecutionContext executionContext, Writer writer)
protected void	applyTemplate(freemarker.template.Template template, Element element, org.smooks.api.ExecutionContext executionContext, Writer writer)
boolean	consumes(Object object)
protected void	loadTemplate(org.smooks.api.resource.config.ResourceConfig resourceConfig)

Methods inherited from class org.smooks.cartridges.templating.AbstractTemplateProcessor

applyTemplateBefore, getEncoding, postConstruct, setTemplatingConfiguration, visitAfter, visitBefore

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.smooks.api.resource.config.ResourceConfig resourceConfig)
                     throws IOException

Specified by:

loadTemplate in class AbstractTemplateProcessor

Throws:

IOException

consumes

public boolean consumes(Object object)

Specified by:

consumes in interface org.smooks.api.delivery.ordering.Consumer

applyTemplate

protected void applyTemplate(Element element,
                             org.smooks.api.ExecutionContext executionContext,
                             Writer writer)

Specified by:

applyTemplate in class AbstractTemplateProcessor

applyTemplate

protected void applyTemplate(freemarker.template.Template template,
                             Element element,
                             org.smooks.api.ExecutionContext executionContext,
                             Writer writer)
                      throws org.smooks.api.SmooksException

Throws:

org.smooks.api.SmooksException