org.nuxeo.template.adapters.doc

Class TemplateBasedDocumentAdapterImpl

java.lang.Object

org.nuxeo.template.adapters.AbstractTemplateDocument

org.nuxeo.template.adapters.doc.TemplateBasedDocumentAdapterImpl

All Implemented Interfaces:

Serializable, TemplateBasedDocument

public class TemplateBasedDocumentAdapterImpl
extends AbstractTemplateDocument
implements Serializable, TemplateBasedDocument

Default implementation of TemplateBasedDocument adapter. This adapter mainly expect from the underlying DocumentModel to have the "TemplateBased" facet

Author:

Tiry (tdelprat@nuxeo.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATEBASED_FACET

Constructor Summary

Constructors

Constructor and Description
TemplateBasedDocumentAdapterImpl(DocumentModel doc)

Method Summary

Methods

Modifier and Type	Method and Description
List<TemplateInput>	getParams(String templateName) Retrieve parameters for the associated template
TemplateSourceDocument	getSourceTemplate(String templateName) Retrieve the TemplateSourceDocument for a given template name
DocumentModel	getSourceTemplateDoc(String templateName) Retrieve the Template DocumentModel for a given template name
DocumentRef	getSourceTemplateDocRef(String templateName) Retrieve the Template DocumentRef for a given template name
List<TemplateSourceDocument>	getSourceTemplates() List all TemplateSourceDocuments that are bound to the underlying DocumentModel
Blob	getTemplateBlob(String templateName) Return the Blob of the associated template
String	getTemplateNameForRendition(String renditionName) Find the template associated to a given RenditionName
List<String>	getTemplateNames() Get the names of all the associated templates
String	getTemplateType(String templateName) Return the template type for a given template name
boolean	hasEditableParams(String templateName) Indicate of the associated Template has editable parameters or not
boolean	hasParams(String templateName) Indicate of the associated Template requires parameters or not
DocumentModel	initializeFromTemplate(boolean save)
DocumentModel	initializeFromTemplate(String templateName, boolean save) Initialize the template parameters from the associated template
boolean	isBidirectional()
DocumentModel	removeTemplateBinding(String templateName, boolean save) Detach a template from the underlying DocumentModel
Blob	renderAndStoreAsAttachment(String templateName, boolean save) Render the named template against the underlying DocumentModel and store the result in the main Blob
Blob	renderWithTemplate(String templateName) Render the named template against the underlying DocumentModel
DocumentModel	saveParams(String templateName, List<TemplateInput> params, boolean save) Save parameters changes.
DocumentModel	setTemplate(DocumentModel template, boolean save) Associate the document to a Template.

Methods inherited from class org.nuxeo.template.adapters.AbstractTemplateDocument

getAdaptedDoc, save

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.template.api.adapters.TemplateBasedDocument

getAdaptedDoc

Field Detail

TEMPLATEBASED_FACET

public static final String TEMPLATEBASED_FACET

See Also:

Constant Field Values

Constructor Detail

TemplateBasedDocumentAdapterImpl

public TemplateBasedDocumentAdapterImpl(DocumentModel doc)
                                 throws ClientException

Throws:

ClientException

Method Detail

setTemplate

public DocumentModel setTemplate(DocumentModel template,
                        boolean save)
                          throws ClientException

Description copied from interface: TemplateBasedDocument

Associate the document to a Template.

Specified by:

setTemplate in interface TemplateBasedDocument

Parameters:

template - DocumentModel holding the template

save - flag to indicate if target DocumentModel must be saved or not

Returns:

the updated DocumentModel

Throws:

PropertyException

ClientException

removeTemplateBinding

public DocumentModel removeTemplateBinding(String templateName,
                                  boolean save)
                                    throws ClientException

Description copied from interface: TemplateBasedDocument

Detach a template from the underlying DocumentModel

Specified by:

removeTemplateBinding in interface TemplateBasedDocument

Returns:

Throws:

ClientException

getSourceTemplate

public TemplateSourceDocument getSourceTemplate(String templateName)
                                         throws Exception

Description copied from interface: TemplateBasedDocument

Retrieve the TemplateSourceDocument for a given template name

Specified by:

getSourceTemplate in interface TemplateBasedDocument

Parameters:

templateName - name of the template

Returns:

the TemplateSourceDocument

Throws:

Exception

getSourceTemplateDocRef

public DocumentRef getSourceTemplateDocRef(String templateName)
                                    throws Exception

Description copied from interface: TemplateBasedDocument

Retrieve the Template DocumentRef for a given template name

Specified by:

getSourceTemplateDocRef in interface TemplateBasedDocument

Parameters:

templateName - name of the template

Returns:

the associated template DocumentRef

Throws:

Exception

getSourceTemplateDoc

public DocumentModel getSourceTemplateDoc(String templateName)
                                   throws Exception

Description copied from interface: TemplateBasedDocument

Retrieve the Template DocumentModel for a given template name

Specified by:

getSourceTemplateDoc in interface TemplateBasedDocument

Parameters:

templateName - name of the template

Returns:

the associated template DocumentModel

Throws:

Exception

getSourceTemplates

public List<TemplateSourceDocument> getSourceTemplates()

Description copied from interface: TemplateBasedDocument

List all TemplateSourceDocuments that are bound to the underlying DocumentModel

Specified by:

getSourceTemplates in interface TemplateBasedDocument

Returns:

getTemplateType

public String getTemplateType(String templateName)

Description copied from interface: TemplateBasedDocument

Return the template type for a given template name

Specified by:

getTemplateType in interface TemplateBasedDocument

Returns:

initializeFromTemplate

public DocumentModel initializeFromTemplate(boolean save)
                                     throws Exception

Throws:

Exception

initializeFromTemplate

public DocumentModel initializeFromTemplate(String templateName,
                                   boolean save)
                                     throws Exception

Description copied from interface: TemplateBasedDocument

Initialize the template parameters from the associated template

Specified by:

initializeFromTemplate in interface TemplateBasedDocument

save - flag to indicate if target DocumentModel must be saved or not

Returns:

the updated DocumentModel

Throws:

Exception

renderWithTemplate

public Blob renderWithTemplate(String templateName)
                        throws Exception

Description copied from interface: TemplateBasedDocument

Render the named template against the underlying DocumentModel

Specified by:

renderWithTemplate in interface TemplateBasedDocument

Returns:

the resulting Blob

Throws:

Exception

renderAndStoreAsAttachment

public Blob renderAndStoreAsAttachment(String templateName,
                              boolean save)
                                throws Exception

Description copied from interface: TemplateBasedDocument

Render the named template against the underlying DocumentModel and store the result in the main Blob

Specified by:

renderAndStoreAsAttachment in interface TemplateBasedDocument

save - flag to indicate if target DocumentModel must be saved or not

Returns:

the resulting Blob

Throws:

Exception

isBidirectional

public boolean isBidirectional()

getTemplateBlob

public Blob getTemplateBlob(String templateName)
                     throws Exception

Description copied from interface: TemplateBasedDocument

Return the Blob of the associated template

Specified by:

getTemplateBlob in interface TemplateBasedDocument

Returns:

Throws:

Exception

hasParams

public boolean hasParams(String templateName)
                  throws ClientException

Description copied from interface: TemplateBasedDocument

Indicate of the associated Template requires parameters or not

Specified by:

hasParams in interface TemplateBasedDocument

Returns:

Throws:

ClientException

getParams

public List<TemplateInput> getParams(String templateName)
                              throws ClientException

Description copied from interface: TemplateBasedDocument

Retrieve parameters for the associated template

Specified by:

getParams in interface TemplateBasedDocument

Returns:

Throws:

ClientException

saveParams

public DocumentModel saveParams(String templateName,
                       List<TemplateInput> params,
                       boolean save)
                         throws Exception

Description copied from interface: TemplateBasedDocument

Save parameters changes.

Specified by:

saveParams in interface TemplateBasedDocument

params - the updated list of parameters

save - flag to indicate if target DocumentModel must be saved or not

Returns:

Throws:

Exception

hasEditableParams

public boolean hasEditableParams(String templateName)
                          throws ClientException

Description copied from interface: TemplateBasedDocument

Indicate of the associated Template has editable parameters or not

Specified by:

hasEditableParams in interface TemplateBasedDocument

Returns:

Throws:

ClientException

getTemplateNameForRendition

public String getTemplateNameForRendition(String renditionName)

Description copied from interface: TemplateBasedDocument

Find the template associated to a given RenditionName

Specified by:

getTemplateNameForRendition in interface TemplateBasedDocument

Returns:

the template name if any, null otherwise

getTemplateNames

public List<String> getTemplateNames()

Description copied from interface: TemplateBasedDocument

Get the names of all the associated templates

Specified by:

getTemplateNames in interface TemplateBasedDocument

Returns: