Package org.nuxeo.ecm.platform.rendition.extension

Interface RenditionProvider

All Known Implementing Classes:

AbstractLazyCachableRenditionProvider, AutomationLazyRenditionProvider, DefaultAutomationRenditionProvider, HtmlRenditionProvider, PictureRenditionProvider, RenderViewRenditionProvider, TemplateBasedRenditionProvider, ThumbnailRenditionProvider, TransmissionThreeDRenditionProvider, VideoRenditionProvider

public interface RenditionProvider

Interface to hide providers of Rendition. A provider could be converter based, template based, or Automation based

Since:

5.6

Author:

Tiry

Method Summary

Modifier and Type	Method	Description
default String	getVariant(DocumentModel doc, RenditionDefinition definition)	Gets the optional RENDITION_VARIANT_PROPERTY value for a given RenditionDefinition.
boolean	isAvailable(DocumentModel doc, RenditionDefinition definition)	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.

Method Detail

isAvailable

boolean isAvailable(DocumentModel doc,
                    RenditionDefinition definition)

Test if the Rendition is available on the given DocumentModel

render

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

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

Returns:

The list of Blobs

getVariant

default String getVariant(DocumentModel doc,
                          RenditionDefinition definition)

Gets 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