Package org.ametys.cms.data.holder

Class DataHolderRelativeDisableConditionsHelper

java.lang.Object

org.ametys.cms.data.holder.DataHolderRelativeDisableConditionsHelper

All Implemented Interfaces:

Component, Serviceable

public class DataHolderRelativeDisableConditionsHelper
extends Object
implements Component, Serviceable

DisableCondition for model aware DataHolder

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__DATA_HOLDER_PARAMETER_KEY	The contextual parameter key for data holder
protected static final String	__OLD_CONDITION_PATH_PARAMETER_KEY	The contextual parameter key for old condition path
static final String	EXPLODED_DISABLE_CONDITIONS	The JSON info containing exploded conditions when a condition points to an element that is in a distant content
static final String	ROLE	The component role.
static final String	SYNCHRONIZATION_CONTEXT_PARAMETER_KEY	The contextual parameter key for synchronization context

Constructor Summary

Constructors

Constructor	Description
DataHolderRelativeDisableConditionsHelper()

Method Summary

Modifier and Type	Method	Description
void	checkModelItemPathSegment(DisableCondition condition, Model model, ModelItem definition, ModelItem segmentModelItem, int segmentIndex, int conditionPathSize)	Check a segment of the condition path
boolean	containsValue(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Check if the values Map contains a value for the condition
Map<String,Object>	getAdditionalContextualParameters(DisableCondition condition, Optional<String> oldDataPath, ModelAwareDataHolder dataHolder)	Retrieves the additional contextual parameters to use to extract values
List<ModelItem>	getAllModelItemsInPathToSystemProperty(DisableCondition condition, String conditionPath, Model model, ModelItem definition, SystemProperty systemProperty)	Retrieves all model items of the given relative path to the system property
SystemProperty	getSystemProperty(ModelItemAccessor modelItemAccessor, String dataPath)	Retrieves the SystemProperty if the given data path represents one
Object	getValueFromMap(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value from the values Map
boolean	isExternal(DisableCondition condition, DefinitionContext context)	Check if the given disable condition is external The condition is external if there is a view in the context and the relative element pointed by the condition is not in the view
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

SYNCHRONIZATION_CONTEXT_PARAMETER_KEY

public static final String SYNCHRONIZATION_CONTEXT_PARAMETER_KEY

The contextual parameter key for synchronization context

See Also:

• Constant Field Values

EXPLODED_DISABLE_CONDITIONS

public static final String EXPLODED_DISABLE_CONDITIONS

The JSON info containing exploded conditions when a condition points to an element that is in a distant content

See Also:

• Constant Field Values

__DATA_HOLDER_PARAMETER_KEY

protected static final String __DATA_HOLDER_PARAMETER_KEY

The contextual parameter key for data holder

See Also:

• Constant Field Values

__OLD_CONDITION_PATH_PARAMETER_KEY

protected static final String __OLD_CONDITION_PATH_PARAMETER_KEY

The contextual parameter key for old condition path

See Also:

• Constant Field Values

Constructor Details

DataHolderRelativeDisableConditionsHelper

public DataHolderRelativeDisableConditionsHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getSystemProperty

public SystemProperty getSystemProperty(ModelItemAccessor modelItemAccessor,
 String dataPath)

Retrieves the SystemProperty if the given data path represents one

Parameters:

modelItemAccessor - the relative accessor to the given data path

dataPath - the data path of the system property to retrieve

Returns:

the system property or null if the given data path does not represent a system property

getAllModelItemsInPathToSystemProperty

public List<ModelItem> getAllModelItemsInPathToSystemProperty(DisableCondition condition,
 String conditionPath,
 Model model,
 ModelItem definition,
 SystemProperty systemProperty)
                                                       throws UndefinedItemPathException,
IllegalArgumentException

Retrieves all model items of the given relative path to the system property

Parameters:

condition - the disable condition

conditionPath - the absolute path of the disable condition

model - the model containing the definition

definition - the model item defining this disable condition

systemProperty - the system property targeted by the condition

Returns:

all model items of the given relative path

Throws:

UndefinedItemPathException - if there is no item defined at the given path

IllegalArgumentException - if the given path is null or empty

checkModelItemPathSegment

public void checkModelItemPathSegment(DisableCondition condition,
 Model model,
 ModelItem definition,
 ModelItem segmentModelItem,
 int segmentIndex,
 int conditionPathSize)
                               throws ConfigurationException

Check a segment of the condition path

Parameters:

condition - the disable condition

model - the model containing the definition

definition - the model item defining this disable condition

segmentModelItem - the model item concerned by the segment

segmentIndex - the index of the segment in the path

conditionPathSize - the number of segments in the condition path

Throws:

ConfigurationException - if the segment can not be used in the condition path

getAdditionalContextualParameters

public Map<String,Object> getAdditionalContextualParameters(DisableCondition condition,
 Optional<String> oldDataPath,
 ModelAwareDataHolder dataHolder)

Retrieves the additional contextual parameters to use to extract values

Parameters:

condition - the disable condition

oldDataPath - the old path of the evaluated data. Needed to get stored value if the data has been moved

dataHolder - the data holder

Returns:

the DefinitionAndValue corresponding to the condition identifier

containsValue

public boolean containsValue(ModelItemAccessor modelItemAccessor,
 String conditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)
                      throws BadItemTypeException

Check if the values Map contains a value for the condition

Parameters:

modelItemAccessor - the relative accessor to the given condition path

conditionDataPath - the absolute data path of the condition

values - the values Map

contextualParameters - the contextual parameters

Returns:

true if there is a value (even empty) for the condition in the values Map, false otherwise

Throws:

BadItemTypeException - if a value does not correspond to the model of given object

getValueFromMap

public Object getValueFromMap(ModelItemAccessor modelItemAccessor,
 String conditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)
                       throws BadItemTypeException

Retrieves the condition value from the values Map

Parameters:

modelItemAccessor - the relative accessor to the given condition path

conditionDataPath - the absolute data path of the condition

values - the values Map

contextualParameters - the contextual parameters

Returns:

the condition value found in the values Map

Throws:

BadItemTypeException - if a value does not correspond to the model of given object

isExternal

public boolean isExternal(DisableCondition condition,
 DefinitionContext context)

Check if the given disable condition is external The condition is external if there is a view in the context and the relative element pointed by the condition is not in the view

Parameters:

condition - the disable condition to check

context - the definition context

Returns:

true if the given disable condition is external, false otherwise