Package org.ametys.cms.data.holder

Class DataHolderRelativeDisableCondition

java.lang.Object

org.ametys.runtime.model.disableconditions.AbstractRelativeDisableCondition

org.ametys.cms.data.holder.DataHolderRelativeDisableCondition

All Implemented Interfaces:

DisableCondition

public class DataHolderRelativeDisableCondition
extends AbstractRelativeDisableCondition

DisableCondition for model aware DataHolder

Nested Class Summary

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

AbstractRelativeDisableCondition.RelativeDefinitionAndValue

Nested classes/interfaces inherited from interface org.ametys.runtime.model.disableconditions.DisableCondition

DisableCondition.OPERATOR

Field Summary

Fields

Modifier and Type	Field	Description
protected DataHolderRelativeDisableConditionsHelper	_disableConditionsHelper	The data holder relative disable condition helper

Fields inherited from class org.ametys.runtime.model.disableconditions.AbstractRelativeDisableCondition

_id, _name, _operator, _value

Fields inherited from interface org.ametys.runtime.model.disableconditions.DisableCondition

EXTERNAL_CONDITION_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
DataHolderRelativeDisableCondition(String name, DisableCondition.OPERATOR operator, String value, DataHolderRelativeDisableConditionsHelper disableConditionsHelper)	Creates a data holder disable condition

Method Summary

Modifier and Type	Method	Description
protected <T> AbstractRelativeDisableCondition.RelativeDefinitionAndValue	_getConditionDefinitionAndValue(ModelItem definition, String dataPath, Optional<String> oldDataPath, Map<String,Object> values, Optional<T> dataHolder, Map<String,Object> contextualParameters)	Retrieve the value corresponding to the identifier of the condition, and its type
protected void	checkModelItemPathSegment(Model model, ModelItem definition, ModelItem segmentModelItem, int segmentIndex, int conditionPathSize)	Check a segment of the condition path
protected boolean	containsRelativeValue(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Check if the values Map contains a value for the relative condition
protected List<ModelItem>	getAllModelItemsInPath(Model model, ModelItem definition)	Retrieves all model items of the given relative path
protected ModelItem	getModelItem(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> contextualParameters)	Retrieves the model item
protected Object	getRelativeValueFromMap(ModelItemAccessor modelItemAccessor, String conditionDataPath, Map<String,Object> values, Map<String,Object> contextualParameters)	Retrieves the relative condition value from the values Map
protected <T> Object	getStoredRelativeValue(String conditionDataPath, Optional<String> oldConditionDataPath, T dataHolder, Map<String,Object> contextualParameters)	Retrieves the condition value from data stored in the given object
boolean	isExternal(DefinitionContext context)	Check if the current disable condition is external An external condition can not be computed only from the object's values

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

_emptyStringToNull, evaluate, evaluateDisableConditionValue, getId, getName, getOperator, getValue, init

Methods inherited from class java.lang.Object

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

Field Details

_disableConditionsHelper

protected DataHolderRelativeDisableConditionsHelper _disableConditionsHelper

The data holder relative disable condition helper

Constructor Details

DataHolderRelativeDisableCondition

public DataHolderRelativeDisableCondition(String name,
 DisableCondition.OPERATOR operator,
 String value,
 DataHolderRelativeDisableConditionsHelper disableConditionsHelper)

Creates a data holder disable condition

Parameters:

name - The condition name

operator - comparison operator of the condition ('eq'...)

value - value to compare to

disableConditionsHelper - the data holder relative disable condition helper

Method Details

getAllModelItemsInPath

protected List<ModelItem> getAllModelItemsInPath(Model model,
 ModelItem definition)
                                          throws UndefinedItemPathException,
IllegalArgumentException

Description copied from class: AbstractRelativeDisableCondition

Retrieves all model items of the given relative path

Overrides:

getAllModelItemsInPath in class AbstractRelativeDisableCondition

Parameters:

model - the model containing the definition

definition - the model item defining this disable 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

protected void checkModelItemPathSegment(Model model,
 ModelItem definition,
 ModelItem segmentModelItem,
 int segmentIndex,
 int conditionPathSize)
                                  throws ConfigurationException

Description copied from class: AbstractRelativeDisableCondition

Check a segment of the condition path

Overrides:

checkModelItemPathSegment in class AbstractRelativeDisableCondition

Parameters:

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

_getConditionDefinitionAndValue

protected <T>
AbstractRelativeDisableCondition.RelativeDefinitionAndValue _getConditionDefinitionAndValue(ModelItem definition,
 String dataPath,
 Optional<String> oldDataPath,
 Map<String,Object> values,
 Optional<T> dataHolder,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractRelativeDisableCondition

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

Overrides:

_getConditionDefinitionAndValue in class AbstractRelativeDisableCondition

Type Parameters:

T - Type of object holding the data to evaluate

Parameters:

definition - the definition containing 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

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

contextualParameters - the contextual parameters

Returns:

the AbstractRelativeDisableCondition.RelativeDefinitionAndValue corresponding to the condition identifier

getModelItem

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

Description copied from class: AbstractRelativeDisableCondition

Retrieves the model item

Overrides:

getModelItem in class AbstractRelativeDisableCondition

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

containsRelativeValue

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

Check if the values Map contains a value for the relative condition

Overrides:

containsRelativeValue in class AbstractRelativeDisableCondition

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

getRelativeValueFromMap

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

Retrieves the relative condition value from the values Map

Overrides:

getRelativeValueFromMap in class AbstractRelativeDisableCondition

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

getStoredRelativeValue

protected <T> Object getStoredRelativeValue(String conditionDataPath,
 Optional<String> oldConditionDataPath,
 T dataHolder,
 Map<String,Object> contextualParameters)

Description copied from class: AbstractRelativeDisableCondition

Retrieves the condition value from data stored in the given object

Specified by:

getStoredRelativeValue in class AbstractRelativeDisableCondition

Type Parameters:

T - Type of object holding the data to evaluate

Parameters:

conditionDataPath - the absolute data path of the condition

oldConditionDataPath - the absolute old data path of the condition

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

isExternal

public boolean isExternal(DefinitionContext context)

Description copied from interface: DisableCondition

Check if the current disable condition is external An external condition can not be computed only from the object's values

Parameters:

context - the definition context

Returns:

true if the disable condition is external, false otherwise