Package org.nuxeo.ecm.platform.rendition.adapter

Class RenderableDocument

java.lang.Object

org.nuxeo.ecm.platform.rendition.adapter.RenderableDocument

All Implemented Interfaces:

Renderable

public class RenderableDocument
extends Object
implements Renderable

Default implementation for Renderable interface.

This is a simple wrapper around the RenditionService in the context of a given DocumentModel

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field	Description
protected List<RenditionDefinition>	defs
protected final DocumentModel	doc

Constructor Summary

Constructors

Constructor	Description
RenderableDocument(DocumentModel doc)

Method Summary

Modifier and Type	Method	Description
List<RenditionDefinition>	getAvailableRenditionDefinitions()	Returns RenditionDefinition that are available on the underlying object
protected Rendition	getRendition(RenditionDefinition def)
Rendition	getRenditionByKind(String kind)	Retrieve the Rendition by it's king (first match rendition is returned)
Rendition	getRenditionByName(String name)	Retrieve the Rendition by it's name

Methods inherited from class java.lang.Object

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

Field Details

doc

protected final DocumentModel doc

defs

protected List<RenditionDefinition> defs

Constructor Details

RenderableDocument

public RenderableDocument(DocumentModel doc)

Method Details

getAvailableRenditionDefinitions

public List<RenditionDefinition> getAvailableRenditionDefinitions()

Description copied from interface: Renderable

Returns RenditionDefinition that are available on the underlying object

Specified by:

getAvailableRenditionDefinitions in interface Renderable

getRenditionByName

public Rendition getRenditionByName(String name)

Description copied from interface: Renderable

Retrieve the Rendition by it's name

Specified by:

getRenditionByName in interface Renderable

getRenditionByKind

public Rendition getRenditionByKind(String kind)

Description copied from interface: Renderable

Retrieve the Rendition by it's king (first match rendition is returned)

Specified by:

getRenditionByKind in interface Renderable

getRendition

protected Rendition getRendition(RenditionDefinition def)