org.springframework.extensions.surf.render

Class AbstractProcessor

java.lang.Object

org.springframework.extensions.surf.render.AbstractProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

EmptyRegionRenderer, JSPProcessor, WebScriptProcessor, WebTemplateProcessor

public abstract class AbstractProcessor
extends Object
implements Processor

Base implementation of a Processor.

Author:

Kevin Roast

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessorModelHelper	processorModelHelper A ProcessorModelHelper is required to populate the model.

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(ProcessorContext processorContext, ModelObject object, RenderFocus focus) Executes the given focus of the processor output using the given processor context
abstract void	executeBody(ProcessorContext processorContext, ModelObject object) Executes the "body" of the processor output using the given processor context.
void	executeHeader(ProcessorContext processorContext, ModelObject object) Executes the "header" of the processor output using the given processor context.
protected String	getProperty(ProcessorContext processorContext, String propertyName) Returns a configuration property from the rendering processor descriptor.
protected ProcessorContext.ProcessorDescriptor	getRenderingDescriptor(ProcessorContext processorContext) Helper method which returns the appropriate processor descriptor from the given processor descriptor for the current render mode.
void	setProcessorModelHelper(ProcessorModelHelper processorModelHelper)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.extensions.surf.render.Processor

exists

Field Detail

processorModelHelper

protected ProcessorModelHelper processorModelHelper

A ProcessorModelHelper is required to populate the model. It is supplied by the Spring Framework providing that this bean is correctly configured.

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

setProcessorModelHelper

public void setProcessorModelHelper(ProcessorModelHelper processorModelHelper)

execute

public void execute(ProcessorContext processorContext,
           ModelObject object,
           RenderFocus focus)
             throws RendererExecutionException

Description copied from interface: Processor

Executes the given focus of the processor output using the given processor context

Specified by:

execute in interface Processor

Parameters:

processorContext - ProcessorContext

object - ModelObject

focus - RenderFocus

Throws:

RendererExecutionException

executeHeader

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

Description copied from interface: Processor

Executes the "header" of the processor output using the given processor context.

Specified by:

executeHeader in interface Processor

Parameters:

processorContext - processorContext

Throws:

RendererExecutionException

executeBody

public abstract void executeBody(ProcessorContext processorContext,
               ModelObject object)
                          throws RendererExecutionException

Description copied from interface: Processor

Executes the "body" of the processor output using the given processor context.

Specified by:

executeBody in interface Processor

Parameters:

processorContext - processorContext

Throws:

RendererExecutionException

getRenderingDescriptor

protected ProcessorContext.ProcessorDescriptor getRenderingDescriptor(ProcessorContext processorContext)

Helper method which returns the appropriate processor descriptor from the given processor descriptor for the current render mode.

For example, if the current render mode is "view", then this will return the processor descriptor for the processor to be used during "view" processing. This descriptor contains all of the relevant metadata for the processor about how to proceed.

If the render mode is not "view" and a ProcessDescriptor cannot be found then the ProcessDescriptor for the "view" render mode will be returned (if available)

Parameters:

processorContext - ProcessorContext

Returns:

processor descriptor

getProperty

protected String getProperty(ProcessorContext processorContext,
                 String propertyName)

Returns a configuration property from the rendering processor descriptor.

Parameters:

processorContext - ProcessorContext

propertyName - String

Returns:

property value as string