org.nuxeo.ecm.core.lifecycle.impl

Class LifeCycleTypeRegistry

java.lang.Object

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

org.nuxeo.ecm.core.lifecycle.impl.LifeCycleTypeRegistry

public class LifeCycleTypeRegistry
extends ContributionFragmentRegistry<LifeCycleTypesDescriptor>

Registry for lifecycle <-> types association

Since:

5.6

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,List<String>>	docTypeToNonRecursiveTransition a mapping from doc type -> list of transitions that should not recurse.
protected Map<String,String>	typesMapping Type name -> life cycle name.

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

contribs

Constructor Summary

Constructors

Constructor and Description
LifeCycleTypeRegistry()

Method Summary

Modifier and Type	Method and Description
LifeCycleTypesDescriptor	clone(LifeCycleTypesDescriptor orig) CLone the given contribution object
void	contributionRemoved(String id, LifeCycleTypesDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, LifeCycleTypesDescriptor contrib, LifeCycleTypesDescriptor newOrigContrib) Adds or updates a contribution.
String	getContributionId(LifeCycleTypesDescriptor contrib) Returns the contribution ID given the contribution object
String	getLifeCycleNameForType(String docType)
List<String>	getNonRecursiveTransitionForDocType(String docTypeName)
Collection<String>	getTypesFor(String lifeCycleName)
Map<String,String>	getTypesMapping()
boolean	isSupportingMerge() Returns true if merge is supported.
void	merge(LifeCycleTypesDescriptor src, LifeCycleTypesDescriptor dst) Merge 'src' into 'dst'.

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

addContribution, addFragment, getContribution, getFragments, removeContribution, removeContribution, removeFragment

Methods inherited from class java.lang.Object

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

Field Detail

typesMapping

protected Map<String,String> typesMapping

Type name -> life cycle name.

docTypeToNonRecursiveTransition

protected Map<String,List<String>> docTypeToNonRecursiveTransition

a mapping from doc type -> list of transitions that should not recurse.

Constructor Detail

LifeCycleTypeRegistry

public LifeCycleTypeRegistry()

Method Detail

getContributionId

public String getContributionId(LifeCycleTypesDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<LifeCycleTypesDescriptor>

Returns:

contributionUpdated

public void contributionUpdated(String id,
                                LifeCycleTypesDescriptor contrib,
                                LifeCycleTypesDescriptor 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<LifeCycleTypesDescriptor>

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.

contributionRemoved

public void contributionRemoved(String id,
                                LifeCycleTypesDescriptor origContrib)

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<LifeCycleTypesDescriptor>

isSupportingMerge

public boolean isSupportingMerge()

Description copied from class: ContributionFragmentRegistry

Returns true if merge is supported.

Hook method to be overridden if merge logics behind Object.clone() and ContributionFragmentRegistry.merge(Object, Object) cannot be implemented.

Overrides:

isSupportingMerge in class ContributionFragmentRegistry<LifeCycleTypesDescriptor>

clone

public LifeCycleTypesDescriptor clone(LifeCycleTypesDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<LifeCycleTypesDescriptor>

Returns:

merge

public void merge(LifeCycleTypesDescriptor src,
                  LifeCycleTypesDescriptor dst)

Description copied from class: ContributionFragmentRegistry

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

Specified by:

merge in class ContributionFragmentRegistry<LifeCycleTypesDescriptor>

Parameters:

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

dst - this object is modified

getLifeCycleNameForType

public String getLifeCycleNameForType(String docType)

getTypesFor

public Collection<String> getTypesFor(String lifeCycleName)

getTypesMapping

public Map<String,String> getTypesMapping()

getNonRecursiveTransitionForDocType

public List<String> getNonRecursiveTransitionForDocType(String docTypeName)