org.nuxeo.template.service

Class TemplateProcessorComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.template.service.TemplateProcessorComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService, TemplateProcessorService

public class TemplateProcessorComponent
extends DefaultComponent
implements TemplateProcessorService

Runtime Component used to handle Extension Points and expose the TemplateProcessorService interface

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_EXTENSION_XP
static String	OUTPUT_FORMAT_EXTENSION_XP
static String	PROCESSOR_XP

Constructor Summary

Constructors

Constructor and Description
TemplateProcessorComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	addContextExtensions(DocumentModel currentDocument, DocumentWrapper wrapper, Map<String,Object> ctx)
void	deactivate(ComponentContext context) Deactivates the component.
DocumentModel	detachTemplateBasedDocument(DocumentModel targetDoc, String templateName, boolean save) Detach a Template from a DocumentModel
TemplateProcessor	findProcessor(Blob templateBlob) Finds the TemplateProcessor for a given Blob.
TemplateProcessorDescriptor	findProcessorDescriptor(Blob templateBlob)
String	findProcessorName(Blob templateBlob) Finds the template processor name for a given Blob.
List<TemplateSourceDocument>	getAvailableOfficeTemplates(CoreSession session, String targetType) Retrieve the TemplateSourceDocument that can be used as an Office template (i.e that support to store the template file as main blob of target DocumentModel)
List<DocumentModel>	getAvailableTemplateDocs(CoreSession session, String targetType) Find TemplateSourceDocuments that can be bound to a given doc type.
List<TemplateSourceDocument>	getAvailableTemplates(CoreSession session, String targetType) Find TemplateSourceDocuments that can be bound to a given doc type.
TemplateProcessorDescriptor	getDescriptor(String name)
List<TemplateBasedDocument>	getLinkedTemplateBasedDocuments(DocumentModel source) Retrieve the DocumentModels using a given TemplateSourceDocument
OutputFormatDescriptor	getOutputFormatDescriptor(String outputFormatId) The returned OutputFormatDescriptor contains either an operation chain or a mime-type use to convert the output of a rendered document.
Collection<OutputFormatDescriptor>	getOutputFormats()
TemplateProcessor	getProcessor(String name) Get a TemplateProcessor by it's name.
Collection<TemplateProcessorDescriptor>	getRegisteredTemplateProcessors() Returns all registered TemplateProcessors
Map<String,ContextExtensionFactoryDescriptor>	getRegistredContextExtensions()
List<String>	getReservedContextKeywords()
Map<String,List<String>>	getTypeMapping() Retrieve the Map used for mapping Document Types to Template Names.
DocumentModel	makeTemplateBasedDocument(DocumentModel targetDoc, DocumentModel sourceTemplateDoc, boolean save) Associate a DocumentModel to a TemplateSourceDocument.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	registerTypeMapping(DocumentModel doc) Update Type2Template Mapping from the data contained in the source DocumentModel.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSOR_XP

public static final String PROCESSOR_XP

See Also:

Constant Field Values

CONTEXT_EXTENSION_XP

public static final String CONTEXT_EXTENSION_XP

See Also:

Constant Field Values

OUTPUT_FORMAT_EXTENSION_XP

public static final String OUTPUT_FORMAT_EXTENSION_XP

See Also:

Constant Field Values

Constructor Detail

TemplateProcessorComponent

public TemplateProcessorComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

findProcessor

public TemplateProcessor findProcessor(Blob templateBlob)

Description copied from interface: TemplateProcessorService

Finds the TemplateProcessor for a given Blob. The template processor is found based on mime-types.

Specified by:

findProcessor in interface TemplateProcessorService

Returns:

the TemplateProcessor

findProcessorName

public String findProcessorName(Blob templateBlob)

Description copied from interface: TemplateProcessorService

Finds the template processor name for a given Blob. The template processor is found based on mime-types.

Specified by:

findProcessorName in interface TemplateProcessorService

Returns:

the TemplateProcessor name

findProcessorDescriptor

public TemplateProcessorDescriptor findProcessorDescriptor(Blob templateBlob)

addContextExtensions

public void addContextExtensions(DocumentModel currentDocument,
                        DocumentWrapper wrapper,
                        Map<String,Object> ctx)

Specified by:

addContextExtensions in interface TemplateProcessorService

getReservedContextKeywords

public List<String> getReservedContextKeywords()

Specified by:

getReservedContextKeywords in interface TemplateProcessorService

getRegistredContextExtensions

public Map<String,ContextExtensionFactoryDescriptor> getRegistredContextExtensions()

Specified by:

getRegistredContextExtensions in interface TemplateProcessorService

getDescriptor

public TemplateProcessorDescriptor getDescriptor(String name)

getProcessor

public TemplateProcessor getProcessor(String name)

Description copied from interface: TemplateProcessorService

Get a TemplateProcessor by it's name. Name is defined in the associated descriptor.

Specified by:

getProcessor in interface TemplateProcessorService

Returns:

the TemplateProcessor

getAvailableTemplateDocs

public List<DocumentModel> getAvailableTemplateDocs(CoreSession session,
                                           String targetType)
                                             throws ClientException

Description copied from interface: TemplateProcessorService

Find TemplateSourceDocuments that can be bound to a given doc type.

Specified by:

getAvailableTemplateDocs in interface TemplateProcessorService

targetType - the target Document Type

Returns:

List of applicable DocumentModel

Throws:

ClientException

getAvailableOfficeTemplates

public List<TemplateSourceDocument> getAvailableOfficeTemplates(CoreSession session,
                                                       String targetType)
                                                         throws ClientException

Description copied from interface: TemplateProcessorService

Retrieve the TemplateSourceDocument that can be used as an Office template (i.e that support to store the template file as main blob of target DocumentModel)

Specified by:

getAvailableOfficeTemplates in interface TemplateProcessorService

Returns:

Throws:

ClientException

getAvailableTemplates

public List<TemplateSourceDocument> getAvailableTemplates(CoreSession session,
                                                 String targetType)
                                                   throws ClientException

Description copied from interface: TemplateProcessorService

Find TemplateSourceDocuments that can be bound to a given doc type.

Specified by:

getAvailableTemplates in interface TemplateProcessorService

targetType - the target Document Type

Returns:

List of applicable TemplateSourceDocument

Throws:

ClientException

getLinkedTemplateBasedDocuments

public List<TemplateBasedDocument> getLinkedTemplateBasedDocuments(DocumentModel source)
                                                            throws ClientException

Description copied from interface: TemplateProcessorService

Retrieve the DocumentModels using a given TemplateSourceDocument

Specified by:

getLinkedTemplateBasedDocuments in interface TemplateProcessorService

Parameters:

source - the TemplateSourceDocument

Returns:

Throws:

ClientException

getRegisteredTemplateProcessors

public Collection<TemplateProcessorDescriptor> getRegisteredTemplateProcessors()

Description copied from interface: TemplateProcessorService

Returns all registered TemplateProcessors

Specified by:

getRegisteredTemplateProcessors in interface TemplateProcessorService

Returns:

collection of registered TemplateProcessorDescriptor

getTypeMapping

public Map<String,List<String>> getTypeMapping()

Description copied from interface: TemplateProcessorService

Retrieve the Map used for mapping Document Types to Template Names. This Map represent the Templates that must be automatically bound at creation time for each Document Type.

Specified by:

getTypeMapping in interface TemplateProcessorService

Returns:

the Type2Template mapping

registerTypeMapping

public void registerTypeMapping(DocumentModel doc)
                         throws ClientException

Description copied from interface: TemplateProcessorService

Update Type2Template Mapping from the data contained in the source DocumentModel.

Specified by:

registerTypeMapping in interface TemplateProcessorService

Throws:

ClientException

makeTemplateBasedDocument

public DocumentModel makeTemplateBasedDocument(DocumentModel targetDoc,
                                      DocumentModel sourceTemplateDoc,
                                      boolean save)
                                        throws ClientException

Description copied from interface: TemplateProcessorService

Associate a DocumentModel to a TemplateSourceDocument. If the DocumentModel is not already a TemplateBasedDocument, the associated facet will be automatically added.

Specified by:

makeTemplateBasedDocument in interface TemplateProcessorService

Parameters:

targetDoc - the DocumentModel to associate to a template

sourceTemplateDoc - the DocumentModel holding the template

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

Returns:

the updated DocumentModel

Throws:

ClientException

detachTemplateBasedDocument

public DocumentModel detachTemplateBasedDocument(DocumentModel targetDoc,
                                        String templateName,
                                        boolean save)
                                          throws ClientException

Description copied from interface: TemplateProcessorService

Detach a Template from a DocumentModel

Specified by:

detachTemplateBasedDocument in interface TemplateProcessorService

Parameters:

targetDoc - the DocumentModel to detach

templateName - the name of the template to detach

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

Returns:

the updated DocumentModel

Throws:

ClientException

getOutputFormats

public Collection<OutputFormatDescriptor> getOutputFormats()

Specified by:

getOutputFormats in interface TemplateProcessorService

Returns:

the list of registered Ouput formats used to convert output of a rendered document.

getOutputFormatDescriptor

public OutputFormatDescriptor getOutputFormatDescriptor(String outputFormatId)

Description copied from interface: TemplateProcessorService

The returned OutputFormatDescriptor contains either an operation chain or a mime-type use to convert the output of a rendered document.

Specified by:

getOutputFormatDescriptor in interface TemplateProcessorService

Returns:

OutputFormatDescriptor