org.milyn.templating

Class AbstractTemplateProcessor

java.lang.Object

org.milyn.templating.AbstractTemplateProcessor

All Implemented Interfaces:

ContentHandler, DOMElementVisitor, DOMVisitAfter, DOMVisitBefore, DOMVisitor, Producer, Visitor

Direct Known Subclasses:

FreeMarkerTemplateProcessor, XslTemplateProcessor

public abstract class AbstractTemplateProcessor
extends Object
implements DOMElementVisitor, Producer

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, addto, insertbefore and insertafter).

See implementations.

Author:

tfennelly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractTemplateProcessor.Action
static class	AbstractTemplateProcessor.ActionDecoder

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
boolean	applyTemplateBefore()
protected AbstractTemplateProcessor.Action	getAction()
BeanId	getBindBeanId()
String	getBindId()
Charset	getEncoding()
String	getOutputStreamResource()
Set<String>	getProducts() Get the set of products produced by this producer instance.
void	initialize()
protected abstract void	loadTemplate(SmooksResourceConfiguration config)
protected void	processTemplateAction(Element element, Node templatingResult, ExecutionContext executionContext)
protected void	processTemplateAction(Element element, NodeList templatingResultNodeList, ExecutionContext executionContext)
protected void	setTemplatingConfiguration(TemplatingConfiguration templatingConfiguration)
protected abstract void	visit(Element element, ExecutionContext executionContext)
void	visitAfter(Element 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.

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

initialize

@Initialize
public void initialize()

setTemplatingConfiguration

protected void setTemplatingConfiguration(TemplatingConfiguration templatingConfiguration)

loadTemplate

protected abstract void loadTemplate(SmooksResourceConfiguration config)
                              throws IOException,
                                     TransformerConfigurationException

Throws:

IOException

TransformerConfigurationException

applyTemplateBefore

public boolean applyTemplateBefore()

getProducts

public Set<String> getProducts()

Description copied from interface: Producer

Get the set of products produced by this producer instance.

Specified by:

getProducts in interface Producer

Returns:

The set the set of products produced by this producer instance.

getAction

protected AbstractTemplateProcessor.Action getAction()

getEncoding

public Charset getEncoding()

getBindId

public String getBindId()

getOutputStreamResource

public String getOutputStreamResource()

processTemplateAction

protected void processTemplateAction(Element element,
                                     Node templatingResult,
                                     ExecutionContext executionContext)

processTemplateAction

protected void processTemplateAction(Element element,
                                     NodeList templatingResultNodeList,
                                     ExecutionContext executionContext)

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

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

Parameters:

element - The DOM element being visited.

executionContext - Request relative instance.

Throws:

SmooksException - Element processing failure.

visit

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

Throws:

SmooksException

getBindBeanId

public BeanId getBindBeanId()

Returns:

the bindBeanId