org.ametys.cms.content

Class ContentHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.content.ContentHelper

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class ContentHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for Content

Field Summary

Fields

Modifier and Type	Field and Description
private ContentTypeExtensionPoint	_contentTypeEP
private ContentTypesHelper	_contentTypesHelper
private CurrentUserProvider	_currentUserProvider
private ObservationManager	_observationManager
private AmetysObjectResolver	_resolver
private UserHelper	_userHelper
private WorkflowProvider	_workflowProvider
static String	ROLE The component role.

Constructor Summary

Constructors

Constructor and Description
ContentHelper()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_setContentType(String contentId, String contentTypeId, int actionId, boolean remove)
private Map<String,Object>	_setMixinType(String contentId, String mixinId, int actionId, boolean remove)
Map<String,Object>	addContentType(String contentId, String contentTypeId, int actionId) Add a content type to an existing content
Map<String,Object>	addMixinType(String contentId, String mixinId, int actionId) Add a mixin type to an existing content
protected Object	getBinaryValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a binary metadata value from a composite metadata.
protected Object	getBooleanValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a boolean metadata value from a composite metadata.
protected void	getCompositeMetadataValues(Content currentContent, CompositeMetadata metaHolder, MetadataDefinition definition, String metaName, String remainingPath, boolean allowsNullValues, List<Object> values) Get the values of a metadata reference in a specified content. The metadata can be in the content or in another linked content (directly or transitively).
Map<String,Object>	getContentEditionInformation(String contentId) Get content edition information.
protected void	getContentMetadataValues(CompositeMetadata metaHolder, String metaName, String remainingPath, boolean allowsNullValues, List<Object> values, MetadataType type) Get the values of a metadata reference in a specified content. The metadata can be in the content or in another linked content (directly or transitively).
protected Object	getContentReferenceValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a content reference metadata value from a composite metadata.
protected Object	getDateValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a Date metadata value from a composite metadata.
protected Object	getDoubleValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a double metadata value from a composite metadata.
protected Map<String,Object>	getEnumeratedValueMap(Enumerator enumerator, String value) Build a map representing an enumerator entry (value and label).
protected Object	getFileValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a file metadata value from a composite metadata.
protected Object	getGeocodeValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a geocode metadata value from a composite metadata.
protected Object	getLongValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a long metadata value from a composite metadata.
Object	getMetadataValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a metadata value from a composite metadata.
Object	getMetadataValue(Content content, String metadataPath) Get the value of a metadata on a given content.
Map<String,Object>	getMetadataValues(Content content, Collection<String> metadataPaths) Get metadata values by their path
protected void	getMetadataValues(Content currentContent, CompositeMetadata metaHolder, MetadataDefinition definition, String metaName, String remainingPath, boolean allowsNullValues, List<Object> values) Get the values of a metadata reference in a specified content. The metadata can be in the content or in another linked content (directly or transitively).
List<Object>	getMetadataValues(Content content, String metadataPath) Get the values of a metadata on a given content.
List<Object>	getMetadataValues(Content content, String metadataPath, boolean allowsNullValues) Get the values of a metadata on a given content.
protected void	getMetadataValues(Content content, String fullMetaPath, boolean allowsNullValues, List<Object> values) Get the values of a metadata reference in a specified content. The metadata can be in the content or in another linked content (directly or transitively).
Map<String,Object>	getMetadataValues(String contentId, Collection<String> metadataPath) Get metadata values by their path
protected Object	getReferenceValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a reference metadata value from a composite metadata.
protected Object	getResourceFileValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a resource-file metadata value from a composite metadata.
protected RichText	getRichTextValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a string (HTML format) reprensenting the rich text metadata value from a composite metadata.
protected Object	getStringValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a string metadata value from a composite metadata.
protected Object	getSubcontentValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a sub-content metadata value from a composite metadata.
protected Object	getUserValue(CompositeMetadata metaHolder, String name, MetadataDefinition definition) Get a user metadata value from a composite metadata.
boolean	hasIndexingReferences(Content content) Test if the given content has indexing references, i.e.
boolean	isSimple(Content content) Determines if the content is a simple content type
Map<String,Object>	removeContentType(String contentId, String contentTypeId, int actionId) Remove a content type to an existing content
Map<String,Object>	removeMixinType(String contentId, String mixinId, int actionId) Remove a mixin type to an existing content
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 component role.

_resolver

private AmetysObjectResolver _resolver

_contentTypesHelper

private ContentTypesHelper _contentTypesHelper

_contentTypeEP

private ContentTypeExtensionPoint _contentTypeEP

_observationManager

private ObservationManager _observationManager

_workflowProvider

private WorkflowProvider _workflowProvider

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_userHelper

private UserHelper _userHelper

Constructor Detail

ContentHelper

public ContentHelper()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

addContentType

public Map<String,Object> addContentType(String contentId,
                                         String contentTypeId,
                                         int actionId)
                                  throws AmetysRepositoryException,
                                         com.opensymphony.workflow.WorkflowException

Add a content type to an existing content

Parameters:

contentId - The content id

contentTypeId - The content type to add

actionId - The workflow action id

Returns:

The result in a Map

Throws:

com.opensymphony.workflow.WorkflowException - if

AmetysRepositoryException - if an error occurred

removeContentType

public Map<String,Object> removeContentType(String contentId,
                                            String contentTypeId,
                                            int actionId)
                                     throws AmetysRepositoryException,
                                            com.opensymphony.workflow.WorkflowException

Remove a content type to an existing content

Parameters:

contentId - The content id

contentTypeId - The content type to add

actionId - The workflow action id

Returns:

The result in a Map

Throws:

com.opensymphony.workflow.WorkflowException - if

AmetysRepositoryException - if an error occurred

addMixinType

public Map<String,Object> addMixinType(String contentId,
                                       String mixinId,
                                       int actionId)
                                throws AmetysRepositoryException,
                                       com.opensymphony.workflow.WorkflowException

Add a mixin type to an existing content

Parameters:

contentId - The content id

mixinId - The mixin type to add

actionId - The workflow action id

Returns:

The result in a Map

Throws:

com.opensymphony.workflow.WorkflowException - if

AmetysRepositoryException - if an error occurred

removeMixinType

public Map<String,Object> removeMixinType(String contentId,
                                          String mixinId,
                                          int actionId)
                                   throws AmetysRepositoryException,
                                          com.opensymphony.workflow.WorkflowException

Remove a mixin type to an existing content

Parameters:

contentId - The content id

mixinId - The mixin type to add

actionId - The workflow action id

Returns:

The result in a Map

Throws:

com.opensymphony.workflow.WorkflowException - if

AmetysRepositoryException - if an error occurred

getMetadataValues

public Map<String,Object> getMetadataValues(String contentId,
                                            Collection<String> metadataPath)

Get metadata values by their path

Parameters:

contentId - The id of content

metadataPath - The path of metadata to retrieve

Returns:

The metadata values

getMetadataValues

public Map<String,Object> getMetadataValues(Content content,
                                            Collection<String> metadataPaths)

Get metadata values by their path

Parameters:

content - The content.

metadataPaths - The path of metadata to retrieve, slash-separated.

Returns:

The metadata values

getMetadataValue

public Object getMetadataValue(Content content,
                               String metadataPath)

Get the value of a metadata on a given content. The metadata can be held by a linked content.

Parameters:

content - The content.

metadataPath - The metadata path, slash-separated. It can represent a property on one or more linked contents, i.e. "composite/linkedContent/secondContent/title".

Returns:

The metadata value.

getMetadataValues

public List<Object> getMetadataValues(Content content,
                                      String metadataPath)

Get the values of a metadata on a given content. The metadata can be held by a linked content.

Parameters:

content - The content.

metadataPath - The metadata path, slash-separated. It can represent a property on one or more linked contents, i.e. "composite/linkedContent/secondContent/title".

Returns:

The metadata values as a List.

getMetadataValues

public List<Object> getMetadataValues(Content content,
                                      String metadataPath,
                                      boolean allowsNullValues)

Get the values of a metadata on a given content. The metadata can be held by a linked content.

Parameters:

content - The content.

metadataPath - The metadata path, slash-separated. It can represent a property on one or more linked contents, i.e. "composite/linkedContent/secondContent/title".

allowsNullValues - If true, empty values will be added to the list as "null"

Returns:

The metadata values as a List.

getMetadataValues

protected void getMetadataValues(Content content,
                                 String fullMetaPath,
                                 boolean allowsNullValues,
                                 List<Object> values)

Get the values of a metadata reference in a specified content.
The metadata can be in the content or in another linked content (directly or transitively).

Parameters:

content - The content.

fullMetaPath - The full metadata path (separated by '/').

allowsNullValues - If true, empty values will be added to the list as "null"

values - The list of values to be filled by this method.

getMetadataValues

protected void getMetadataValues(Content currentContent,
                                 CompositeMetadata metaHolder,
                                 MetadataDefinition definition,
                                 String metaName,
                                 String remainingPath,
                                 boolean allowsNullValues,
                                 List<Object> values)

Get the values of a metadata reference in a specified content.
The metadata can be in the content or in another linked content (directly or transitively).

Parameters:

currentContent - The content currently being browsed.

metaHolder - The current metadata holder, must in some way possess the "metaName" metadata.

definition - The current metadata definition.

metaName - The metadata name.

remainingPath - The remaining path, can be empty.

allowsNullValues - If true, empty values will be added to the list as "null"

values - The list of values to be filled by this method.

getCompositeMetadataValues

protected void getCompositeMetadataValues(Content currentContent,
                                          CompositeMetadata metaHolder,
                                          MetadataDefinition definition,
                                          String metaName,
                                          String remainingPath,
                                          boolean allowsNullValues,
                                          List<Object> values)

Get the values of a metadata reference in a specified content.
The metadata can be in the content or in another linked content (directly or transitively).

Parameters:

currentContent - The content currently being browsed.

metaHolder - The current metadata holder, must in some way possess the "metaName" metadata.

definition - The current metadata definition.

metaName - The metadata name.

remainingPath - The remaining path, can be empty.

allowsNullValues - If true, empty values will be added to the list as "null"

values - The list of values to be filled by this method.

getContentMetadataValues

protected void getContentMetadataValues(CompositeMetadata metaHolder,
                                        String metaName,
                                        String remainingPath,
                                        boolean allowsNullValues,
                                        List<Object> values,
                                        MetadataType type)

Get the values of a metadata reference in a specified content.
The metadata can be in the content or in another linked content (directly or transitively).

Parameters:

metaHolder - The current metadata holder, must in some way possess the "metaName" metadata.

metaName - The metadata name.

remainingPath - The remaining path, can be empty.

allowsNullValues - If true, empty values will be added to the list as "null"

values - The list of values to be filled by this method.

type - The metadata type

getContentEditionInformation

public Map<String,Object> getContentEditionInformation(String contentId)

Get content edition information.

Parameters:

contentId - the content ID.

Returns:

a Map containing content edition information.

hasIndexingReferences

public boolean hasIndexingReferences(Content content)

Test if the given content has indexing references, i.e. if modifying it potentially implies reindexing other contents.

Parameters:

content - the content to test.

Returns:

true if one of the content types or mixins has indexing references, false otherwise.

_setContentType

private Map<String,Object> _setContentType(String contentId,
                                           String contentTypeId,
                                           int actionId,
                                           boolean remove)
                                    throws AmetysRepositoryException,
                                           com.opensymphony.workflow.WorkflowException

Throws:

AmetysRepositoryException

com.opensymphony.workflow.WorkflowException

_setMixinType

private Map<String,Object> _setMixinType(String contentId,
                                         String mixinId,
                                         int actionId,
                                         boolean remove)
                                  throws AmetysRepositoryException,
                                         com.opensymphony.workflow.WorkflowException

Throws:

AmetysRepositoryException

com.opensymphony.workflow.WorkflowException

getMetadataValue

public Object getMetadataValue(CompositeMetadata metaHolder,
                               String name,
                               MetadataDefinition definition)

Get a metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name (path forbidden).

definition - the metadata definition.

Returns:

the metadata value.

getStringValue

protected Object getStringValue(CompositeMetadata metaHolder,
                                String name,
                                MetadataDefinition definition)

Get a string metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a String or String List.

getEnumeratedValueMap

protected Map<String,Object> getEnumeratedValueMap(Enumerator enumerator,
                                                   String value)

Build a map representing an enumerator entry (value and label).

Parameters:

enumerator - the metadata enumerator.

value - the value to generate.

Returns:

a Map representing the enumerator entry (value and label).

getLongValue

protected Object getLongValue(CompositeMetadata metaHolder,
                              String name,
                              MetadataDefinition definition)

Get a long metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a long or Long List.

getDoubleValue

protected Object getDoubleValue(CompositeMetadata metaHolder,
                                String name,
                                MetadataDefinition definition)

Get a double metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a double or Double List.

getBooleanValue

protected Object getBooleanValue(CompositeMetadata metaHolder,
                                 String name,
                                 MetadataDefinition definition)

Get a boolean metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a boolean or Boolean List.

getDateValue

protected Object getDateValue(CompositeMetadata metaHolder,
                              String name,
                              MetadataDefinition definition)

Get a Date metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Date or Date List.

getUserValue

protected Object getUserValue(CompositeMetadata metaHolder,
                              String name,
                              MetadataDefinition definition)

Get a user metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Map or List of Map.

getBinaryValue

protected Object getBinaryValue(CompositeMetadata metaHolder,
                                String name,
                                MetadataDefinition definition)

Get a binary metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Map.

getFileValue

protected Object getFileValue(CompositeMetadata metaHolder,
                              String name,
                              MetadataDefinition definition)

Get a file metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Map.

getResourceFileValue

protected Object getResourceFileValue(CompositeMetadata metaHolder,
                                      String name,
                                      MetadataDefinition definition)

Get a resource-file metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Map.

getGeocodeValue

protected Object getGeocodeValue(CompositeMetadata metaHolder,
                                 String name,
                                 MetadataDefinition definition)

Get a geocode metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a Map.

getRichTextValue

protected RichText getRichTextValue(CompositeMetadata metaHolder,
                                    String name,
                                    MetadataDefinition definition)

Get a string (HTML format) reprensenting the rich text metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

The richtext object

getReferenceValue

protected Object getReferenceValue(CompositeMetadata metaHolder,
                                   String name,
                                   MetadataDefinition definition)

Get a reference metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a List (if multiple) or Map (if single metadata)

getContentReferenceValue

protected Object getContentReferenceValue(CompositeMetadata metaHolder,
                                          String name,
                                          MetadataDefinition definition)

Get a content reference metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a List of content ID.

getSubcontentValue

protected Object getSubcontentValue(CompositeMetadata metaHolder,
                                    String name,
                                    MetadataDefinition definition)

Get a sub-content metadata value from a composite metadata.

Parameters:

metaHolder - the composite metadata.

name - the metadata name.

definition - the metadata definition.

Returns:

the metadata value as a List of content ID.

isSimple

public boolean isSimple(Content content)

Determines if the content is a simple content type

Parameters:

content - The content

Returns:

true if content is simple