Package org.ametys.cms.data.holder

Class DataHolderDisableConditionsEvaluator<T extends ModelAwareDataHolder>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.model.disableconditions.AbstractDisableConditionsEvaluator<T>

org.ametys.cms.data.holder.DataHolderDisableConditionsEvaluator<T>

Type Parameters:

T - Type of data holder holding the data to evaluate

All Implemented Interfaces:

DisableConditionsEvaluator<T>, LogEnabled, Component, Serviceable

public class DataHolderDisableConditionsEvaluator<T extends ModelAwareDataHolder>
extends AbstractDisableConditionsEvaluator<T>
implements Serviceable

Evaluator for DisableConditions on model aware DataHolder

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.runtime.model.disableconditions.AbstractDisableConditionsEvaluator

AbstractDisableConditionsEvaluator.DefinitionAndValue

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__AMETYS_OBJECT_PARAMETER_KEY	The contextual parameter key for ametys object
protected static final String	__OLD_CONDITION_PATH_PARAMETER_KEY	The contextual parameter key for old condition path
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The system property extension point
static final String	ROLE	The Avalon role
static final String	SYNCHRONIZATION_CONTEXT_PARAMETER_KEY	The contextual parameter key for synchronization context

Constructor Summary

Constructors

Constructor	Description
DataHolderDisableConditionsEvaluator()

Method Summary

Modifier and Type	Method	Description
protected boolean	_containsElementValue(ModelItem definition, String dataName, Map<String,Object> values, Map<String,Object> contextualParameters)	Check if the values Map contains a value for the condition
protected boolean	_doesCompositeContainValue(CompositeDefinition compositeDefinition, String compositeName, String subConditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Check if the values Map contains a value for the condition
protected boolean	_doesRepeaterContainValue(RepeaterDefinition repeaterDefinition, String repeaterNameAndPositionSegment, String subConditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Check if the values Map contains a value for the condition
protected AbstractDisableConditionsEvaluator.DefinitionAndValue	_getConditionDefinitionAndValue(ModelItem definition, DisableCondition condition, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, Optional<T> ametsyObject, Map<String,Object> contextualParameters)	Retrieve the value corresponding to the identifier of the condition, and its type
protected Object	_getElementValueFromMap(ModelItem definition, String dataName, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value from the values Map
protected Object	_getValueFromComposite(CompositeDefinition compositeDefinition, String compositeName, String subConditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value in the given composite, from the values Map
protected Object	_getValueFromContentValue(ContentElementDefinition contentElementDefinition, String dataName, String subConditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value in the given content value, from the values Map
protected Object	_getValueFromRepeater(RepeaterDefinition repeaterDefinition, String repeaterNameAndPositionSegment, String subConditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value in the given repeater, from the values Map
protected Object	_getValueFromSynchronizableValue(ModelItem definition, Object value, SynchronizationContext synchronizationContext, Map<String,Object> contextualParameters)	Returns the value of the synchronized value corresponding of the given value
protected 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
protected ModelItem	getModelItem(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> contextualParameters)	Retrieves the model item
protected Object	getStoredValue(String conditionDataPath, Optional<String> oldConditionDataPath, T ametysObject, Map<String,Object> contextualParameters)	Retrieves the condition value from data stored in the given object
protected Object	getValueFromMap(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value from the values Map
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.model.disableconditions.AbstractDisableConditionsEvaluator

_emptyStringToNull, _resultIsSufficient, evaluateDisableCondition, evaluateDisableConditions, evaluateDisableConditions, evaluateDisableConditions, evaluateDisableConditions, evaluateDisableConditionValue

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, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The Avalon 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

__AMETYS_OBJECT_PARAMETER_KEY

protected static final String __AMETYS_OBJECT_PARAMETER_KEY

The contextual parameter key for ametys object

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

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The system property extension point

Constructor Details

DataHolderDisableConditionsEvaluator

public DataHolderDisableConditionsEvaluator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getModelItem

protected ModelItem getModelItem(ModelItemAccessor modelItemAccessor,
 String conditionDataPath,
 Map<String,Object> contextualParameters)
                          throws UndefinedItemPathException

Description copied from class: AbstractDisableConditionsEvaluator

Retrieves the model item

Overrides:

getModelItem in class AbstractDisableConditionsEvaluator<T extends ModelAwareDataHolder>

Parameters:

modelItemAccessor - the relative accessor to the given data path

conditionDataPath - the data path of the model item to retrieve

contextualParameters - the contextual parameters

Returns:

the model item

Throws:

UndefinedItemPathException - If no item is found for the given path

_getConditionDefinitionAndValue

protected AbstractDisableConditionsEvaluator.DefinitionAndValue _getConditionDefinitionAndValue(ModelItem definition,
 DisableCondition condition,
 String dataPath,
 Optional<String> oldDataPath,
 Map<String,Object> values,
 Optional<T> ametsyObject,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractDisableConditionsEvaluator

Retrieve the value corresponding to the identifier of the condition, and its type

Overrides:

_getConditionDefinitionAndValue in class AbstractDisableConditionsEvaluator<T extends ModelAwareDataHolder>

Parameters:

definition - the definition containing the condition

condition - the condition

dataPath - the path of the evaluated data

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

values - values to check conditions on

ametsyObject - the object holding the data to evaluate and the condition value

contextualParameters - the contextual parameters

Returns:

the AbstractDisableConditionsEvaluator.DefinitionAndValue corresponding to the condition identifier

containsValue

protected 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

Specified by:

containsValue in class AbstractDisableConditionsEvaluator<T extends ModelAwareDataHolder>

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

_doesCompositeContainValue

protected boolean _doesCompositeContainValue(CompositeDefinition compositeDefinition,
 String compositeName,
 String subConditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)

Check if the values Map contains a value for the condition

Parameters:

compositeDefinition - the composite definition

compositeName - the name of the composite

subConditionDataPath - the data path of the condition, relative to the composite

values - the values Map

contextualParameters - the contextual parameters

Returns:

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

Throws:

BadItemTypeException - if the found value is not a composite

_doesRepeaterContainValue

protected boolean _doesRepeaterContainValue(RepeaterDefinition repeaterDefinition,
 String repeaterNameAndPositionSegment,
 String subConditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)
                                     throws BadItemTypeException

Check if the values Map contains a value for the condition

Parameters:

repeaterDefinition - the repeater definition

repeaterNameAndPositionSegment - the segment of the repeater, containing repeater name and entry position

subConditionDataPath - the data path of the condition, relative to the repeater

values - the values Map

contextualParameters - the contextual parameters

Returns:

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

Throws:

BadItemTypeException - if the found value is not a repeater

_containsElementValue

protected boolean _containsElementValue(ModelItem definition,
 String dataName,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)

Check if the values Map contains a value for the condition

Parameters:

definition - the definition of the condition element

dataName - the name of the condition element

values - the values Map

contextualParameters - the contextual parameters

Returns:

true if there is a value (even empty), false otherwise

getValueFromMap

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

Retrieves the condition value from the values Map

Specified by:

getValueFromMap in class AbstractDisableConditionsEvaluator<T extends ModelAwareDataHolder>

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

_getValueFromComposite

protected Object _getValueFromComposite(CompositeDefinition compositeDefinition,
 String compositeName,
 String subConditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)
                                 throws BadItemTypeException

Retrieves the condition value in the given composite, from the values Map

Parameters:

compositeDefinition - the composite definition

compositeName - the name of the composite

subConditionDataPath - the data path of the condition, relative to the composite

values - the values Map

contextualParameters - the contextual parameters

Returns:

the condition value if found in the values Map

Throws:

BadItemTypeException - if the found value is not a composite

_getValueFromRepeater

protected Object _getValueFromRepeater(RepeaterDefinition repeaterDefinition,
 String repeaterNameAndPositionSegment,
 String subConditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)
                                throws BadItemTypeException

Retrieves the condition value in the given repeater, from the values Map

Parameters:

repeaterDefinition - the repeater definition

repeaterNameAndPositionSegment - the segment of the repeater, containing repeater name and entry position

subConditionDataPath - the data path of the condition, relative to the repeater

values - the values Map

contextualParameters - the contextual parameters

Returns:

the condition value if found in the values Map

Throws:

BadItemTypeException - if the found value is not a repeater

_getValueFromContentValue

protected Object _getValueFromContentValue(ContentElementDefinition contentElementDefinition,
 String dataName,
 String subConditionDataPath,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)

Retrieves the condition value in the given content value, from the values Map

Parameters:

contentElementDefinition - the content element definition

dataName - the name of the content data

subConditionDataPath - the data path of the condition, relative to the content value

values - the values Map

contextualParameters - the contextual parameters

Returns:

the condition value if found in the values Map

_getElementValueFromMap

protected Object _getElementValueFromMap(ModelItem definition,
 String dataName,
 Map<String,Object> values,
 Map<String,Object> contextualParameters)

Retrieves the condition value from the values Map

Parameters:

definition - the definition of the condition element

dataName - the name of the condition element

values - the values Map

contextualParameters - the contextual parameters

Returns:

the condition value if found in the values Map

_getValueFromSynchronizableValue

protected Object _getValueFromSynchronizableValue(ModelItem definition,
 Object value,
 SynchronizationContext synchronizationContext,
 Map<String,Object> contextualParameters)

Returns the value of the synchronized value corresponding of the given value

Parameters:

definition - the definition of the condition element

value - the value

synchronizationContext - the synchronization context

contextualParameters - the contextual parameters

Returns:

the value of the synchronized value

getStoredValue

protected Object getStoredValue(String conditionDataPath,
 Optional<String> oldConditionDataPath,
 T ametysObject,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractDisableConditionsEvaluator

Retrieves the condition value from data stored in the given object

Specified by:

getStoredValue in class AbstractDisableConditionsEvaluator<T extends ModelAwareDataHolder>

Parameters:

conditionDataPath - the absolute data path of the condition

oldConditionDataPath - the absolute old data path of the condition

ametysObject - the object holding the data to evaluate and the condition value

contextualParameters - the contextual parameters

Returns:

the condition value from data stored in the object