org.alfresco.repo.rendition.executer

Class ReformatRenderingEngine

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.rendition.executer.AbstractRenderingEngine

org.alfresco.repo.rendition.executer.AbstractTransformationRenderingEngine

org.alfresco.repo.rendition.executer.ReformatRenderingEngine

All Implemented Interfaces:

ActionExecuter, LoggingAwareExecuter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ReformatRenderingEngine
extends AbstractTransformationRenderingEngine

This class is the implementation of the RenditionService's "reformat" action/rendering. This action renders a piece of content in the specified target MIME type. This is achieved using one of the standard transformers within the ContentService.

Reformatting in this way is a simple conversion of one MIME type to another MIME type, without any other changes to the content. Therefore there is no support within this action for altering the content e.g. image cropping/resizing.

Since:

3.3

Author:

Neil McErlean

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.repo.rendition.executer.AbstractTransformationRenderingEngine

AbstractTransformationRenderingEngine.TransformationCallable

Nested classes/interfaces inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

AbstractRenderingEngine.RenderingContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	PARAM_FLASH_VERSION This optional String parameter is only necessary when converting from pdf to Flash and is used to specify which Flash version to convert to.

Fields inherited from class org.alfresco.repo.rendition.executer.AbstractTransformationRenderingEngine

CANCELLED_ACTION_POLLING_INTERVAL, PARAM_MAX_PAGES, PARAM_MAX_SOURCE_SIZE_K_BYTES, PARAM_PAGE_LIMIT, PARAM_READ_LIMIT_K_BYTES, PARAM_READ_LIMIT_TIME_MS, PARAM_TIMEOUT_MS, PARAM_USE

Fields inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

actionTrackingService, CONTENT_READER_NOT_FOUND_MESSAGE, contentService, DEFAULT_RUN_AS_NAME, 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

adhocPropertiesAllowed, 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

Constructors

Constructor and Description
ReformatRenderingEngine()

Method Summary

Modifier and Type	Method and Description
protected Collection<ParameterDefinition>	getParameterDefinitions() Supplies the list of parameters required by this rendering engine.
protected String	getTargetMimeType(AbstractRenderingEngine.RenderingContext context)
protected TransformationOptions	getTransformOptions(AbstractRenderingEngine.RenderingContext context)
protected TransformationOptions	getTransformOptionsImpl(TransformationOptions options, AbstractRenderingEngine.RenderingContext context)

Methods inherited from class org.alfresco.repo.rendition.executer.AbstractTransformationRenderingEngine

getExecutorService, getSourceOptionsSerializers, init, render, setSourceOptionsSerializers

Methods inherited from class org.alfresco.repo.rendition.executer.AbstractRenderingEngine

addParameterDefinitions, checkActionIsRenditionDefinition, checkParameterValues, checkSourceNodeExists, createActionDefinition, executeImpl, executeImpl, executeRenditionImpl, getCheckedParam, getDefaultRenditionContentProp, getDefaultRenditionNodeType, getExecutionSummary, getParamDisplayLabel, getParamWithDefault, getRenditionContentProperty, getTargetEncoding, notifyCallbackOfException, notifyCallbackOfResult, resolveRenditionLocation, setActionTrackingService, 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, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus

Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, 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

PARAM_FLASH_VERSION

public static final String PARAM_FLASH_VERSION

This optional String parameter is only necessary when converting from pdf to Flash and is used to specify which Flash version to convert to.

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

ReformatRenderingEngine

public ReformatRenderingEngine()

Method Detail

getTargetMimeType

protected String getTargetMimeType(AbstractRenderingEngine.RenderingContext context)

Overrides:

getTargetMimeType in class AbstractRenderingEngine

getTransformOptions

protected TransformationOptions getTransformOptions(AbstractRenderingEngine.RenderingContext context)

Specified by:

getTransformOptions in class AbstractTransformationRenderingEngine

getTransformOptionsImpl

protected TransformationOptions getTransformOptionsImpl(TransformationOptions options,
                                                        AbstractRenderingEngine.RenderingContext context)

Overrides:

getTransformOptionsImpl in class AbstractTransformationRenderingEngine

getParameterDefinitions

protected Collection<ParameterDefinition> getParameterDefinitions()

Description copied from class: AbstractRenderingEngine

Supplies the list of parameters required by this rendering engine.

Overrides:

getParameterDefinitions in class AbstractTransformationRenderingEngine