org.craftercms.core.processors.impl.template

Class TemplateProcessor

java.lang.Object

org.craftercms.core.processors.impl.template.TemplateProcessor

All Implemented Interfaces:

ItemProcessor

public class TemplateProcessor
extends Object
implements ItemProcessor

ItemProcessor that processes the content of certain XML nodes in item descriptors as templates. Template engines that can be used are adapted through the TemplateCompiler interface. Current implementations of this interface include an adapter for FreeMarker templates and another one for SpEL (Spring Expression Language) templates.

Author:

Sumer Jabri, Alfonso Vásquez

See Also:

TemplateCompiler, FreeMarkerStringTemplateCompiler, SpELStringTemplateCompiler, FreeMarker,

Field Summary

Fields

Modifier and Type	Field and Description
protected NodeTemplateModelFactory	modelFactory Factory that provides the models for the templates.
protected TemplateCompiler<IdentifiableStringTemplateSource>	templateCompiler Template compiler.
protected NodeScanner	templateNodeScanner NodeScanner for template nodes.

Constructor Summary

Constructors

Constructor and Description
TemplateProcessor()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if the specified TemplateProcessor's and this instance's fields are equal.
int	hashCode() Returns the hash code for this instance, which is basically the combination of the hash code of each field.
Item	process(Context context, CachingOptions cachingOptions, Item item) Processes the content of certain nodes (found by the NodeScanner in the item's descriptor as templates, by compiling the node text templates through the templateCompiler and then processing the compiled template with a model returned by modelFactory.
void	setModelFactory(NodeTemplateModelFactory modelFactory) Sets the factory that provides the models for the templates.
void	setTemplateCompiler(TemplateCompiler<IdentifiableStringTemplateSource> templateCompiler) Sets the template compiler.
void	setTemplateNodeScanner(NodeScanner templateNodeScanner) Sets the NodeScanner for template nodes.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

templateNodeScanner

protected NodeScanner templateNodeScanner

NodeScanner for template nodes.

templateCompiler

protected TemplateCompiler<IdentifiableStringTemplateSource> templateCompiler

Template compiler. It basically compiles the template provided in an element and then processes it by using a model obtained through the modelFactory.

modelFactory

protected NodeTemplateModelFactory modelFactory

Factory that provides the models for the templates.

Constructor Detail

TemplateProcessor

public TemplateProcessor()

Method Detail

setTemplateNodeScanner

public void setTemplateNodeScanner(NodeScanner templateNodeScanner)

Sets the NodeScanner for template nodes.

setTemplateCompiler

public void setTemplateCompiler(TemplateCompiler<IdentifiableStringTemplateSource> templateCompiler)

Sets the template compiler. It basically compiles the template provided in an element and then processes it by using a model obtained through the modelFactory.

setModelFactory

public void setModelFactory(NodeTemplateModelFactory modelFactory)

Sets the factory that provides the models for the templates.

process

public Item process(Context context,
                    CachingOptions cachingOptions,
                    Item item)
             throws ItemProcessingException

Processes the content of certain nodes (found by the NodeScanner in the item's descriptor as templates, by compiling the node text templates through the templateCompiler and then processing the compiled template with a model returned by modelFactory.

Specified by:

process in interface ItemProcessor

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

item - the item to process

Returns:

the modified item or a new item.

Throws:

ItemProcessingException - if an error occurred while processing a template

equals

public boolean equals(Object o)

Returns true if the specified TemplateProcessor's and this instance's fields are equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns the hash code for this instance, which is basically the combination of the hash code of each field. As with any other ItemProcessor, this method is defined because any processor which is passed in the method call of a ContentStoreService can be used as part of a key for caching.

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object