Package org.ametys.runtime.model.disableconditions

Class AbstractDisableConditionsEvaluator<T>

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

Type Parameters:

T - Type of object holding the data to evaluate

All Implemented Interfaces:

DisableConditionsEvaluator<T>, LogEnabled, Component

Direct Known Subclasses:

ConfigDisableConditionsEvaluator, DataHolderDisableConditionsEvaluator, SkinDisableConditionsEvaluator, UsersAndGroupsDataDisableConditionsEvaluator

public abstract class AbstractDisableConditionsEvaluator<T>
extends AbstractLogEnabled
implements Component, DisableConditionsEvaluator<T>

Abstract evaluator for DisableConditions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AbstractDisableConditionsEvaluator.DefinitionAndValue	Definition and value corresponding to a DisableCondition

Constructor Summary

Constructors

Constructor	Description
AbstractDisableConditionsEvaluator()

Method Summary

Modifier and Type	Method	Description
protected static Object	_emptyStringToNull(Object value)	Convert empty string to null object, or retrieve the given value
protected AbstractDisableConditionsEvaluator.DefinitionAndValue	_getConditionDefinitionAndValue(ModelItem definition, DisableCondition condition, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, Optional<T> object, Map<String,Object> contextualParameters)	Retrieve the value corresponding to the identifier of the condition, and its type
protected boolean	_resultIsSufficient(boolean andOperator, boolean result)	Check if the given result is sufficient to evaluate the current disable condition
protected abstract 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 boolean	evaluateDisableCondition(ModelItem definition, DisableCondition condition, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, Optional<T> object, Map<String,Object> contextualParameters)	Evaluate the given DisableCondition against the given values
boolean	evaluateDisableConditions(ModelItem definition, String dataPath, Map<String,Object> values)	Recursively evaluate the DisableConditions of the given model item, against the given values.
boolean	evaluateDisableConditions(ModelItem definition, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, T object, Map<String,Object> contextualParameters)	Recursively evaluate the DisableConditions of the given model item, against the given values.
boolean	evaluateDisableConditions(ModelItem definition, String dataPath, T object)	Recursively evaluate the DisableConditions of the given model item, against the values stored in the given object
protected boolean	evaluateDisableConditions(ModelItem definition, DisableConditions disableConditions, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, Optional<T> object, Map<String,Object> contextualParameters)	Recursively evaluate the given DisableConditions against the given values
protected boolean	evaluateDisableConditionValue(Object conditionValue, DisableCondition.OPERATOR conditionOperator, Object value)	Evaluate the given condition value against the given value
protected ModelItem	getModelItem(ModelItemAccessor modelItemAccessor, String dataPath, Map<String,Object> contextualParameters)	Retrieves the model item
protected abstract Object	getStoredValue(String conditionDataPath, Optional<String> oldConditionDataPath, T object, Map<String,Object> contextualParameters)	Retrieves the condition value from data stored in the given object
protected abstract Object	getValueFromMap(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the condition value from the values Map

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

Constructor Details

AbstractDisableConditionsEvaluator

public AbstractDisableConditionsEvaluator()

Method Details

evaluateDisableConditions

public boolean evaluateDisableConditions(ModelItem definition,
 String dataPath,
 Map<String,Object> values)
                                  throws UndefinedItemPathException,
BadItemTypeException

Description copied from interface: DisableConditionsEvaluator

Recursively evaluate the DisableConditions of the given model item, against the given values.

Specified by:

evaluateDisableConditions in interface DisableConditionsEvaluator<T>

Parameters:

definition - the definition of the evaluated data

dataPath - the path of the evaluated data. Needed to get the value to compare as condition ids are relative to this one

values - values to check conditions on

Returns:

true if the disable conditions are true, false otherwise

Throws:

UndefinedItemPathException - If no item is found corresponding to one of the conditions

BadItemTypeException - If the item referenced by one of the conditions is not an element

evaluateDisableConditions

public boolean evaluateDisableConditions(ModelItem definition,
 String dataPath,
 T object)
                                  throws UndefinedItemPathException,
BadItemTypeException

Description copied from interface: DisableConditionsEvaluator

Recursively evaluate the DisableConditions of the given model item, against the values stored in the given object

Specified by:

evaluateDisableConditions in interface DisableConditionsEvaluator<T>

Parameters:

definition - the definition of the evaluated data

dataPath - the path of the evaluated data. Needed to get the value to compare as condition ids are relative to this one

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

Returns:

true if the disable conditions are true, false otherwise

Throws:

UndefinedItemPathException - If no item is found corresponding to one of the conditions

BadItemTypeException - If the item referenced by one of the conditions is not an element

evaluateDisableConditions

public boolean evaluateDisableConditions(ModelItem definition,
 String dataPath,
 Optional<String> oldDataPath,
 Map<String,Object> values,
 T object,
 Map<String,Object> contextualParameters)
                                  throws UndefinedItemPathException,
BadItemTypeException

Description copied from interface: DisableConditionsEvaluator

Recursively evaluate the DisableConditions of the given model item, against the given values. If the value of the condition is not present in the given Map, search in the stored values in the given object

Specified by:

evaluateDisableConditions in interface DisableConditionsEvaluator<T>

Parameters:

definition - the definition of the evaluated data

dataPath - the path of the evaluated data. Needed to get the value to compare as condition ids are relative to this one

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

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

contextualParameters - the contextual parameters

Returns:

true if the disable conditions are true, false otherwise

Throws:

UndefinedItemPathException - If no item is found corresponding to one of the conditions

BadItemTypeException - If the item referenced by one of the conditions is not an element

evaluateDisableConditions

protected boolean evaluateDisableConditions(ModelItem definition,
 DisableConditions disableConditions,
 String dataPath,
 Optional<String> oldDataPath,
 Map<String,Object> values,
 Optional<T> object,
 Map<String,Object> contextualParameters)
                                     throws UndefinedItemPathException,
BadItemTypeException

Recursively evaluate the given DisableConditions against the given values

Parameters:

definition - the definition of the evaluated data

disableConditions - the conditions to evaluate

dataPath - the path of the evaluated data. Needed to get the value to compare as condition ids are relative to this one

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

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

contextualParameters - the contextual parameters

Returns:

true if the disable conditions are true, false otherwise

Throws:

UndefinedItemPathException - If no item is found corresponding to one of the given conditions

BadItemTypeException - If the item referenced by one of the conditions is not an element

_resultIsSufficient

protected boolean _resultIsSufficient(boolean andOperator,
 boolean result)

Check if the given result is sufficient to evaluate the current disable condition

Parameters:

andOperator - the conditions operator

result - the result of the current condition

Returns:

true if the result of evaluation is sufficient, false otherwise

evaluateDisableCondition

protected boolean evaluateDisableCondition(ModelItem definition,
 DisableCondition condition,
 String dataPath,
 Optional<String> oldDataPath,
 Map<String,Object> values,
 Optional<T> object,
 Map<String,Object> contextualParameters)
                                    throws UndefinedItemPathException,
BadItemTypeException

Evaluate the given DisableCondition against the given values

Parameters:

definition - the definition of the evaluated data

condition - the condition to evaluate

dataPath - the path of the evaluated data. Needed to get the value to compare as condition ids are relative to this one

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

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

contextualParameters - the contextual parameters

Returns:

true if the disable condition is true, false otherwise

Throws:

UndefinedItemPathException - If no item is found corresponding to the given condition

BadItemTypeException - If the item referenced by the condition is not an element

_getConditionDefinitionAndValue

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

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

Parameters:

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

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

contextualParameters - the contextual parameters

Returns:

the AbstractDisableConditionsEvaluator.DefinitionAndValue corresponding to the condition identifier

Throws:

UndefinedItemPathException - If no item is found with the given conditionId

BadItemTypeException - If the item referenced by the conditionId is not an element

getModelItem

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

Retrieves the model item

Parameters:

modelItemAccessor - the relative accessor to the given data path

dataPath - 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

containsValue

protected abstract 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

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

getValueFromMap

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

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

getStoredValue

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

Retrieves the condition value from data stored in the given object

Parameters:

conditionDataPath - the absolute data path of the condition

oldConditionDataPath - the absolute old data path of the condition

object - 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

evaluateDisableConditionValue

protected boolean evaluateDisableConditionValue(Object conditionValue,
 DisableCondition.OPERATOR conditionOperator,
 Object value)

Evaluate the given condition value against the given value

Parameters:

conditionValue - the condition value

conditionOperator - the condition operator

value - the value to check

Returns:

true if the condition is true, false otherwise

_emptyStringToNull

protected static Object _emptyStringToNull(Object value)

Convert empty string to null object, or retrieve the given value

Parameters:

value - the value

Returns:

null if the given value is an empty string, the value itself otherwise