org.ametys.cms.contenttype

Class ContentTypesHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.contenttype.ContentTypesHelper

All Implemented Interfaces:

Disposable, Component, LogEnabled, Serviceable, ThreadSafe

public class ContentTypesHelper
extends AbstractLogEnabled
implements Component, Serviceable, ThreadSafe, Disposable

Helper for manipulating ContentTypes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	ContentTypesHelper.ContentTypeComparator

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Map<String,MetadataSet>>	_cacheForEdition
private Map<String,Map<String,MetadataSet>>	_cacheForView
protected ContentTypeExtensionPoint	_cTypeEP The content types extension point
private DynamicContentTypeDescriptorExtentionPoint	_dynamicCTDescriptorEP
protected RightManager	_rightManager The rights manager
protected RootContentHelper	_rootContentHelper Helper for root content
private ServiceManager	_smanager
protected CurrentUserProvider	_userProvider The current user provider
static String	ROLE The Avalon role

Constructor Summary

Constructors

Constructor and Description
ContentTypesHelper()

Method Summary

Modifier and Type	Method and Description
private void	_addIfNotPresent(Collection<String> collection, String value)
private List<Set<String>>	_buildReverseHierarchies(String contentTypeId, Set<String> hierarchy)
private boolean	_containsContentType(String[] cTypesId, String cTypeId)
private void	_copyMetadataSetElementsIfNotExist(AbstractMetadataSetElement src, AbstractMetadataSetElement dest, AbstractMetadataSetElement reference)
private Map<String,Object>	_dispatchContentTypes(boolean checkRights, boolean includePrivate, boolean includeMixins, boolean includeAbstract, Collection<String> allContentTypesIds)
private String	_getCacheIdentifier(String[] contentTypes, String[] mixins)
protected ContentTypeExtensionPoint	_getContentTypeEP() Lazy lookup of ContentTypeExtensionPoint
protected void	_getMetadataDefinitionsAcc(Map<String,MetadataDefinition> internalAcc, AbstractMetadataSetElement metadataSetElement, String prefix, MetadataDefinitionHolder metaDefHolder) Populate the accumulator with the metadata definition
protected MetadataSet	_getMetadataSet(ContentType contentType, String metadataSetName, boolean isEdition) Get the metadataset of a content given the parameters
protected boolean	_hasRight(ContentType contentType) Test if the current user has the right needed by the content type to create a content.
List<Set<String>>	buildReverseHierarchies(String contentTypeId) Builds the reverse hierarchies of ancestors of a content type
boolean	canRead(Content content, MetadataDefinition metadataDef) Determine whether a metadata can be read at this time.
boolean	canWrite(Content content, MetadataDefinition metadataDef) Determine whether a metadata can be read at this time.
void	copyMetadataSetElementsIfNotExist(AbstractMetadataSetElement src, AbstractMetadataSetElement dest) Copy the elements of metadata set into a metadata set of destination, only if the elements are not already presents
void	dispose()
Set<String>	getAncestors(String contentTypeId) Get all ancestors for the given content type
String	getCommonAncestor(Collection<String> contentTypes) Get the id of the content type common ancestor
Map<String,MetadataDefinition>	getCommonMetadataDefinitions(Collection<String> cTypeIds, String metadataSetName, boolean isEdition) Retrieves the common metadata definitions for a list of content types
I18nizableText	getContentTypeCategory(Content content) Retrieves the category of the content type.
I18nizableText	getContentTypeDefaultTitle(Content content) Retrieves the default title of the content type.
I18nizableText	getContentTypeDescription(Content content) Retrieves the description of the content type.
String	getContentTypeIdForRendering(Content content) Get the id of content type to use for rendering
I18nizableText	getContentTypeLabel(Content content) Retrieves the label of the content type.
String	getContentTypePluginForRendering(Content content) Get the plugin name of content type to use for rendering
Map<String,Object>	getContentTypeProperties(ContentType contentType) Get the content type properties
Set<Map<String,Object>>	getContentTypesInformations() Get information on content types.
Map<String,Object>	getContentTypesList(List<String> ids, boolean inherited, boolean checkRights, boolean includePrivate, boolean includeMixins, boolean includeAbstract) Get information on content types.
ContentType	getFirstContentType(Content content) Get the content type which determines the content icons and rendering
String	getIconDecorator(Content content) Retrieves the CSS class to use as decorator above the main icon
String	getIconGlyph(Content content) Retrieves the CSS class to use as glyph icon of the content
IndexingModel	getIndexingModel(Content content) Get the indexing model resulting of the concatenation of indexing models of given content types and mixins.
IndexingModel	getIndexingModel(String[] cTypes, String[] mixins) Get the indexing model resulting of the concatenation of indexing models of given content types and mixins.
String	getLargeIcon(Content content) Retrieves the URL of the icon without the context path.
String	getMediumIcon(Content content) Retrieves the URL of the icon without the context path.
MetadataDefinition	getMetadataDefinition(String metadataPath, Content content) Retrieve the metadata definition represented by the given path.
MetadataDefinition	getMetadataDefinition(String metadataPath, ContentType initialContentType) Retrieves a metadata definition from a path.
MetadataDefinition	getMetadataDefinition(String metadataPath, String[] cTypes, String[] mixins) Retrieve the metadata definition represented by the given path.
MetadataDefinition	getMetadataDefinitionByMetadataValuePath(String metadataValuePath, Content content) Retrieve the definition of a given content metadata value path.
private MetadataDefinition	getMetadataDefinitionByMetadataValuePath(String metadataValuePath, MetadataDefinitionHolder metadataDefHolder) Retrieve the definition of a given content metadata value path.
MetadataDefinition	getMetadataDefinitionByMetadataValuePath(String metadataValuePath, String[] cTypes, String[] mixins) Retrieve the definition of a given content metadata value path.
List<MetadataDefinition>	getMetadataDefinitionPath(String metadataPath, Content content) Retrieve the list of successive metadata definitions represented by the given path.
List<MetadataDefinition>	getMetadataDefinitionPath(String metadataPath, ContentType initialContentType) Retrieve the list of successive metadata definitions represented by the given path.
List<MetadataDefinition>	getMetadataDefinitionPath(String metadataPath, String[] cTypes, String[] mixins) Retrieve the list of successive metadata definitions represented by the given path.
Map<String,MetadataDefinition>	getMetadataDefinitions(MetadataDefinitionHolder metaDefHolder, Predicate<MetadataDefinition> predicate) Get a flat map of MetadataDefinition corresponding to the required predicate (boolean-valued function) For example, to get all metadata definitions of type CONTENT, we can do: getMetadataDefinitions(contentType, m -> m.getType() == MetadataType.CONTENT)
Map<String,MetadataDefinition>	getMetadataDefinitions(MetadataSet metadataSet, Content content) Get a flat map of MetadataDefinition corresponding to a metadataSet
Map<String,MetadataDefinition>	getMetadataDefinitions(MetadataSet metadataSet, ContentType initialContentType) Get a flat map of MetadataDefinition corresponding to a metadataset
Map<String,MetadataDefinition>	getMetadataDefinitions(MetadataSet metadataSet, String[] cTypes, String[] mixins) Get a flat map of MetadataDefinition corresponding to a metadataset
Map<String,MetadataDefinition>	getMetadataDefinitions(Set<String> metadataPaths, Content content) Get a flat map of MetadataDefinition corresponding to a set of metadata paths
Map<String,MetadataDefinition>	getMetadataDefinitions(Set<String> metadataPaths, ContentType initialContentType) Get a flat map of MetadataDefinition corresponding to a set of metadata paths
Map<String,MetadataDefinition>	getMetadataDefinitions(Set<String> metadataPaths, String[] cTypes, String[] mixins) Get a flat map of MetadataDefinition corresponding to a set of metadata paths
Map<String,MetadataDefinition>	getMetadataDefinitions(String[] cTypes) Retrieves all definitions of a metadata resulting of the concatenation of metadata of given content types.
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(MetadataSet metadataSet, Content content) Get a flat map of MetadataDefinition path corresponding to a metadataset
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(MetadataSet metadataSet, ContentType initialContentType) Get a flat map of MetadataDefinition path corresponding to a metadataSet
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(MetadataSet metadataSet, String[] cTypes, String[] mixins) Get a flat map of MetadataDefinition path corresponding to a metadataset
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(Set<String> metadataPaths, Content content) Get a flat map of MetadataDefinition path corresponding to a set of metadata paths
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(Set<String> metadataPaths, ContentType initialContentType) Get a flat map of MetadataDefinition path corresponding to a set of metadata paths
Map<String,List<MetadataDefinition>>	getMetadataDefinitionsPaths(Set<String> metadataPaths, String[] cTypes, String[] mixins) Get a flat map of MetadataDefinition path corresponding to a set of metadata paths
Set<String>	getMetadataNames(Content content) Retrieves the root metadata names of a content.
Set<String>	getMetadataNames(String[] cTypes, String[] mixins) Retrieves the metadata names resulting of the union of metadata names of given content types and mixins
protected Set<String>	getMetadataPaths(AbstractMetadataSetElement metadataSet, String prefix) Get a flat map of metadatadefinition corresponding to a metadataset of a content
Set<String>	getMetadataPaths(MetadataSet metadataSet) Get a flat map of MetadataDefinition corresponding to a metadataset of a content
MetadataSet	getMetadataSetForEdition(String metadataSetName, String[] cTypes, String[] mixins) Get the metadata set for edition resulting of the concatenation of metadata sets of given content types and mixins.
MetadataSet	getMetadataSetForView(String metadataSetName, String[] cTypes, String[] mixins) Get the metadata set for view resulting of the concatenation of metadata sets of given content types and mixins.
Map<String,MetadataSet>	getMetadataSetsForEdition(String[] cTypes, String[] mixins, boolean includeInternal) Get all metadata sets for edition resulting of the concatenation of metadata sets of given content types and mixins.
Map<String,MetadataSet>	getMetadataSetsForView(String[] cTypes, String[] mixins, boolean includeInternal) Get all metadata sets for view resulting of the concatenation of metadata sets of given content types and mixins.
List<Map<String,Object>>	getMetadataSetsInfo(String cTypeId, boolean edition, boolean includeInternal) Get the metadata sets of a content type
String	getSmallIcon(Content content) Retrieves the URL of the icon without the context path.
static MetadataDefinition	getTitleMetadataDefinition() Get the metadata definition for the "title" standard metadata.
boolean	isCompatibleContentType(Content content, String cTypeId) Determines if the given content type can be added to content
boolean	isInstanceOf(Content content, String cTypeId) Determines if a content is a instance of given content type id
protected Set<String>	removeAncestors(Set<String> contentTypes) Remove all content types in the set that are ancestors of other content types in the set.
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content types extension point

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_rightManager

protected RightManager _rightManager

The rights manager

_rootContentHelper

protected RootContentHelper _rootContentHelper

Helper for root content

_dynamicCTDescriptorEP

private DynamicContentTypeDescriptorExtentionPoint _dynamicCTDescriptorEP

_cacheForView

private Map<String,Map<String,MetadataSet>> _cacheForView

_cacheForEdition

private Map<String,Map<String,MetadataSet>> _cacheForEdition

_smanager

private ServiceManager _smanager

Constructor Detail

ContentTypesHelper

public ContentTypesHelper()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

_getContentTypeEP

protected ContentTypeExtensionPoint _getContentTypeEP()

Lazy lookup of ContentTypeExtensionPoint

Returns:

the content type extension point

isInstanceOf

public boolean isInstanceOf(Content content,
                            String cTypeId)

Determines if a content is a instance of given content type id

Parameters:

content - The content

cTypeId - The id of content type or mixin

Returns:

true if the content is an instance of content type

_containsContentType

private boolean _containsContentType(String[] cTypesId,
                                     String cTypeId)

getCommonAncestor

public String getCommonAncestor(Collection<String> contentTypes)

Get the id of the content type common ancestor

Parameters:

contentTypes - The content types to compare

Returns:

The id of common ancestor or null if not found

removeAncestors

protected Set<String> removeAncestors(Set<String> contentTypes)

Remove all content types in the set that are ancestors of other content types in the set.

Parameters:

contentTypes - a Set of content type IDs.

Returns:

a Set of content type IDs without ancestors.

getAncestors

public Set<String> getAncestors(String contentTypeId)

Get all ancestors for the given content type

Parameters:

contentTypeId - The content type id to test

Returns:

A non-null set of all ancestors. Does not contains the contentTypeId itself.

Throws:

IllegalArgumentException - if the content type does not exist.

buildReverseHierarchies

public List<Set<String>> buildReverseHierarchies(String contentTypeId)

Builds the reverse hierarchies of ancestors of a content type

Parameters:

contentTypeId - The content type's id

Returns:

the reverse hierarchies with ancestors

_buildReverseHierarchies

private List<Set<String>> _buildReverseHierarchies(String contentTypeId,
                                                   Set<String> hierarchy)

getMetadataNames

public Set<String> getMetadataNames(Content content)

Retrieves the root metadata names of a content.

Parameters:

content - The content.

Returns:

the metadata names.

getMetadataNames

public Set<String> getMetadataNames(String[] cTypes,
                                    String[] mixins)

Retrieves the metadata names resulting of the union of metadata names of given content types and mixins

Parameters:

cTypes - The id of content types

mixins - The id of mixins

Returns:

the metadata names.

getMetadataSetsForView

public Map<String,MetadataSet> getMetadataSetsForView(String[] cTypes,
                                                      String[] mixins,
                                                      boolean includeInternal)

Get all metadata sets for view resulting of the concatenation of metadata sets of given content types and mixins.

Parameters:

cTypes - The id of content types

mixins - The id of mixins

includeInternal - true True to include internal metadata sets

Returns:

The metadata sets

getMetadataSetsForEdition

public Map<String,MetadataSet> getMetadataSetsForEdition(String[] cTypes,
                                                         String[] mixins,
                                                         boolean includeInternal)

Get all metadata sets for edition resulting of the concatenation of metadata sets of given content types and mixins.

Parameters:

cTypes - The id of content types

mixins - The id of mixins

includeInternal - true True to include internal metadata sets

Returns:

The metadata sets

getMetadataSetForView

public MetadataSet getMetadataSetForView(String metadataSetName,
                                         String[] cTypes,
                                         String[] mixins)

Get the metadata set for view resulting of the concatenation of metadata sets of given content types and mixins.

Parameters:

metadataSetName - the name of metadata set to retrieve

cTypes - The id of content types

mixins - The id of mixins

Returns:

The list of metadata set names.

getMetadataSetForEdition

public MetadataSet getMetadataSetForEdition(String metadataSetName,
                                            String[] cTypes,
                                            String[] mixins)

Get the metadata set for edition resulting of the concatenation of metadata sets of given content types and mixins.

Parameters:

metadataSetName - the name of metadata set to retrieve

cTypes - The id of content types

mixins - The id of mixins

Returns:

The metadata set

getMetadataSetsInfo

public List<Map<String,Object>> getMetadataSetsInfo(String cTypeId,
                                                    boolean edition,
                                                    boolean includeInternal)

Get the metadata sets of a content type

Parameters:

cTypeId - the content type id

edition - Set to true to get edition metadata set. False otherwise.

includeInternal - Set to true to include internal metadata sets.

Returns:

the metadata sets info

getIndexingModel

public IndexingModel getIndexingModel(Content content)

Get the indexing model resulting of the concatenation of indexing models of given content types and mixins.

Parameters:

content - The content.

Returns:

The indexing model

getIndexingModel

public IndexingModel getIndexingModel(String[] cTypes,
                                      String[] mixins)

Get the indexing model resulting of the concatenation of indexing models of given content types and mixins.

Parameters:

cTypes - The id of content types

mixins - The id of mixins

Returns:

The indexing model

copyMetadataSetElementsIfNotExist

public void copyMetadataSetElementsIfNotExist(AbstractMetadataSetElement src,
                                              AbstractMetadataSetElement dest)

Copy the elements of metadata set into a metadata set of destination, only if the elements are not already presents

Parameters:

src - The metadata set to copy

dest - The metadata of destination

_copyMetadataSetElementsIfNotExist

private void _copyMetadataSetElementsIfNotExist(AbstractMetadataSetElement src,
                                                AbstractMetadataSetElement dest,
                                                AbstractMetadataSetElement reference)

getMetadataDefinitionByMetadataValuePath

public MetadataDefinition getMetadataDefinitionByMetadataValuePath(String metadataValuePath,
                                                                   Content content)

Retrieve the definition of a given content metadata value path.

Parameters:

metadataValuePath - the metadata value path: it is separated by slashes and repeaters are valued: eg: "mycomposite/myrepeater[3]/mymetadata".

content - the content.

Returns:

the metadata definition or null if not found

getMetadataDefinitionByMetadataValuePath

public MetadataDefinition getMetadataDefinitionByMetadataValuePath(String metadataValuePath,
                                                                   String[] cTypes,
                                                                   String[] mixins)

Retrieve the definition of a given content metadata value path.

Parameters:

metadataValuePath - the metadata value path: it is separated by slashes and repeaters are valued: eg: "mycomposite.myrepeater[3].mymetadata".

cTypes - The id of content types

mixins - The id of mixins

Returns:

the metadata definition or null if not found

getMetadataDefinitionByMetadataValuePath

private MetadataDefinition getMetadataDefinitionByMetadataValuePath(String metadataValuePath,
                                                                    MetadataDefinitionHolder metadataDefHolder)

Retrieve the definition of a given content metadata value path.

Parameters:

metadataValuePath - the metadata value path: it is separated by slashes and repeaters are valued: eg: "mycomposite/myrepeater[3]/mymetadata".

metadataDefHolder - The metadata def holder (such as the content type)

Returns:

the metadata definition or null if not found

getMetadataPaths

public Set<String> getMetadataPaths(MetadataSet metadataSet)

Get a flat map of MetadataDefinition corresponding to a metadataset of a content

Parameters:

metadataSet - The metadataset to get

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataPaths

protected Set<String> getMetadataPaths(AbstractMetadataSetElement metadataSet,
                                       String prefix)

Get a flat map of metadatadefinition corresponding to a metadataset of a content

Parameters:

metadataSet - The metadataset to get

prefix - The metadata path of the parent

Returns:

The flat map of metadatapath and metadatadefinition

getMetadataDefinition

public MetadataDefinition getMetadataDefinition(String metadataPath,
                                                Content content)

Retrieve the metadata definition represented by the given path. The path can represent a metadata on another content.

Parameters:

metadataPath - the metadata path separated by '/'

content - The content.

Returns:

the metadata definition or null.

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(Set<String> metadataPaths,
                                                             Content content)

Get a flat map of MetadataDefinition corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

content - The content associated

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(MetadataSet metadataSet,
                                                             Content content)

Get a flat map of MetadataDefinition corresponding to a metadataSet

Parameters:

metadataSet - A metadataSet to analyse

content - The content associated

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitionPath

public List<MetadataDefinition> getMetadataDefinitionPath(String metadataPath,
                                                          Content content)

Retrieve the list of successive metadata definitions represented by the given path. The path can represent a metadata on another content.

Parameters:

metadataPath - the metadata path separated by '/'

content - The content.

Returns:

the list of metadata definitions, one by path element.

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(Set<String> metadataPaths,
                                                                        Content content)

Get a flat map of MetadataDefinition path corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

content - The content associated

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(MetadataSet metadataSet,
                                                                        Content content)

Get a flat map of MetadataDefinition path corresponding to a metadataset

Parameters:

metadataSet - A metadataset to analyse

content - The content associated

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

getMetadataDefinition

public MetadataDefinition getMetadataDefinition(String metadataPath,
                                                String[] cTypes,
                                                String[] mixins)

Retrieve the metadata definition represented by the given path. The path can represent a metadata on another content.

Parameters:

metadataPath - the metadata path separated by '/'

cTypes - The content types.

mixins - The content mixins types.

Returns:

the metadata definition or null.

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(Set<String> metadataPaths,
                                                             String[] cTypes,
                                                             String[] mixins)

Get a flat map of MetadataDefinition corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

cTypes - The content types.

mixins - The content mixins types.

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(MetadataSet metadataSet,
                                                             String[] cTypes,
                                                             String[] mixins)

Get a flat map of MetadataDefinition corresponding to a metadataset

Parameters:

metadataSet - A metadataset to analyse

cTypes - The content types.

mixins - The content mixins types.

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(MetadataDefinitionHolder metaDefHolder,
                                                             Predicate<MetadataDefinition> predicate)

Get a flat map of MetadataDefinition corresponding to the required predicate (boolean-valued function) For example, to get all metadata definitions of type CONTENT, we can do: getMetadataDefinitions(contentType, m -> m.getType() == MetadataType.CONTENT)

Parameters:

metaDefHolder - The metadata definition holder

predicate - The predicate (ex. m -> m.getType() == MetadataType.CONTENT)

Returns:

The flat map of metadata's path and their definition

getMetadataDefinitionPath

public List<MetadataDefinition> getMetadataDefinitionPath(String metadataPath,
                                                          String[] cTypes,
                                                          String[] mixins)

Retrieve the list of successive metadata definitions represented by the given path. The path can represent a metadata on another content.

Parameters:

metadataPath - the metadata path separated by '/'

cTypes - The id of content types

mixins - The id of mixins

Returns:

the metadata definition or null if not found

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(Set<String> metadataPaths,
                                                                        String[] cTypes,
                                                                        String[] mixins)

Get a flat map of MetadataDefinition path corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

cTypes - The id of content types

mixins - The id of mixins

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(MetadataSet metadataSet,
                                                                        String[] cTypes,
                                                                        String[] mixins)

Get a flat map of MetadataDefinition path corresponding to a metadataset

Parameters:

metadataSet - A metadataset to analyse

cTypes - The id of content types

mixins - The id of mixins

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

getMetadataDefinition

public MetadataDefinition getMetadataDefinition(String metadataPath,
                                                ContentType initialContentType)

Retrieves a metadata definition from a path. The metadata can be defined in a referenced or sub content.

Parameters:

metadataPath - the metadata path separated by '/'

initialContentType - The initial content type to start the search

Returns:

the metadata definition or null if not found

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(Set<String> metadataPaths,
                                                             ContentType initialContentType)

Get a flat map of MetadataDefinition corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

initialContentType - The initial content type to start the search

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(MetadataSet metadataSet,
                                                             ContentType initialContentType)

Get a flat map of MetadataDefinition corresponding to a metadataset

Parameters:

metadataSet - A metadataset to analyse

initialContentType - The initial content type to start the search

Returns:

The flat map of metadatapath and MetadataDefinition

getMetadataDefinitionPath

public List<MetadataDefinition> getMetadataDefinitionPath(String metadataPath,
                                                          ContentType initialContentType)

Retrieve the list of successive metadata definitions represented by the given path. The path can represent a metadata on another content.

Parameters:

initialContentType - The initial content type to start the search

metadataPath - the metadata path separated by '/'

Returns:

the list of metadata definitions, one by path element.

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(Set<String> metadataPaths,
                                                                        ContentType initialContentType)

Get a flat map of MetadataDefinition path corresponding to a set of metadata paths

Parameters:

metadataPaths - A set of metadata path to analyse

initialContentType - The initial content type to start the search

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

getMetadataDefinitionsPaths

public Map<String,List<MetadataDefinition>> getMetadataDefinitionsPaths(MetadataSet metadataSet,
                                                                        ContentType initialContentType)

Get a flat map of MetadataDefinition path corresponding to a metadataSet

Parameters:

metadataSet - A semetadataSet to analyse

initialContentType - The initial content type to start the search

Returns:

The flat map of metadatapath and corresponding list of MetadataDefinition path

isCompatibleContentType

public boolean isCompatibleContentType(Content content,
                                       String cTypeId)

Determines if the given content type can be added to content

Parameters:

content - The content

cTypeId - The id of content type

Returns:

true if the content type is compatible with content

getMetadataDefinitions

public Map<String,MetadataDefinition> getMetadataDefinitions(String[] cTypes)
                                                      throws ConfigurationException

Retrieves all definitions of a metadata resulting of the concatenation of metadata of given content types.

Parameters:

cTypes - The id of content types

Returns:

the metadata definitions

Throws:

ConfigurationException - if an error occurred

getCommonMetadataDefinitions

public Map<String,MetadataDefinition> getCommonMetadataDefinitions(Collection<String> cTypeIds,
                                                                   String metadataSetName,
                                                                   boolean isEdition)

Retrieves the common metadata definitions for a list of content types

Parameters:

cTypeIds - The list of content types to consider

metadataSetName - The metadata set name to list metadata

isEdition - Is the metadata set for edition (or for view)

Returns:

The map of metadata definition. Key are the metadata path in the content type

_getMetadataDefinitionsAcc

protected void _getMetadataDefinitionsAcc(Map<String,MetadataDefinition> internalAcc,
                                          AbstractMetadataSetElement metadataSetElement,
                                          String prefix,
                                          MetadataDefinitionHolder metaDefHolder)

Populate the accumulator with the metadata definition

Parameters:

internalAcc - the accumulator of metadata definition

metadataSetElement - the metadata set of the content

prefix - the path prefix preceding the names of the metadata

metaDefHolder - the holder of the metadata definitions for the content

_getMetadataSet

protected MetadataSet _getMetadataSet(ContentType contentType,
                                      String metadataSetName,
                                      boolean isEdition)

Get the metadataset of a content given the parameters

Parameters:

contentType - The content type to consider

metadataSetName - The metadata set to get (that list the metadata to consider)

isEdition - Is the metadata set for edition (or for view)

Returns:

The metadataset

getContentTypesInformations

public Set<Map<String,Object>> getContentTypesInformations()

Get information on content types.

Returns:

A Map with content types

getContentTypesList

public Map<String,Object> getContentTypesList(List<String> ids,
                                              boolean inherited,
                                              boolean checkRights,
                                              boolean includePrivate,
                                              boolean includeMixins,
                                              boolean includeAbstract)

Get information on content types.

Parameters:

ids - The id of content types to retrieve

inherited - If true, the sub-types will be also returned.

checkRights - If true, only content types allowed for creation will be returned

includePrivate - If true, the list will include the private content types. By default the list is restricted to the public content types.

includeMixins - If true the list will include the mixins content types.

includeAbstract - If true the list will include the abstract content types.

Returns:

A Map with retrieved, unknown, not-allowed and private content types

_dispatchContentTypes

private Map<String,Object> _dispatchContentTypes(boolean checkRights,
                                                 boolean includePrivate,
                                                 boolean includeMixins,
                                                 boolean includeAbstract,
                                                 Collection<String> allContentTypesIds)

getContentTypeProperties

public Map<String,Object> getContentTypeProperties(ContentType contentType)

Get the content type properties

Parameters:

contentType - The content type

Returns:

The content type properties

_hasRight

protected boolean _hasRight(ContentType contentType)

Test if the current user has the right needed by the content type to create a content.

Parameters:

contentType - The content type

Returns:

true if the user has the right needed, false otherwise.

_addIfNotPresent

private void _addIfNotPresent(Collection<String> collection,
                              String value)

canRead

public boolean canRead(Content content,
                       MetadataDefinition metadataDef)

Determine whether a metadata can be read at this time.

Parameters:

metadataDef - the metadata definition

content - The content where metadata is to be read on.

Returns:

true if the current user is allowed to read the metadata of this content.

Throws:

AmetysRepositoryException - if an error occurs while accessing the content.

canWrite

public boolean canWrite(Content content,
                        MetadataDefinition metadataDef)

Determine whether a metadata can be read at this time.

Parameters:

metadataDef - the metadata definition

content - The content where metadata is to be read on.

Returns:

true if the current user is allowed to read the metadata of this content.

Throws:

AmetysRepositoryException - if an error occurs while accessing the content.

getContentTypeIdForRendering

public String getContentTypeIdForRendering(Content content)

Get the id of content type to use for rendering

Parameters:

content - The content

Returns:

the id of dynamic or standard content type

getContentTypePluginForRendering

public String getContentTypePluginForRendering(Content content)

Get the plugin name of content type to use for rendering

Parameters:

content - The content

Returns:

the plugin name of dynamic or standard content type

getContentTypeLabel

public I18nizableText getContentTypeLabel(Content content)

Retrieves the label of the content type.

Parameters:

content - The content

Returns:

the label.

getContentTypeDescription

public I18nizableText getContentTypeDescription(Content content)

Retrieves the description of the content type.

Parameters:

content - The content

Returns:

the label.

getContentTypeDefaultTitle

public I18nizableText getContentTypeDefaultTitle(Content content)

Retrieves the default title of the content type.

Parameters:

content - The content

Returns:

the label.

getContentTypeCategory

public I18nizableText getContentTypeCategory(Content content)

Retrieves the category of the content type.

Parameters:

content - The content

Returns:

the label.

getIconGlyph

public String getIconGlyph(Content content)

Retrieves the CSS class to use as glyph icon of the content

Parameters:

content - The content

Returns:

the glyph

getIconDecorator

public String getIconDecorator(Content content)

Retrieves the CSS class to use as decorator above the main icon

Parameters:

content - The content

Returns:

the decorator CSS class name

getSmallIcon

public String getSmallIcon(Content content)

Retrieves the URL of the icon without the context path.

Parameters:

content - The content

Returns:

the icon URL for the small image 16x16.

getMediumIcon

public String getMediumIcon(Content content)

Retrieves the URL of the icon without the context path.

Parameters:

content - The content

Returns:

the icon URL for the medium image 32x32.

getLargeIcon

public String getLargeIcon(Content content)

Retrieves the URL of the icon without the context path.

Parameters:

content - The content

Returns:

the icon URL for the large image 48x48.

getFirstContentType

public ContentType getFirstContentType(Content content)

Get the content type which determines the content icons and rendering

Parameters:

content - The content

Returns:

The main content type

getTitleMetadataDefinition

public static MetadataDefinition getTitleMetadataDefinition()

Get the metadata definition for the "title" standard metadata.

Returns:

The standard title metadata definition.

_getCacheIdentifier

private String _getCacheIdentifier(String[] contentTypes,
                                   String[] mixins)