org.nuxeo.ecm.platform.rendition.extension

Class DefaultAutomationRenditionProvider

java.lang.Object

org.nuxeo.ecm.platform.rendition.extension.DefaultAutomationRenditionProvider

All Implemented Interfaces:

RenditionProvider

public class DefaultAutomationRenditionProvider
extends Object
implements RenditionProvider

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DefaultAutomationRenditionProvider()

Method Summary

Modifier and Type	Method and Description
String	getVariant(DocumentModel doc, RenditionDefinition definition) Gets the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.
boolean	isAvailable(DocumentModel doc, RenditionDefinition def) Test if the Rendition is available on the given DocumentModel
List<Blob>	render(DocumentModel doc, RenditionDefinition definition) 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

DefaultAutomationRenditionProvider

public DefaultAutomationRenditionProvider()

Method Detail

isAvailable

public boolean isAvailable(DocumentModel doc,
                           RenditionDefinition def)

Description copied from interface: RenditionProvider

Test if the Rendition is available on the given DocumentModel

Specified by:

isAvailable in interface RenditionProvider

render

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

Description copied from interface: RenditionProvider

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

Specified by:

render in interface RenditionProvider

Parameters:

doc - the target DocumentModel

definition - the RenditionDefinition to use

Returns:

The list of Blobs

getVariant

public String getVariant(DocumentModel doc,
                         RenditionDefinition definition)

Description copied from interface: RenditionProvider

Gets the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.

Specified by:

getVariant in interface RenditionProvider

Parameters:

doc - the target document

definition - the rendition definition to use

Returns:

the generated RENDITION_VARIANT_PROPERTY value, or null