Package org.ametys.runtime.model.disableconditions

Class DefaultDisableConditionsEvaluator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.model.disableconditions.DefaultDisableConditionsEvaluator

All Implemented Interfaces:

DisableConditionsEvaluator, LogEnabled, Component

public class DefaultDisableConditionsEvaluator
extends AbstractLogEnabled
implements Component, DisableConditionsEvaluator

Abstract evaluator for DisableConditions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
DefaultDisableConditionsEvaluator()

Method Summary

Modifier and Type	Method	Description
protected boolean	_resultIsSufficient(boolean andOperator, boolean result)	Check if the given result is sufficient to evaluate the current disable condition
boolean	evaluateDisableConditions(ModelItem definition, String dataPath, Map<String,Object> values)	Recursively evaluate the DisableConditions of the given model item, against the given values.
<T> 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.
<T> 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 <T> 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

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

Constructor Details

DefaultDisableConditionsEvaluator

public DefaultDisableConditionsEvaluator()

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

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

Type Parameters:

T - Type of object holding the data to evaluate

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

Type Parameters:

T - Type of object holding the data to evaluate

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

Type Parameters:

T - Type of object holding the data to evaluate

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