Package org.alfresco.repo.rendition.executer

Class AbstractRenderingEngine.RenderingContext

java.lang.Object

org.alfresco.repo.rendition.executer.AbstractRenderingEngine.RenderingContext

All Implemented Interfaces:

SerializedTransformationOptionsAccessor

Enclosing class:

AbstractRenderingEngine

protected class AbstractRenderingEngine.RenderingContext
extends Object
implements SerializedTransformationOptionsAccessor

Constructor Summary

Constructors

Constructor	Description
RenderingContext(NodeRef sourceNode, RenditionDefinition definition, QName renditionContentProperty)

Method Summary

Modifier and Type	Method	Description
<T> T	getCheckedParam(String paramName, Class<T> clazz)	Gets the value for the named parameter.
ChildAssociationRef	getChildAssociationRef()	Lazily instantiation of the ChildAssociationRef
RenditionDefinition	getDefinition()
NodeRef	getDestinationNode()
int	getIntegerParam(String key, int defaultValue)	Gets the int value for the named parameter.
<T> T	getParamWithDefault(String paramName, T defaultValue)	Gets the value for the named parameter.
NodeRef	getSourceNode()
ContentReader	makeContentReader()
ContentWriter	makeContentWriter()

Methods inherited from class java.lang.Object

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

Constructor Details

RenderingContext

public RenderingContext(NodeRef sourceNode,
 RenditionDefinition definition,
 QName renditionContentProperty)

Parameters:

sourceNode - NodeRef

definition - RenditionDefinition

renditionContentProperty - QName

Method Details

getSourceNode

public NodeRef getSourceNode()

Returns:

the sourceNode

getChildAssociationRef

public ChildAssociationRef getChildAssociationRef()

Lazily instantiation of the ChildAssociationRef

Returns:

ChildAssociationRef

getDestinationNode

public NodeRef getDestinationNode()

Returns:

the destinationNode

getDefinition

public RenditionDefinition getDefinition()

Returns:

the definition

getCheckedParam

public <T> T getCheckedParam(String paramName,
 Class<T> clazz)

Description copied from interface: SerializedTransformationOptionsAccessor

Gets the value for the named parameter. Checks the type of the parameter is correct and throws and Exception if it isn't. Returns null if the parameter value is null

Specified by:

getCheckedParam in interface SerializedTransformationOptionsAccessor

Parameters:

paramName - the name of the parameter being checked.

clazz - the expected Class of the parameter value.

Returns:

the parameter value or null.

getParamWithDefault

public <T> T getParamWithDefault(String paramName,
 T defaultValue)

Description copied from interface: SerializedTransformationOptionsAccessor

Gets the value for the named parameter. Checks the type of the parameter is the same as the type of defaultValue and throws a RenditionServiceException if it isn't. Returns defaultValue if the parameter value is null

Specified by:

getParamWithDefault in interface SerializedTransformationOptionsAccessor

Parameters:

paramName - String

makeContentReader

public ContentReader makeContentReader()

makeContentWriter

public ContentWriter makeContentWriter()

getIntegerParam

public int getIntegerParam(String key,
 int defaultValue)

Description copied from interface: SerializedTransformationOptionsAccessor

Gets the int value for the named parameter. Returns defaultValue if the parameter value is null.

Specified by:

getIntegerParam in interface SerializedTransformationOptionsAccessor

Parameters:

key - String

defaultValue - int

Returns:

int