org.springframework.extensions.webscripts

Class WebTemplateProcessor

java.lang.Object

org.springframework.extensions.surf.render.AbstractProcessor

org.springframework.extensions.webscripts.WebTemplateProcessor

All Implemented Interfaces:

Processor

public class WebTemplateProcessor
extends AbstractProcessor

Implementation of a renderer that executes a web template.

A web template may be a Freemarker template (out-of-the-box) but may also be an alternative template format. This may include the PHP template processor that is provided as a Webscripts Addon.

Author:

muzquiano, kevinr, David Draper

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX_CLASSPATH

Fields inherited from class org.springframework.extensions.surf.render.AbstractProcessor

processorModelHelper

Constructor Summary

Constructors

Constructor and Description
WebTemplateProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	executeBody(ProcessorContext pc, ModelObject object) Execute template Body.
void	executeHeader(ProcessorContext pc, ModelObject object) Execute Template header
void	executeScriptBodyExtensions(RequestContext context, String scriptPath, Map<String,Object> scriptModel, Map<String,Object> resultModel, ModelObject object) Executes controller scripts that have been provided to extend the template being rendered.
boolean	exists(ProcessorContext pc, ModelObject object) Indicates whether the engine responsible for processing the body of the processor exists.
org.springframework.extensions.webscripts.ScriptProcessorRegistry	getScriptProcessorRegistry() Gets the script processor registry.
org.springframework.extensions.webscripts.TemplateProcessorRegistry	getTemplateProcessorRegistry() Gets the template processor registry.
protected String	loadTemplateStringFromPath(String templatePath)
void	setScriptObjects(Map<String,Object> scriptObjects) Set any additional objects to be applied to the script model when executing any JavaScript attached to the template.
void	setScriptProcessorRegistry(org.springframework.extensions.webscripts.ScriptProcessorRegistry scriptProcessorRegistry) Sets the script processor registry.
void	setTemplateProcessorRegistry(org.springframework.extensions.webscripts.TemplateProcessorRegistry templateProcessorRegistry) Sets the template processor registry.
void	setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement) This accessor method is required for Spring to set the WebFrameworkConfigElement required by this WebTemplateProcessor.

Methods inherited from class org.springframework.extensions.surf.render.AbstractProcessor

execute, getProperty, getRenderingDescriptor, setProcessorModelHelper

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_CLASSPATH

public static final String PREFIX_CLASSPATH

See Also:

Constant Field Values

Constructor Detail

WebTemplateProcessor

public WebTemplateProcessor()

Method Detail

setWebFrameworkConfigElement

public void setWebFrameworkConfigElement(WebFrameworkConfigElement webFrameworkConfigElement)

This accessor method is required for Spring to set the WebFrameworkConfigElement required by this WebTemplateProcessor.

Parameters:

webFrameworkConfigElement - WebFrameworkConfigElement

setTemplateProcessorRegistry

public void setTemplateProcessorRegistry(org.springframework.extensions.webscripts.TemplateProcessorRegistry templateProcessorRegistry)

Sets the template processor registry.

Parameters:

templateProcessorRegistry - the new template processor registry

getTemplateProcessorRegistry

public org.springframework.extensions.webscripts.TemplateProcessorRegistry getTemplateProcessorRegistry()

Gets the template processor registry.

Returns:

the template processor registry

setScriptProcessorRegistry

public void setScriptProcessorRegistry(org.springframework.extensions.webscripts.ScriptProcessorRegistry scriptProcessorRegistry)

Sets the script processor registry.

Parameters:

scriptProcessorRegistry - the new script processor registry

getScriptProcessorRegistry

public org.springframework.extensions.webscripts.ScriptProcessorRegistry getScriptProcessorRegistry()

Gets the script processor registry.

Returns:

the script processor registry

setScriptObjects

public void setScriptObjects(Map<String,Object> scriptObjects)

Set any additional objects to be applied to the script model when executing any JavaScript attached to the template.

Parameters:

scriptObjects - Map

executeHeader

public void executeHeader(ProcessorContext pc,
                 ModelObject object)
                   throws RendererExecutionException

Execute Template header

Specified by:

executeHeader in interface Processor

Overrides:

executeHeader in class AbstractProcessor

Parameters:

pc - the processor context

Throws:

RendererExecutionException - the renderer execution exception

executeScriptBodyExtensions

public void executeScriptBodyExtensions(RequestContext context,
                               String scriptPath,
                               Map<String,Object> scriptModel,
                               Map<String,Object> resultModel,
                               ModelObject object)

Executes controller scripts that have been provided to extend the template being rendered.

Parameters:

context - The current RequestContext.

scriptPath - The path of the script being executed. This script does not need to exist for extensions to be processed.

scriptModel - The current model for the script to use. If this argument is null then a new model will be built.

resultModel - The result model of executing the script.

object - The ModelObject being rendered, this will almost certainly be a TemplateInstance. This is only required if the scriptModel argument is null

executeBody

public void executeBody(ProcessorContext pc,
               ModelObject object)
                 throws RendererExecutionException

Execute template Body.

Specified by:

executeBody in interface Processor

Specified by:

executeBody in class AbstractProcessor

Parameters:

pc - the processor context

Throws:

RendererExecutionException - the renderer execution exception

exists

public boolean exists(ProcessorContext pc,
             ModelObject object)

Description copied from interface: Processor

Indicates whether the engine responsible for processing the body of the processor exists.

Parameters:

pc - ProcessorContext

object - ModelObject

Returns:

boolean

loadTemplateStringFromPath

protected String loadTemplateStringFromPath(String templatePath)
                                     throws IOException

Throws:

IOException