org.nuxeo.ecm.platform.rendition.service

Class RenditionDefinitionRegistry

java.lang.Object

org.nuxeo.runtime.model.ContributionFragmentRegistry<RenditionDefinition>

org.nuxeo.ecm.platform.rendition.service.RenditionDefinitionRegistry

public class RenditionDefinitionRegistry
extends ContributionFragmentRegistry<RenditionDefinition>

Registry for RenditionDefinition objects.

Since:

7.3

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,RenditionDefinition>	descriptors

Fields inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

contribs

Constructor Summary

Constructors

Constructor and Description
RenditionDefinitionRegistry()

Method Summary

Modifier and Type	Method and Description
protected boolean	canUseRenditionDefinition(RenditionDefinition renditionDefinition, DocumentModel doc)
RenditionDefinition	clone(RenditionDefinition contrib) CLone the given contribution object
void	contributionRemoved(String id, RenditionDefinition contrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, RenditionDefinition contrib, RenditionDefinition newOrigContrib) Adds or updates a contribution.
protected ActionContext	createActionContext(DocumentModel doc)
String	getContributionId(RenditionDefinition renditionDefinition) Returns the contribution ID given the contribution object
RenditionDefinition	getRenditionDefinition(String name)
List<RenditionDefinition>	getRenditionDefinitions(DocumentModel doc)
void	merge(RenditionDefinition source, RenditionDefinition dest) Merge 'src' into 'dst'.
protected void	setupProvider(RenditionDefinition definition)

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

addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeContribution, removeFragment, toMap

Methods inherited from class java.lang.Object

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

Field Detail

descriptors

protected Map<String,RenditionDefinition> descriptors

Constructor Detail

RenditionDefinitionRegistry

public RenditionDefinitionRegistry()

Method Detail

getRenditionDefinition

public RenditionDefinition getRenditionDefinition(String name)

getRenditionDefinitions

public List<RenditionDefinition> getRenditionDefinitions(DocumentModel doc)

canUseRenditionDefinition

protected boolean canUseRenditionDefinition(RenditionDefinition renditionDefinition,
                                            DocumentModel doc)

createActionContext

protected ActionContext createActionContext(DocumentModel doc)

getContributionId

public String getContributionId(RenditionDefinition renditionDefinition)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<RenditionDefinition>

Returns:

contributionUpdated

public void contributionUpdated(String id,
                                RenditionDefinition contrib,
                                RenditionDefinition newOrigContrib)

Description copied from class: ContributionFragmentRegistry

Adds or updates a contribution.

If the contribution doesn't yet exists then it will be added, otherwise the value will be updated. If the given value is null the existing contribution must be removed.

The second parameter is the contribution that should be updated when merging, as well as stored and used. This usually represents a clone of the original contribution or a merge of multiple contribution fragments. Modifications on this object at application level will be lost on next ContributionFragmentRegistry.contributionUpdated(String, Object, Object) call on the same object id: modifications should be done in the ContributionFragmentRegistry.merge(Object, Object) method.

The last parameter is the new contribution object, unchanged (original) which was neither cloned nor merged. This object should never be modified at application level, because it will be used each time a subsequent merge is done. Also, it never should be stored.

Specified by:

contributionUpdated in class ContributionFragmentRegistry<RenditionDefinition>

Parameters:

id - - the id of the contribution that needs to be updated

contrib - the updated contribution object that

newOrigContrib - - the new, unchanged (original) contribution fragment that triggered the update.

setupProvider

protected void setupProvider(RenditionDefinition definition)

contributionRemoved

public void contributionRemoved(String id,
                                RenditionDefinition contrib)

Description copied from class: ContributionFragmentRegistry

All the fragments in the contribution was removed. Contribution must be unregistered.

The first parameter is the contribution ID that should be remove and the second parameter the original contribution fragment that as unregistered causing the contribution to be removed.

Specified by:

contributionRemoved in class ContributionFragmentRegistry<RenditionDefinition>

clone

public RenditionDefinition clone(RenditionDefinition contrib)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<RenditionDefinition>

Returns:

merge

public void merge(RenditionDefinition source,
                  RenditionDefinition dest)

Description copied from class: ContributionFragmentRegistry

Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Specified by:

merge in class ContributionFragmentRegistry<RenditionDefinition>

Parameters:

source - the object to copy over the 'dst' object

dest - this object is modified