org.ametys.cms.clientsideelement.relations

Class SetContentMetadataClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.StaticClientSideRelation

org.ametys.cms.clientsideelement.relations.SetContentMetadataClientSideElement

All Implemented Interfaces:

ClientSideElement, ClientSideRelation, LogEnabled, PluginAware, Component, Configurable, Serviceable

Direct Known Subclasses:

SetContentMetadataClientSideElement, SetParentContentClientSideElement

public class SetContentMetadataClientSideElement
extends StaticClientSideRelation
implements Component

Set the metadata of type 'content' of a content, with another content

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentHelper	_contentHelper The content helper
protected ContentWorkflowHelper	_contentWorkflowHelper The content workflow helper
protected ContentTypeExtensionPoint	_ctypesEP The content types extension point
protected ContentTypesHelper	_ctypesHelper The content type helper
protected FilterCompatibleContentMetadataExtensionPoint	_filterCompatibleContentMetadataExtensionPoint The EP to filter meta
protected AmetysObjectResolver	_resolver The Ametys object resolver

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor and Description
SetContentMetadataClientSideElement()

Method Summary

Modifier and Type	Method and Description
private void	_clean(List<Map<String,String>> contentsToEditToRemove, List<String> workflowActionIds, List<I18nizableText> errorMessages, List<String> errorIds)
protected Map<String,Object>	_convert(MetadataDefinition metadatadef) Convert a metadata definition to JSON
protected List<Map<String,Object>>	_convert(Set<MetadataDefinition> metadatadefs) Convert metadata definitions to JSON object
private void	_doAction(WorkflowAwareContent content, List<String> workflowActionIds, Map<String,Object> values, List<String> errorIds, List<I18nizableText> errorMessages)
protected Set<MetadataDefinition>	_findCompatibleMetadata(List<Content> contentToReference, List<Content> contentToEdit) Find the list of compatible metadata definition
private Set<MetadataDefinition>	_findCompatibleMetadata(List<Content> contentToReference, List<Content> contentToEdit, String targetContentTypeName, MetadataDefinition metaDef, boolean anyParentIsMultiple, Collection<String> compatibleContentTypes, boolean requiresMultiple)
private boolean	_hasRight(List<Content> contentToEdit, MetadataDefinition metaDef)
private List<String>	_reorder(List<String> currentElements, List<String> elementsToReorder, int newPosition)
protected List<? extends Content>	_resolve(List<String> contentIds) Resolve content by their ids
protected Map<? extends Content,Integer>	_resolve(Map<String,Integer> contentIds) Resolve content by their ids
private Map<String,Object>	_returnValue(List<I18nizableText> errorMessages, List<String> errorIds)
protected void	_setContentMetatada(List<String> contentIdsToReference, Map<WorkflowAwareContent,Integer> contentToEdit, ContentType contentType, String metadataPath, List<String> workflowActionIds, List<I18nizableText> errorMessages, List<String> errorIds, Map<String,Object> additionalParams) Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'
Map<String,Object>	getCompatibleMetadata(List<String> contentIdsToReference, List<String> contentIdsToEdit) Find a metadata of type content in definition of 'contentIdsToReference' and set the metadata of contents 'contentIdsToEdit' with value 'contentIdsToReference'
void	service(ServiceManager manager)
Map<String,Object>	setContentMetatada(List<String> contentIdsToReference, Map<String,Integer> contentIdsToEdit, List<Map<String,String>> contentsToEditToRemove, String metadatapath, List<String> workflowActionIds) Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'
Map<String,Object>	setContentMetatada(List<String> contentIdsToReference, Map<String,Integer> contentIdsToEdit, List<Map<String,String>> contentsToEditToRemove, String metadatapath, List<String> workflowActionIds, Map<String,Object> additionalParams) Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'

Methods inherited from class org.ametys.core.ui.StaticClientSideRelation

configure, getSourceRelationType, getTargetRelationType

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.core.ui.ClientSideElement

getDependencies, getId, getPluginName, getRights, getScripts, getScripts

Field Detail

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_ctypesHelper

protected ContentTypesHelper _ctypesHelper

The content type helper

_ctypesEP

protected ContentTypeExtensionPoint _ctypesEP

The content types extension point

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

_filterCompatibleContentMetadataExtensionPoint

protected FilterCompatibleContentMetadataExtensionPoint _filterCompatibleContentMetadataExtensionPoint

The EP to filter meta

_contentHelper

protected ContentHelper _contentHelper

The content helper

Constructor Detail

SetContentMetadataClientSideElement

public SetContentMetadataClientSideElement()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getCompatibleMetadata

public Map<String,Object> getCompatibleMetadata(List<String> contentIdsToReference,
                                                List<String> contentIdsToEdit)

Find a metadata of type content in definition of 'contentIdsToReference' and set the metadata of contents 'contentIdsToEdit' with value 'contentIdsToReference'

Parameters:

contentIdsToReference - The list of content ids that will be added as values in the content field

contentIdsToEdit - The list of content ids to edit and that will have a metadata of type content modified

Returns:

A map with key success: true or false. if false, it can be due to errors (list of error messages) or because metadata cannot be determined then 'metadata' is a list of possible metadata

_convert

protected List<Map<String,Object>> _convert(Set<MetadataDefinition> metadatadefs)

Convert metadata definitions to JSON object

Parameters:

metadatadefs - The metadata definitions

Returns:

the JSON object

_convert

protected Map<String,Object> _convert(MetadataDefinition metadatadef)

Convert a metadata definition to JSON

Parameters:

metadatadef - the metadata definition

Returns:

the JSON object

_findCompatibleMetadata

protected Set<MetadataDefinition> _findCompatibleMetadata(List<Content> contentToReference,
                                                          List<Content> contentToEdit)

Find the list of compatible metadata definition

Parameters:

contentToReference - the contents to reference

contentToEdit - the contents to edit

Returns:

the list of compatible metadata definition

_findCompatibleMetadata

private Set<MetadataDefinition> _findCompatibleMetadata(List<Content> contentToReference,
                                                        List<Content> contentToEdit,
                                                        String targetContentTypeName,
                                                        MetadataDefinition metaDef,
                                                        boolean anyParentIsMultiple,
                                                        Collection<String> compatibleContentTypes,
                                                        boolean requiresMultiple)

_hasRight

private boolean _hasRight(List<Content> contentToEdit,
                          MetadataDefinition metaDef)

setContentMetatada

public Map<String,Object> setContentMetatada(List<String> contentIdsToReference,
                                             Map<String,Integer> contentIdsToEdit,
                                             List<Map<String,String>> contentsToEditToRemove,
                                             String metadatapath,
                                             List<String> workflowActionIds)

Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'

Parameters:

contentIdsToReference - The list of content ids that will be added as values in the content field

contentIdsToEdit - The map {key: content ids to edit and that will have a metadata of type content modified; value: the new position if metadata is multiple and it is a reorder of values. May be null or equals to -1 if it is not a reorder}

contentsToEditToRemove - The list of content to edit to remove currently referenced content. Keys are "contentId" and "valueToRemove"

metadatapath - The metadata path selected to do modification in the contentIdsToEdit contents

workflowActionIds - The ids of workflow actions to use to edit the metadata. Actions will be tested in this order and first available action will be used

Returns:

A map with key success: true or false. if false, it can be due to errors (list of error messages)

setContentMetatada

public Map<String,Object> setContentMetatada(List<String> contentIdsToReference,
                                             Map<String,Integer> contentIdsToEdit,
                                             List<Map<String,String>> contentsToEditToRemove,
                                             String metadatapath,
                                             List<String> workflowActionIds,
                                             Map<String,Object> additionalParams)

Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'

Parameters:

contentIdsToReference - The list of content ids that will be added as values in the content field

contentIdsToEdit - The map {key: content ids to edit and that will have a metadata of type content modified; value: the new position if metadata is multiple and it is a reorder of values. May be null or equals to -1 if it is not a reorder}

contentsToEditToRemove - The list of content to edit to remove currently referenced content. Keys are "contentId" and "valueToRemove"

metadatapath - The metadata path selected to do modification in the contentIdsToEdit contents

workflowActionIds - The ids of workflow actions to use to edit the metadata. Actions will be tested in this order and first available action will be used

additionalParams - the map of additional parameters

Returns:

A map with key success: true or false. if false, it can be due to errors (list of error messages)

_returnValue

private Map<String,Object> _returnValue(List<I18nizableText> errorMessages,
                                        List<String> errorIds)

_clean

private void _clean(List<Map<String,String>> contentsToEditToRemove,
                    List<String> workflowActionIds,
                    List<I18nizableText> errorMessages,
                    List<String> errorIds)

_setContentMetatada

protected void _setContentMetatada(List<String> contentIdsToReference,
                                   Map<WorkflowAwareContent,Integer> contentToEdit,
                                   ContentType contentType,
                                   String metadataPath,
                                   List<String> workflowActionIds,
                                   List<I18nizableText> errorMessages,
                                   List<String> errorIds,
                                   Map<String,Object> additionalParams)

Set the metadata 'metadatapath' of contents 'contentIdsToEdit' with value 'contentIdsToReference'

Parameters:

contentIdsToReference - The list of content ids that will be added as values in the content field

contentToEdit - The map {key: contents to edit and that will have a metadata of type content modified; value: the new position if metadata is multiple and it is a reorder of values. May be null or equals to -1 if it is not a reorder}

contentType - The content type

metadataPath - The metadata selected to do modification in the contentIdsToEdit contents

workflowActionIds - The ids of workflow actions to use to edit the metadata. Actions will be tested in this order and first available action will be used

errorMessages - The list that will be felt with error messages of content that had an issue during the operation

errorIds - The list that will be felt with ids of content that had an issue during the operation

additionalParams - the map of additional parameters

_reorder

private List<String> _reorder(List<String> currentElements,
                              List<String> elementsToReorder,
                              int newPosition)

_doAction

private void _doAction(WorkflowAwareContent content,
                       List<String> workflowActionIds,
                       Map<String,Object> values,
                       List<String> errorIds,
                       List<I18nizableText> errorMessages)

_resolve

protected List<? extends Content> _resolve(List<String> contentIds)

Resolve content by their ids

Parameters:

contentIds - The id of contents to resolve

Returns:

the contents

_resolve

protected Map<? extends Content,Integer> _resolve(Map<String,Integer> contentIds)

Resolve content by their ids

Parameters:

contentIds - The id of contents to resolve

Returns:

the contents