org.ametys.cms.contenttype

Class GetCommonMetadataAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.cms.contenttype.GetCommonMetadataAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

GetCommonMetadataAction

public class GetCommonMetadataAction
extends ServiceableAction

Get the common metadata set between given content types and/or among given contents

Field Summary

Fields

Modifier and Type	Field and Description
protected static MetadataType[]	__NOT_SORTABLE_TYPE Not sortable metadata types
protected ContentTypesHelper	_contentTypesHelper The content types Helper
protected ContentTypeExtensionPoint	_cTypeEP The content type EP
protected I18nUtils	_i18nUtils I18n utils

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
GetCommonMetadataAction()

Method Summary

Modifier and Type	Method and Description
private List<String>	_getRepeaterChildrenNames(Map<String,MetadataDefinition> metadataDefinitions)
protected boolean	_metadataPassesCondition(MetadataDefinition metadataDefinition, List<String> acceptedTypes, boolean onlySortable, boolean includeComposite, boolean includeSubRepeaters, List<String> subRepeaterMetadataNames) Indicates if the metadata should be retrieved or filtered out given the options
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
protected Set<String>	getAllAvailablesContentTypes(Request request, boolean publicOnly, boolean withResources) Get all the available content types
protected List<Map<String,Object>>	getCommonMetadatasInfo(Collection<String> cTypeIds, String metadataSetName, boolean isEdition, List<String> acceptedTypes, boolean onlySortable, boolean includeComposite, boolean withFullLabel, boolean hasResources, boolean includeSubRepeaters) Retrieve metadata information for a list of content types
protected Set<String>	getContentTypes(Request request, boolean withResources) Get the content types id to search for
protected String	getMetadataFullLabel(Map<String,MetadataDefinition> metadataDefinitions, String name) Get the user friendly full label for the metadata definition with the given name
protected Map<String,Object>	getMetadataInfo(String name, MetadataDefinition metadataDefinition, boolean withFullLabel, Map<String,MetadataDefinition> metadataDefinitions) Get the metadata info
protected void	handleSpecificInfo(List<Map<String,Object>> commonMetadatasInfo, boolean withLastModified, boolean withLastValidation, boolean hasResources, boolean withFullLabel) Handle specific info, such as adding system metadata into the metadata list
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

__NOT_SORTABLE_TYPE

protected static final MetadataType[] __NOT_SORTABLE_TYPE

Not sortable metadata types

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type EP

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types Helper

_i18nUtils

protected I18nUtils _i18nUtils

I18n utils

Constructor Detail

GetCommonMetadataAction

public GetCommonMetadataAction()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Throws:

Exception

getCommonMetadatasInfo

protected List<Map<String,Object>> getCommonMetadatasInfo(Collection<String> cTypeIds,
                                                          String metadataSetName,
                                                          boolean isEdition,
                                                          List<String> acceptedTypes,
                                                          boolean onlySortable,
                                                          boolean includeComposite,
                                                          boolean withFullLabel,
                                                          boolean hasResources,
                                                          boolean includeSubRepeaters)

Retrieve metadata information for a list of content types

Parameters:

cTypeIds - the ids of the content types

metadataSetName - The metadata set name to list metadata

isEdition - Is the metadata set for edition ?

acceptedTypes - The types to accept. All types accepted if null or empty.

onlySortable - true to only accept sortable metadata.

includeComposite - true to include the composite metadata as well

withFullLabel - true to use the full label of the metadata, false otherwise

hasResources - true if there is at least one content type that is a resource, false otherwise.

includeSubRepeaters - true to include the sub metadata of repeater metadata as well

Returns:

The list of common metadata properties (each set of properties is a map representing the metadata)

_getRepeaterChildrenNames

private List<String> _getRepeaterChildrenNames(Map<String,MetadataDefinition> metadataDefinitions)

getMetadataInfo

protected Map<String,Object> getMetadataInfo(String name,
                                             MetadataDefinition metadataDefinition,
                                             boolean withFullLabel,
                                             Map<String,MetadataDefinition> metadataDefinitions)

Get the metadata info

Parameters:

name - the name of the metadata

metadataDefinition - the metadata definition

withFullLabel - true to use the full label of the metadata, false otherwise

metadataDefinitions - the mapping of metadata definitions

Returns:

Metadata info as a map of properties

_metadataPassesCondition

protected boolean _metadataPassesCondition(MetadataDefinition metadataDefinition,
                                           List<String> acceptedTypes,
                                           boolean onlySortable,
                                           boolean includeComposite,
                                           boolean includeSubRepeaters,
                                           List<String> subRepeaterMetadataNames)

Indicates if the metadata should be retrieved or filtered out given the options

Parameters:

metadataDefinition - the metadata definition

acceptedTypes - The types to accept. All types accepted if null or empty.

onlySortable - true to only accept sortable metadata.

includeComposite - true to include the composite metadata as well

includeSubRepeaters - true to include the sub metadata of repeater metadata as well

subRepeaterMetadataNames - The list of metadata names which are children of repeater

Returns:

true if the metadata passes the condition

getMetadataFullLabel

protected String getMetadataFullLabel(Map<String,MetadataDefinition> metadataDefinitions,
                                      String name)

Get the user friendly full label for the metadata definition with the given name

Parameters:

metadataDefinitions - the mapping of metadata definitions

name - the name of the metadata

Returns:

The full label of the metadata

handleSpecificInfo

protected void handleSpecificInfo(List<Map<String,Object>> commonMetadatasInfo,
                                  boolean withLastModified,
                                  boolean withLastValidation,
                                  boolean hasResources,
                                  boolean withFullLabel)

Handle specific info, such as adding system metadata into the metadata list

Parameters:

commonMetadatasInfo - the mapping of metadata properties

withLastModified - true to add the last modification date to the metadata info

withLastValidation - true to add the last validation date to the metadata info

hasResources - true if there is at least one content type that is a resource, false otherwise.

withFullLabel - true to use the full label of the metadata, false otherwise

getContentTypes

protected Set<String> getContentTypes(Request request,
                                      boolean withResources)

Get the content types id to search for

Parameters:

request - the request

withResources - is there at least one resource ?

Returns:

the content types

getAllAvailablesContentTypes

protected Set<String> getAllAvailablesContentTypes(Request request,
                                                   boolean publicOnly,
                                                   boolean withResources)

Get all the available content types

Parameters:

request - the request

publicOnly - Only the non private content types will be returned

withResources - True to add the resources to the list (which is not a content type)

Returns:

all the available content types