Package org.alfresco.repo.virtual.template

Class TemplateResourceProcessor

java.lang.Object

org.alfresco.repo.virtual.template.TemplateResourceProcessor

All Implemented Interfaces:

ResourceProcessor<VirtualFolderDefinition>

public class TemplateResourceProcessor
extends java.lang.Object
implements ResourceProcessor<VirtualFolderDefinition>

Executes JavaScript virtual folders templates ensuring their required context and the VirtualFolderDefinition post execution JSON map result unmarshalling.

Author:

Bogdan Horje

Constructor Summary

Constructors

Constructor	Description
TemplateResourceProcessor(VirtualContext context)

Method Summary

Modifier and Type	Method	Description
protected FilingRule	asFilingRule(VirtualContext context, java.lang.Object filing)	Creates a filing rule based on the criteria (path, classification: type, aspects) given in the template.
protected VirtualQuery	asVirtualQuery(VirtualContext context, java.util.Map<java.lang.String,java.lang.Object> search)	Creates a query based on the details: language, store, query statement given in the template.
protected VirtualFolderDefinition	asVirtualStructure(VirtualContext context, java.util.Map<java.lang.String,java.lang.Object> result)	Creates a VirtualFolderDefinition that represents the structure of the virtual folder.
protected java.util.Map<java.lang.String,java.lang.Object>	createScriptParameters(VirtualContext context)	Adds the script virtual context to the parameters of the context.
VirtualFolderDefinition	process(ClasspathResource classpath)	Processes the JavaScript template given by the ClasspathResource and creates a VirtualFolderDefinition (composite) structure that represents the virtual folder.
VirtualFolderDefinition	process(RepositoryResource repositoryResource)	Processes the JavaScript template given by the RepositoryResource and creates a VirtualFolderDefinition (composite) structure that represents the virtual folder.
VirtualFolderDefinition	process(Resource resource)	Processes a resource of type Resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateResourceProcessor

public TemplateResourceProcessor(VirtualContext context)

Method Detail

process

public VirtualFolderDefinition process(Resource resource)
                                throws ResourceProcessingError

Description copied from interface: ResourceProcessor

Processes a resource of type Resource.

Specified by:

process in interface ResourceProcessor<VirtualFolderDefinition>

Parameters:

resource - a Resource to be processed.

Returns:

generic parameter R that implementors are parameterised with.

Throws:

ResourceProcessingError

process

public VirtualFolderDefinition process(ClasspathResource classpath)
                                throws ResourceProcessingError

Processes the JavaScript template given by the ClasspathResource and creates a VirtualFolderDefinition (composite) structure that represents the virtual folder.

Specified by:

process in interface ResourceProcessor<VirtualFolderDefinition>

Parameters:

A - ClasspathResource reference.

Returns:

A VirtualFolderDefinition reference that represents the structure (tree of nodes) of the virtual folder.

Throws:

ResourceProcessingError

process

public VirtualFolderDefinition process(RepositoryResource repositoryResource)
                                throws ResourceProcessingError

Processes the JavaScript template given by the RepositoryResource and creates a VirtualFolderDefinition (composite) structure that represents the virtual folder.

Specified by:

process in interface ResourceProcessor<VirtualFolderDefinition>

Parameters:

A - RepositoryResource reference.

Returns:

A VirtualFolderDefinition reference that represents the structure (tree of nodes) of the virtual folder.

Throws:

ResourceProcessingError

createScriptParameters

protected java.util.Map<java.lang.String,java.lang.Object> createScriptParameters(VirtualContext context)
                                                                                 throws ActualEnvironmentException

Adds the script virtual context to the parameters of the context.

Parameters:

context - A VirtualContext reference.

Returns:

A map of context parameters.

Throws:

ActualEnvironmentException

asFilingRule

protected FilingRule asFilingRule(VirtualContext context,
                                  java.lang.Object filing)
                           throws ResourceProcessingError

Creates a filing rule based on the criteria (path, classification: type, aspects) given in the template.

Parameters:

context - The context in which the virtualization process takes place.

filing - A map containing the filing criteria used to create the rule.

Returns:

A FilingRule reference.

Throws:

ResourceProcessingError

asVirtualQuery

protected VirtualQuery asVirtualQuery(VirtualContext context,
                                      java.util.Map<java.lang.String,java.lang.Object> search)
                               throws ResourceProcessingError

Creates a query based on the details: language, store, query statement given in the template.

Parameters:

context - The context in which the virtualization process takes place.

search - A map containing the details that define the query: language, store, query statement.

Returns:

an AlfrescoVirtualQuery reference.

Throws:

ResourceProcessingError

asVirtualStructure

protected VirtualFolderDefinition asVirtualStructure(VirtualContext context,
                                                     java.util.Map<java.lang.String,java.lang.Object> result)
                                              throws ResourceProcessingError

Creates a VirtualFolderDefinition that represents the structure of the virtual folder.

Parameters:

context - The context in which the virtualization process takes place.

result - A map containing the details that define the virtual entries.

Returns:

a VirtualFolderDefinition reference.

Throws:

ResourceProcessingError