org.nuxeo.ecm.platform.rendition.extension

Class AutomationRenderer

java.lang.Object

org.nuxeo.ecm.platform.rendition.extension.AutomationRenderer

public class AutomationRenderer
extends Object

Class introduced to share code between sync and lazy automation based renditions

Since:

7.2

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
AutomationRenderer()

Method Summary

Modifier and Type	Method and Description
static String	getFilenameWithExtension(String filename, String mimeType, String defaultExtension) Generate a revised filename whose extension is either based on the supplied mimeType if applicable or the supplied default extension.
static String	getVariant(DocumentModel doc, RenditionDefinition definition) Generates the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.
static boolean	isRenditionAvailable(DocumentModel doc, RenditionDefinition def) Test if the Rendition is available on the given DocumentModel
static List<Blob>	render(DocumentModel doc, RenditionDefinition definition, CoreSession session) Generate the rendition Blobs for a given RenditionDefinition.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

AutomationRenderer

public AutomationRenderer()

Method Detail

isRenditionAvailable

public static boolean isRenditionAvailable(DocumentModel doc,
                                           RenditionDefinition def)

Test if the Rendition is available on the given DocumentModel

Parameters:

doc - the target DocumentModel

def - the RenditionDefinition to use

Returns:

The test result

render

public static List<Blob> render(DocumentModel doc,
                                RenditionDefinition definition,
                                CoreSession session)

Generate the rendition Blobs for a given RenditionDefinition. Return is a List of Blob for bigger flexibility (typically HTML rendition with resources)

Parameters:

doc - the target DocumentModel

definition - the RenditionDefinition to use

session - the CoreSession to use

Returns:

The list of Blobs

getVariant

public static String getVariant(DocumentModel doc,
                                RenditionDefinition definition)

Generates the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.

Parameters:

doc - the target document

definition - the rendition definition to use

Returns:

the generated RENDITION_VARIANT_PROPERTY value, or null

Since:

8.1

getFilenameWithExtension

public static String getFilenameWithExtension(String filename,
                                              String mimeType,
                                              String defaultExtension)

Generate a revised filename whose extension is either based on the supplied mimeType if applicable or the supplied default extension.

Parameters:

filename - the filename to use

mimeType - the mimeType from which the assigned extension is derived

defaultExtension - the default extension to be assigned if the mimeType has no corresponding extension

Returns:

the filename with the revised extension

Since:

7.4