org.alfresco.repo.rendition.executer
Class FreemarkerRenderingEngine

java.lang.Object
  extended by org.alfresco.repo.action.CommonResourceAbstractBase
      extended by org.alfresco.repo.action.ParameterizedItemAbstractBase
          extended by org.alfresco.repo.action.executer.ActionExecuterAbstractBase
              extended by org.alfresco.repo.rendition.executer.AbstractRenderingEngine
                  extended by org.alfresco.repo.rendition.executer.BaseTemplateRenderingEngine
                      extended by org.alfresco.repo.rendition.executer.FreemarkerRenderingEngine
All Implemented Interfaces:
ActionExecuter, org.springframework.beans.factory.BeanNameAware

public class FreemarkerRenderingEngine
extends BaseTemplateRenderingEngine

Since:
3.3

Nested Class Summary
 
Nested classes/interfaces inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine
AbstractRenderingEngine.RenderingContext
 
Field Summary
static java.lang.String KEY_NODE
          The name of the source node as it appears in the model supplied to the freemarker template
static java.lang.String NAME
           
 
Fields inherited from class org.alfresco.repo.rendition.executer.BaseTemplateRenderingEngine
PARAM_MODEL, PARAM_TEMPLATE, PARAM_TEMPLATE_NODE, PARAM_TEMPLATE_PATH
 
Fields inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine
CONTENT_READER_NOT_FOUND_MESSAGE, contentService, mimetypeMap, nodeService, PARAM_ENCODING, PARAM_MIME_TYPE, PARAM_PLACEHOLDER_RESOURCE_PATH, PARAM_RUN_AS, PARAM_SOURCE_CONTENT_PROPERTY, PARAM_TARGET_CONTENT_PROPERTY, PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE
 
Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
actionDefinition, applicableTypes, publicAction
 
Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
DISPLAY_LABEL, runtimeActionService
 
Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
name
 
Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter
PARAM_RESULT
 
Constructor Summary
FreemarkerRenderingEngine()
           
 
Method Summary
protected  java.lang.Object buildModel(AbstractRenderingEngine.RenderingContext context)
          Create the model that will be passed to the template service for rendering with the appropriate template.
protected  java.util.Collection getParameterDefinitions()
          Supplies the list of parameters required by this rendering engine.
protected  java.lang.String getTemplateType()
          Get the type of template that is to be used.
 void setRepositoryHelper(Repository repository)
           
 void setServiceRegistry(ServiceRegistry serviceRegistry)
           
 
Methods inherited from class org.alfresco.repo.rendition.executer.BaseTemplateRenderingEngine
getParamDisplayLabel, getSearchService, getTemplateNode, getTemplateService, render, setSearchService, setTemplateService
 
Methods inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine
addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, getTargetMimeType, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setBehaviourFilter, setContentService, setDefaultRenditionContentProp, setDefaultRenditionNodeType, setMimetypeMap, setNodeService, setRenditionLocationResolver, setRenditionService, switchToFinalRenditionNode, tagSourceNodeAsRenditioned, throwWrappedException
 
Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase
execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, setApplicableTypes, setBaseNodeService, setIgnoreLock, setLockService, setPublicAction, setQueueName, setTrackStatus
 
Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase
checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getParameterDefintions, getTitleKey, setRuntimeActionService, toString
 
Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase
setBeanName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values

KEY_NODE

public static final java.lang.String KEY_NODE
The name of the source node as it appears in the model supplied to the freemarker template

See Also:
Constant Field Values
Constructor Detail

FreemarkerRenderingEngine

public FreemarkerRenderingEngine()
Method Detail

getParameterDefinitions

protected java.util.Collection getParameterDefinitions()
Description copied from class: AbstractRenderingEngine
Supplies the list of parameters required by this rendering engine.

Overrides:
getParameterDefinitions in class BaseTemplateRenderingEngine
Returns:

buildModel

protected java.lang.Object buildModel(AbstractRenderingEngine.RenderingContext context)
Description copied from class: BaseTemplateRenderingEngine
Create the model that will be passed to the template service for rendering with the appropriate template.

Specified by:
buildModel in class BaseTemplateRenderingEngine
Parameters:
context - The context of the rendering request
Returns:
The model that is to be passed to the template service

getTemplateType

protected java.lang.String getTemplateType()
Description copied from class: BaseTemplateRenderingEngine
Get the type of template that is to be used. This identifies the name of the template processor that should be used, such as "freemarker" or "xslt".

Specified by:
getTemplateType in class BaseTemplateRenderingEngine
Returns:

setRepositoryHelper

public void setRepositoryHelper(Repository repository)
Parameters:
repository - the repository to set

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)
Parameters:
serviceRegistry - the serviceRegistry to set


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.