org.smooks.cartridges.templating

Class AbstractTemplateProcessor

java.lang.Object

org.smooks.cartridges.templating.AbstractTemplateProcessor

All Implemented Interfaces:

org.smooks.api.delivery.ContentHandler, 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

Direct Known Subclasses:

FreeMarkerTemplateProcessor, XslTemplateProcessor

public abstract class AbstractTemplateProcessor
extends Object
implements org.smooks.api.resource.visitor.sax.ng.BeforeVisitor, org.smooks.api.resource.visitor.sax.ng.AfterVisitor

Abstract template processing unit.

Defines abstract methods for loading the template in question, as well as convienience methods for processing the template action against the templating result (REPLACE, ADD_TO, INSERT_BEFORE and INSERT_AFTER).

See implementations.

Author:

tfennelly

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE_SPLIT_PI Template split point processing instruction.

Constructor Summary

Constructors

Constructor and Description
AbstractTemplateProcessor()

Method Summary

Modifier and Type	Method and Description
protected abstract void	applyTemplate(Element element, org.smooks.api.ExecutionContext executionContext, Writer writer)
boolean	applyTemplateBefore()
Charset	getEncoding()
protected abstract void	loadTemplate(org.smooks.api.resource.config.ResourceConfig resourceConfig)
void	postConstruct()
protected void	setTemplatingConfiguration(TemplatingConfiguration templatingConfiguration)
void	visitAfter(Element element, org.smooks.api.ExecutionContext executionContext)
void	visitBefore(Element element, org.smooks.api.ExecutionContext executionContext)

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_SPLIT_PI

public static final String TEMPLATE_SPLIT_PI

Template split point processing instruction.

See Also:

Constant Field Values

Constructor Detail

AbstractTemplateProcessor

public AbstractTemplateProcessor()

Method Detail

postConstruct

@PostConstruct
public void postConstruct()

setTemplatingConfiguration

protected void setTemplatingConfiguration(TemplatingConfiguration templatingConfiguration)

loadTemplate

protected abstract void loadTemplate(org.smooks.api.resource.config.ResourceConfig resourceConfig)
                              throws IOException,
                                     TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

applyTemplateBefore

public boolean applyTemplateBefore()

getEncoding

public Charset getEncoding()

visitBefore

public void visitBefore(Element element,
                        org.smooks.api.ExecutionContext executionContext)
                 throws org.smooks.api.SmooksException

Specified by:

visitBefore in interface org.smooks.api.resource.visitor.sax.ng.BeforeVisitor

Throws:

org.smooks.api.SmooksException

applyTemplate

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

visitAfter

public void visitAfter(Element element,
                       org.smooks.api.ExecutionContext executionContext)
                throws org.smooks.api.SmooksException

Specified by:

visitAfter in interface org.smooks.api.resource.visitor.sax.ng.AfterVisitor

Throws:

org.smooks.api.SmooksException