|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.alfresco.repo.rendition.RenditionServiceImpl
public class RenditionServiceImpl
| Field Summary |
|---|
| Fields inherited from interface org.alfresco.service.cmr.rendition.RenditionService |
|---|
PARAM_DESTINATION_NODE, PARAM_DESTINATION_PATH_TEMPLATE, PARAM_IS_COMPONENT_RENDITION, PARAM_ORPHAN_EXISTING_RENDITION, PARAM_RENDITION_NODETYPE |
| Constructor Summary | |
|---|---|
RenditionServiceImpl()
|
|
| Method Summary | |
|---|---|
CompositeRenditionDefinition |
createCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)
Creates a new CompositeRenditionDefinition and sets the rendition
name and the rendering engine name to the specified values. |
RenditionDefinition |
createRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName,
java.lang.String renderingEngineName)
Creates a new RenditionDefinition and sets the rendition name and
the rendering engine name to the specified values. |
RenderingEngineDefinition |
getRenderingEngineDefinition(java.lang.String name)
Returns the RenderingEngineDefinition associated with the
specified rendering engine name. |
java.util.List |
getRenderingEngineDefinitions()
|
org.alfresco.service.cmr.repository.ChildAssociationRef |
getRenditionByName(org.alfresco.service.cmr.repository.NodeRef node,
org.alfresco.service.namespace.QName renditionName)
This method gets the rendition of the specified node identified by the provided rendition name. |
java.util.List |
getRenditions(org.alfresco.service.cmr.repository.NodeRef node)
This method gets all the renditions of the specified node. |
java.util.List |
getRenditions(org.alfresco.service.cmr.repository.NodeRef node,
java.lang.String mimeTypePrefix)
This method gets all the renditions of the specified node filtered by MIME-type prefix. |
org.alfresco.service.cmr.repository.ChildAssociationRef |
getSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)
This method gets the source node for the specified rendition node. |
boolean |
isRendition(org.alfresco.service.cmr.repository.NodeRef node)
This method returns true if the specified NodeRef is a valid
rendition node, else false. |
RenditionDefinition |
loadRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName)
This method retrieves a RenditionDefinition that has been stored
in the repository using the save() method. |
java.util.List |
loadRenditionDefinitions()
This method retrieves the RenditionDefinitions that have been
stored in the repository using the save() method. |
java.util.List |
loadRenditionDefinitions(java.lang.String renditionEngineName)
This method retrieves the stored RenditionDefinitions that have
been registered for the specified rendering engine name. |
org.alfresco.service.cmr.repository.ChildAssociationRef |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition definition)
This method synchronously renders content as specified by the given RenditionDefinition. |
void |
render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition definition,
RenderCallback callback)
This method asynchronously renders content as specified by the given RenditionDefinition. |
void |
saveRenditionDefinition(RenditionDefinition renderingAction)
This method serializes the RenditionDefinition and stores it in
the repository. |
void |
setActionService(ActionService actionService)
Injects the ActionService bean. |
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
Injects the DictionaryService bean. |
void |
setRenditionDefinitionPersister(RenditionDefinitionPersisterImpl renditionDefinitionPersister)
Injects the RenditionDefinitionPersister bean. |
void |
setServiceRegistry(ServiceRegistry serviceRegistry)
Injects the ServiceRegistry bean. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RenditionServiceImpl()
| Method Detail |
|---|
public void setRenditionDefinitionPersister(RenditionDefinitionPersisterImpl renditionDefinitionPersister)
renditionDefinitionPersister - public void setServiceRegistry(ServiceRegistry serviceRegistry)
serviceRegistry - public void setActionService(ActionService actionService)
actionService - public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
dictionaryService - public RenderingEngineDefinition getRenderingEngineDefinition(java.lang.String name)
RenditionServiceRenderingEngineDefinition associated with the
specified rendering engine name.
getRenderingEngineDefinition in interface RenditionServicename - The rendering engine name.
RenderingEngineDefinition or null.public java.util.List getRenderingEngineDefinitions()
getRenderingEngineDefinitions in interface RenditionServiceList of all available RenderingEngineDefinition
s.
public RenditionDefinition createRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName,
java.lang.String renderingEngineName)
RenditionServiceRenditionDefinition and sets the rendition name and
the rendering engine name to the specified values.
createRenditionDefinition in interface RenditionServicerenditionDefinitionName - A unique identifier used to specify the created
RenditionDefinition.renderingEngineName - The name of the rendering engine associated
with this RenditionDefinition.
RenditionDefinition.public CompositeRenditionDefinition createCompositeRenditionDefinition(org.alfresco.service.namespace.QName renditionName)
RenditionServiceCompositeRenditionDefinition and sets the rendition
name and the rendering engine name to the specified values.
createCompositeRenditionDefinition in interface RenditionServicerenditionName - A unique identifier used to specify the created
RenditionDefinition.
CompositeRenditionDefinition.
public org.alfresco.service.cmr.repository.ChildAssociationRef render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition definition)
RenditionServiceRenditionDefinition. The content to be rendered is provided by
the specified source node.
render in interface RenditionServicesourceNode - the node from which the content is retrieved.definition - this fully specifies the rendition which is to
be performed.
public void render(org.alfresco.service.cmr.repository.NodeRef sourceNode,
RenditionDefinition definition,
RenderCallback callback)
RenditionServiceRenditionDefinition. The content to be rendered is provided by
the specified source node.
render in interface RenditionServicesourceNode - the node from which the content is retrieved.definition - this fully specifies the rendition which is to
be performed.callback - a callback object to handle the ultimate result of the rendition.public void saveRenditionDefinition(RenditionDefinition renderingAction)
RenditionDefinitionPersisterRenditionDefinition and stores it in
the repository. RenditionDefinitions saved in this way may be
retrieved using the load() method.
saveRenditionDefinition in interface RenditionDefinitionPersisterrenderingAction - The RenditionDefinition to be
persisted.public RenditionDefinition loadRenditionDefinition(org.alfresco.service.namespace.QName renditionDefinitionName)
RenditionDefinitionPersisterRenditionDefinition that has been stored
in the repository using the save() method. If no
RenditionDefinition exists in the repository with the specified
rendition name then this method returns null.
loadRenditionDefinition in interface RenditionDefinitionPersisterrenditionDefinitionName - The unique identifier used to specify the
RenditionDefinition to retrieve.
RenditionDefinition or null.public java.util.List loadRenditionDefinitions()
RenditionDefinitionPersisterRenditionDefinitions that have been
stored in the repository using the save() method.
If there are no such RenditionDefinitions, an empty list is
returned.
loadRenditionDefinitions in interface RenditionDefinitionPersisterRenditionDefinitions.public java.util.List loadRenditionDefinitions(java.lang.String renditionEngineName)
RenditionDefinitionPersisterRenditionDefinitions that have
been registered for the specified rendering engine name.
If there are no such rendering RenditionDefinitions, an empty
list is returned.
loadRenditionDefinitions in interface RenditionDefinitionPersisterrenditionEngineName - the name of a rendering engine. This is
usually the spring bean name.
RenditionDefinitions.RenditionDefinitionPersister.saveRenditionDefinition(RenditionDefinition)public java.util.List getRenditions(org.alfresco.service.cmr.repository.NodeRef node)
RenditionService
getRenditions in interface RenditionService
public java.util.List getRenditions(org.alfresco.service.cmr.repository.NodeRef node,
java.lang.String mimeTypePrefix)
RenditionService
getRenditions in interface RenditionServicenode - the source node for the renditionsmimeTypePrefix - a prefix to check against the rendition MIME-types.
This must not be null and must not be an empty String
public org.alfresco.service.cmr.repository.ChildAssociationRef getRenditionByName(org.alfresco.service.cmr.repository.NodeRef node,
org.alfresco.service.namespace.QName renditionName)
RenditionService
getRenditionByName in interface RenditionServicenode - the source node for the renditionsrenditionName - the renditionName used to identify a rendition.
null if there is no such rendition.public boolean isRendition(org.alfresco.service.cmr.repository.NodeRef node)
RenditionServicetrue if the specified NodeRef is a valid
rendition node, else false. A nodeRef is a rendition node
if it has the rn:rendition aspect (or sub-aspect) applied.
isRendition in interface RenditionServicetrue if a rendition, else falsepublic org.alfresco.service.cmr.repository.ChildAssociationRef getSourceNode(org.alfresco.service.cmr.repository.NodeRef renditionNode)
RenditionService
getSourceNode in interface RenditionServicerenditionNode - the nodeRef holding the rendition.
null if there is no source node.RenditionService.isRendition(NodeRef)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||