Package org.springframework.extensions.webscripts.processor

Class FTLTemplateProcessor

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessor

org.springframework.extensions.webscripts.processor.BaseRegisterableTemplateProcessor

org.springframework.extensions.webscripts.processor.AbstractTemplateProcessor

org.springframework.extensions.webscripts.processor.FTLTemplateProcessor

All Implemented Interfaces:

java.util.EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener, Processor, TemplateProcessor

public class FTLTemplateProcessor
extends AbstractTemplateProcessor

FTL Template Processor for Alfresco Web Framework

Author:

davidc, kevinr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FTLTemplateProcessor.NonBlockingObjectWrapper	Implements the FreeMarker ObjectWrapper cache as a ThreadLocal to avoid blocking when interogating or populating the bean cache.

Field Summary

Fields inherited from class org.springframework.extensions.webscripts.processor.BaseProcessor

processorExtensions

Constructor Summary

Constructors

Constructor	Description
FTLTemplateProcessor()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDefaultEncoding()	Gets the default encoding
java.lang.String	getExtension()	The file extension that the processor is associated with, null if none.
java.lang.String	getName()	Get the name of the processor
boolean	hasTemplate(java.lang.String templatePath)	Determines if a template exists
void	init()	Inits the processor
protected void	initConfig()	Initialise FreeMarker Configuration
protected boolean	isDebugMode()
void	process(java.lang.String template, java.lang.Object model, java.io.Writer out)	Process a template against the supplied data model and write to the out.
void	processString(java.lang.String template, java.lang.Object model, java.io.Writer out)	Process a string template against the supplied data model and write to the out.
void	reset()	Reset the Template Processor
void	setCacheSize(int cacheSize)
void	setConfigService(org.springframework.extensions.config.ConfigService configService)	Sets the config service.
void	setDefaultEncoding(java.lang.String defaultEncoding)
void	setUpdateDelay(int updateDelay)

Methods inherited from class org.springframework.extensions.webscripts.processor.AbstractTemplateProcessor

addProcessorModelExtensions, getSearchPath, getTemplateLoader, initLoaders, onApplicationEvent, register, setApplicationContext, setSearchPath

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseRegisterableTemplateProcessor

getTemplateProcessorRegistry, setTemplateProcessorRegistry

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessor

registerProcessorExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

FTLTemplateProcessor

public FTLTemplateProcessor()

Method Detail

setConfigService

public void setConfigService(org.springframework.extensions.config.ConfigService configService)

Sets the config service.

Parameters:

configService - The ConfigService

setDefaultEncoding

public void setDefaultEncoding(java.lang.String defaultEncoding)

Parameters:

defaultEncoding - String

getDefaultEncoding

public java.lang.String getDefaultEncoding()

Description copied from interface: TemplateProcessor

Gets the default encoding

Returns:

default encoding

setUpdateDelay

public void setUpdateDelay(int updateDelay)

Parameters:

updateDelay - the time in seconds between checks on the modified date for cached templates

setCacheSize

public void setCacheSize(int cacheSize)

Parameters:

cacheSize - the size of the MRU template cache, default is 256

init

public void init()

Description copied from class: BaseRegisterableTemplateProcessor

Inits the processor

Overrides:

init in class AbstractTemplateProcessor

getExtension

public java.lang.String getExtension()

Description copied from interface: Processor

The file extension that the processor is associated with, null if none.

Returns:

the extension

getName

public java.lang.String getName()

Description copied from interface: Processor

Get the name of the processor

Returns:

the name of the processor

process

public void process(java.lang.String template,
                    java.lang.Object model,
                    java.io.Writer out)

Description copied from interface: TemplateProcessor

Process a template against the supplied data model and write to the out.

Parameters:

template - Template name/path

model - Object model to process template against

out - Writer object to send output too

processString

public void processString(java.lang.String template,
                          java.lang.Object model,
                          java.io.Writer out)

Description copied from interface: TemplateProcessor

Process a string template against the supplied data model and write to the out.

Parameters:

template - Template string

model - Object model to process template against

out - Writer object to send output too

reset

public void reset()

Description copied from interface: TemplateProcessor

Reset the Template Processor

hasTemplate

public boolean hasTemplate(java.lang.String templatePath)

Description copied from interface: TemplateProcessor

Determines if a template exists

Parameters:

templatePath - String

Returns:

true => exists

initConfig

protected void initConfig()

Initialise FreeMarker Configuration

isDebugMode

protected boolean isDebugMode()