java.lang.Object
- org.nuxeo.template.adapters.AbstractTemplateDocument
- - org.nuxeo.template.adapters.source.TemplateSourceDocumentAdapterImpl

All Implemented Interfaces:

Serializable, TemplateSourceDocument
```
public class TemplateSourceDocumentAdapterImpl
extends AbstractTemplateDocument
implements Serializable, TemplateSourceDocument
```
Default implementation of TemplateSourceDocument. It mainly expect from the underlying DocumentModel to have the "Template" facet.

Author:

Tiry ([email protected])

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`TEMPLATE_APPLICABLE_TYPES_ALL`
`static String`	`TEMPLATE_APPLICABLE_TYPES_PROP`
`static String`	`TEMPLATE_DATA_PROP`
`static String`	`TEMPLATE_FACET`
`static String`	`TEMPLATE_FORCED_TYPES_ITEM_PROP`
`static String`	`TEMPLATE_FORCED_TYPES_NONE`
`static String`	`TEMPLATE_FORCED_TYPES_PROP`
`static String`	`TEMPLATE_NAME_PROP`
`static String`	`TEMPLATE_OUTPUT_PROP`
`static String`	`TEMPLATE_OVERRIDE_PROP`
`static String`	`TEMPLATE_RENDITION_NONE`
`static String`	`TEMPLATE_RENDITION_PROP`
`static String`	`TEMPLATE_TYPE_AUTO`
`static String`	`TEMPLATE_TYPE_PROP`
`static String`	`TEMPLATE_USEASMAIN_PROP`

Fields inherited from class org.nuxeo.template.adapters.AbstractTemplateDocument
adaptedDoc, log

Fields inherited from interface org.nuxeo.template.api.adapters.TemplateSourceDocument
INIT_DONE_FLAG

Constructor Summary

Constructors
Constructor Description

TemplateSourceDocumentAdapterImpl(DocumentModel doc)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<TemplateInput>`	`addInput(TemplateInput input)`	Add or update a `TemplateInput` to the list of template parameters.
`boolean`	`allowInstanceOverride()`	Return flag to indicate if Documents associated to this template can override parametes value
`protected String`	`computeTemplateName()`
`List<String>`	`getApplicableTypes()`	Get List of Document Types than can be associated to this Template.
`String`	`getFileName()`	Shortcut to access the underlying `Blob` filename
`List<String>`	`getForcedTypes()`	Get List of Document Types that must be automatically bound to this template at creation time
`String`	`getId()`	Shortcut to access the underlying `DocumentModel` uuid
`String`	`getLabel()`	Return label key used for template
`String`	`getName()`	Shortcut to access the underlying `DocumentModel` name
`String`	`getOutputFormat()`	Return the expected mime-type of the resulting rendering
`List<TemplateInput>`	`getParams()`	Retrieve the parameters associated to the Template file
`String`	`getParamsAsString()`	Return the String representation of the parameters of the template
`String`	`getTargetRenditionName()`	Get the associated Rendition if any
`List<TemplateBasedDocument>`	`getTemplateBasedDocuments()`	Get the list of `TemplateBasedDocument`s associated to this template
`Blob`	`getTemplateBlob()`	Retrieve the Blob holding the template file
`protected String`	`getTemplateParamsXPath()`
`protected TemplateProcessor`	`getTemplateProcessor()`
`String`	`getTemplateType()`	Return the template Type (i.e.
`String`	`getTitle()`	Shortcut to access the underlying `DocumentModel` title
`String`	`getVersionLabel()`	Shortcut to access the underlying `DocumentModel` versionLabel
`boolean`	`hasEditableParams()`	Indicate of the associated Template has editable parameters or not
`boolean`	`hasInput(String inputName)`	Returns whether or not the `TemplateInput` already exists, based on the name, in the template.
`void`	`initTemplate(boolean save)`	Initialize the DocumentModel finds associated TemplateProcessor extract Template parameters
`void`	`initTypesBindings()`	Initialize the Types2Template binding
`void`	`removeForcedType(String type, boolean save)`	Remove Type mapping for this template
`DocumentModel`	`saveParams(List<TemplateInput> params, boolean save)`	Save parameters changes
`void`	`setForcedTypes(String[] forcedTypes, boolean save)`	Update the Type mapping for this template
`void`	`setOutputFormat(String mimetype, boolean save)`	Sets the expected output mime-type.
`void`	`setTargetRenditioName(String renditionName, boolean save)`	Associate Template to a Rendition
`void`	`setTemplateBlob(Blob blob, boolean save)`	Write accessor to the `Blob` used to store the template
`boolean`	`useAsMainContent()`	Indicate if the template can be used as main blob in the `TemplateBasedDocument` (i.e.

Methods inherited from class org.nuxeo.template.adapters.AbstractTemplateDocument
doSave, getAdaptedDoc, getSession, save

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.template.api.adapters.TemplateSourceDocument
getAdaptedDoc, save

- Field Detail
  - TEMPLATE_DATA_PROP
```
public static final String TEMPLATE_DATA_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_NAME_PROP
```
public static final String TEMPLATE_NAME_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_PROP
```
public static final String TEMPLATE_TYPE_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_TYPE_AUTO
```
public static final String TEMPLATE_TYPE_AUTO
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_APPLICABLE_TYPES_PROP
```
public static final String TEMPLATE_APPLICABLE_TYPES_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_APPLICABLE_TYPES_ALL
```
public static final String TEMPLATE_APPLICABLE_TYPES_ALL
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_FORCED_TYPES_PROP
```
public static final String TEMPLATE_FORCED_TYPES_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_FORCED_TYPES_ITEM_PROP
```
public static final String TEMPLATE_FORCED_TYPES_ITEM_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_FORCED_TYPES_NONE
```
public static final String TEMPLATE_FORCED_TYPES_NONE
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_RENDITION_NONE
```
public static final String TEMPLATE_RENDITION_NONE
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_OUTPUT_PROP
```
public static final String TEMPLATE_OUTPUT_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_OVERRIDE_PROP
```
public static final String TEMPLATE_OVERRIDE_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_USEASMAIN_PROP
```
public static final String TEMPLATE_USEASMAIN_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_RENDITION_PROP
```
public static final String TEMPLATE_RENDITION_PROP
```
    See Also:
    
    Constant Field Values
  - TEMPLATE_FACET
```
public static final String TEMPLATE_FACET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TemplateSourceDocumentAdapterImpl
```
public TemplateSourceDocumentAdapterImpl(DocumentModel doc)
```
- Method Detail
  - getTemplateParamsXPath
```
protected String getTemplateParamsXPath()
```
  - getParams
```
public List<TemplateInput> getParams()
```
    Description copied from interface: TemplateSourceDocument
    
    Retrieve the parameters associated to the Template file
    
    Specified by:
    
    getParams in interface TemplateSourceDocument
  - hasEditableParams
```
public boolean hasEditableParams()
```
    Description copied from interface: TemplateSourceDocument
    
    Indicate of the associated Template has editable parameters or not
    
    Specified by:
    
    hasEditableParams in interface TemplateSourceDocument
  - saveParams
```
public DocumentModel saveParams(List<TemplateInput> params,
                                boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Save parameters changes
    
    Specified by:
    
    saveParams in interface TemplateSourceDocument
    
    Parameters:
    
    params - the updated list of parameters
    
    save - flag to indicate if target DocumentModel must be saved or not
    
    Returns:
    
    the updated DocumentModel
  - getTemplateProcessor
```
protected TemplateProcessor getTemplateProcessor()
```
  - getParamsAsString
```
public String getParamsAsString()
                         throws PropertyException
```
    Description copied from interface: TemplateSourceDocument
    
    Return the String representation of the parameters of the template
    
    Specified by:
    
    getParamsAsString in interface TemplateSourceDocument
    
    Throws:
    
    PropertyException
  - addInput
```
public List<TemplateInput> addInput(TemplateInput input)
```
    Description copied from interface: TemplateSourceDocument
    
    Add or update a TemplateInput to the list of template parameters.
    
    Specified by:
    
    addInput in interface TemplateSourceDocument
  - hasInput
```
public boolean hasInput(String inputName)
```
    Description copied from interface: TemplateSourceDocument
    
    Returns whether or not the TemplateInput already exists, based on the name, in the template.
    
    Specified by:
    
    hasInput in interface TemplateSourceDocument
  - getTemplateType
```
public String getTemplateType()
```
    Description copied from interface: TemplateSourceDocument
    
    Return the template Type (i.e. the associated TemplateProcessor name.
    
    Specified by:
    
    getTemplateType in interface TemplateSourceDocument
    
    Returns:
    
    TemplateProcessor name if any, null otherwise
  - initTemplate
```
public void initTemplate(boolean save)
```
    Description copied from interface: TemplateSourceDocument
    Initialize the DocumentModel
    
    finds associated TemplateProcessor
    
    extract Template parameters
    Specified by:
    
    initTemplate in interface TemplateSourceDocument
    
    Parameters:
    
    save - flag to indicate if target DocumentModel must be saved or not
  - computeTemplateName
```
protected String computeTemplateName()
```
  - allowInstanceOverride
```
public boolean allowInstanceOverride()
```
    Description copied from interface: TemplateSourceDocument
    
    Return flag to indicate if Documents associated to this template can override parametes value
    
    Specified by:
    
    allowInstanceOverride in interface TemplateSourceDocument
  - initTypesBindings
```
public void initTypesBindings()
```
    Description copied from interface: TemplateSourceDocument
    
    Initialize the Types2Template binding
    
    Specified by:
    
    initTypesBindings in interface TemplateSourceDocument
  - getApplicableTypes
```
public List<String> getApplicableTypes()
```
    Description copied from interface: TemplateSourceDocument
    
    Get List of Document Types than can be associated to this Template.
    
    Specified by:
    
    getApplicableTypes in interface TemplateSourceDocument
    
    Returns:
    
    List of Document Types or an empty List
  - getForcedTypes
```
public List<String> getForcedTypes()
```
    Description copied from interface: TemplateSourceDocument
    
    Get List of Document Types that must be automatically bound to this template at creation time
    
    Specified by:
    
    getForcedTypes in interface TemplateSourceDocument
    
    Returns:
    
    List of Document Types or an empty List
  - removeForcedType
```
public void removeForcedType(String type,
                             boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Remove Type mapping for this template
    
    Specified by:
    
    removeForcedType in interface TemplateSourceDocument
  - setForcedTypes
```
public void setForcedTypes(String[] forcedTypes,
                           boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Update the Type mapping for this template
    
    Specified by:
    
    setForcedTypes in interface TemplateSourceDocument
  - getTemplateBasedDocuments
```
public List<TemplateBasedDocument> getTemplateBasedDocuments()
```
    Description copied from interface: TemplateSourceDocument
    
    Get the list of TemplateBasedDocuments associated to this template
    
    Specified by:
    
    getTemplateBasedDocuments in interface TemplateSourceDocument
  - getOutputFormat
```
public String getOutputFormat()
```
    Description copied from interface: TemplateSourceDocument
    
    Return the expected mime-type of the resulting rendering
    
    Specified by:
    
    getOutputFormat in interface TemplateSourceDocument
  - setOutputFormat
```
public void setOutputFormat(String mimetype,
                            boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Sets the expected output mime-type. If the expected mime-type is different from the output of the rendering, converters will be applied.
    
    Specified by:
    
    setOutputFormat in interface TemplateSourceDocument
  - useAsMainContent
```
public boolean useAsMainContent()
```
    Description copied from interface: TemplateSourceDocument
    
    Indicate if the template can be used as main blob in the TemplateBasedDocument (i.e. if the template is editable by the end user)
    
    Specified by:
    
    useAsMainContent in interface TemplateSourceDocument
  - getTemplateBlob
```
public Blob getTemplateBlob()
```
    Description copied from interface: TemplateSourceDocument
    
    Retrieve the Blob holding the template file
    
    Specified by:
    
    getTemplateBlob in interface TemplateSourceDocument
  - setTemplateBlob
```
public void setTemplateBlob(Blob blob,
                            boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Write accessor to the Blob used to store the template
    
    Specified by:
    
    setTemplateBlob in interface TemplateSourceDocument
  - getName
```
public String getName()
```
    Description copied from interface: TemplateSourceDocument
    
    Shortcut to access the underlying DocumentModel name
    
    Specified by:
    
    getName in interface TemplateSourceDocument
  - getFileName
```
public String getFileName()
```
    Description copied from interface: TemplateSourceDocument
    
    Shortcut to access the underlying Blob filename
    
    Specified by:
    
    getFileName in interface TemplateSourceDocument
    
    Returns:
    
    name
  - getTitle
```
public String getTitle()
```
    Description copied from interface: TemplateSourceDocument
    
    Shortcut to access the underlying DocumentModel title
    
    Specified by:
    
    getTitle in interface TemplateSourceDocument
    
    Returns:
    
    template filename
  - getVersionLabel
```
public String getVersionLabel()
```
    Description copied from interface: TemplateSourceDocument
    
    Shortcut to access the underlying DocumentModel versionLabel
    
    Specified by:
    
    getVersionLabel in interface TemplateSourceDocument
    
    Returns:
    
    versionLabel
  - getId
```
public String getId()
```
    Description copied from interface: TemplateSourceDocument
    
    Shortcut to access the underlying DocumentModel uuid
    
    Specified by:
    
    getId in interface TemplateSourceDocument
    
    Returns:
    
    UUID
  - getLabel
```
public String getLabel()
```
    Description copied from interface: TemplateSourceDocument
    
    Return label key used for template
    
    Specified by:
    
    getLabel in interface TemplateSourceDocument
  - getTargetRenditionName
```
public String getTargetRenditionName()
```
    Description copied from interface: TemplateSourceDocument
    
    Get the associated Rendition if any
    
    Specified by:
    
    getTargetRenditionName in interface TemplateSourceDocument
    
    Returns:
    
    Rendition name or null
  - setTargetRenditioName
```
public void setTargetRenditioName(String renditionName,
                                  boolean save)
```
    Description copied from interface: TemplateSourceDocument
    
    Associate Template to a Rendition
    
    Specified by:
    
    setTargetRenditioName in interface TemplateSourceDocument

Class TemplateSourceDocumentAdapterImpl

Field Summary

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

Fields inherited from interface org.nuxeo.template.api.adapters.TemplateSourceDocument

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_DATA_PROP

TEMPLATE_NAME_PROP

TEMPLATE_TYPE_PROP

TEMPLATE_TYPE_AUTO

TEMPLATE_APPLICABLE_TYPES_PROP

TEMPLATE_APPLICABLE_TYPES_ALL

TEMPLATE_FORCED_TYPES_PROP

TEMPLATE_FORCED_TYPES_ITEM_PROP

TEMPLATE_FORCED_TYPES_NONE

TEMPLATE_RENDITION_NONE

TEMPLATE_OUTPUT_PROP

TEMPLATE_OVERRIDE_PROP

TEMPLATE_USEASMAIN_PROP

TEMPLATE_RENDITION_PROP

TEMPLATE_FACET

Constructor Detail

TemplateSourceDocumentAdapterImpl

Method Detail

getTemplateParamsXPath

getParams

hasEditableParams

saveParams

getTemplateProcessor

getParamsAsString

addInput

hasInput

getTemplateType

initTemplate

computeTemplateName

allowInstanceOverride

initTypesBindings

getApplicableTypes

getForcedTypes

removeForcedType

setForcedTypes

getTemplateBasedDocuments

getOutputFormat

setOutputFormat

useAsMainContent

getTemplateBlob

setTemplateBlob

getName

getFileName

getTitle

getVersionLabel

getId

getLabel

getTargetRenditionName

setTargetRenditioName