org.nuxeo.ecm.platform.contentview.jsf

Class ContentViewRegistry

java.lang.Object

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

org.nuxeo.ecm.platform.contentview.jsf.ContentViewRegistry

public class ContentViewRegistry
extends ContributionFragmentRegistry<ContentViewDescriptor>

Registry for content view contributions, handling accurate merge on hot reload.

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,ContentViewDescriptor>	contentViews
protected Map<String,Set<String>>	contentViewsByFlag
protected static org.apache.commons.logging.Log	log

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

contribs

Constructor Summary

Constructors

Constructor and Description
ContentViewRegistry()

Method Summary

Modifier and Type	Method and Description
protected void	addContentViewFlags(ContentViewDescriptor desc)
ContentViewDescriptor	clone(ContentViewDescriptor orig) CLone the given contribution object
void	contributionRemoved(String id, ContentViewDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, ContentViewDescriptor contrib, ContentViewDescriptor newOrigContrib) Adds or updates a contribution.
ContentViewDescriptor	getContentView(String id)
Set<String>	getContentViewNames()
Collection<ContentViewDescriptor>	getContentViews()
Set<String>	getContentViewsByFlag(String flag)
String	getContributionId(ContentViewDescriptor contrib) Returns the contribution ID given the contribution object
boolean	hasContentView(String id)
void	merge(ContentViewDescriptor src, ContentViewDescriptor dst) Merge 'src' into 'dst'.
protected void	removeContentViewFlags(ContentViewDescriptor desc)
protected void	removeContentViewFlags(String contentViewName)

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

log

protected static final org.apache.commons.logging.Log log

contentViews

protected final Map<String,ContentViewDescriptor> contentViews

contentViewsByFlag

protected final Map<String,Set<String>> contentViewsByFlag

Constructor Detail

ContentViewRegistry

public ContentViewRegistry()

Method Detail

getContributionId

public String getContributionId(ContentViewDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<ContentViewDescriptor>

Returns:

contributionUpdated

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

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,
                                ContentViewDescriptor 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<ContentViewDescriptor>

addContentViewFlags

protected void addContentViewFlags(ContentViewDescriptor desc)

removeContentViewFlags

protected void removeContentViewFlags(String contentViewName)

removeContentViewFlags

protected void removeContentViewFlags(ContentViewDescriptor desc)

clone

public ContentViewDescriptor clone(ContentViewDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<ContentViewDescriptor>

Returns:

merge

public void merge(ContentViewDescriptor src,
                  ContentViewDescriptor dst)

Description copied from class: ContributionFragmentRegistry

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

Specified by:

merge in class ContributionFragmentRegistry<ContentViewDescriptor>

Parameters:

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

dst - this object is modified

getContentView

public ContentViewDescriptor getContentView(String id)

hasContentView

public boolean hasContentView(String id)

getContentViewsByFlag

public Set<String> getContentViewsByFlag(String flag)

getContentViewNames

public Set<String> getContentViewNames()

getContentViews

public Collection<ContentViewDescriptor> getContentViews()