Package net.ssehub.easy.varModel.confModel

Class ContainerVariable

java.lang.Object

net.ssehub.easy.varModel.confModel.DecisionVariable

net.ssehub.easy.varModel.confModel.StructuredVariable

net.ssehub.easy.varModel.confModel.ContainerVariable

All Implemented Interfaces:

IConfigurationElement, IConfigurationVisitable, IDecisionVariable, IValueParent

Direct Known Subclasses:

SequenceVariable, SetVariable

public abstract class ContainerVariable
extends StructuredVariable

VariableConfigProvider for nested variables of a ContainerVariable.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private List<IDecisionVariable>	nestedElements

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ContainerVariable(IConfigurationElement parent, AbstractVariable varDeclaration, boolean isVisible, boolean isAttribute)	Sole constructor for this class.

Method Summary

Modifier and Type	Method	Description
IDecisionVariable	addNestedElement()	Adds a new nested element to this variable.
(package private) void	addNestedElement(IDecisionVariable var)	Adds a nested IDecisionVariable to this ContainerVariable.
IDecisionVariable	addNestedElement(IDatatype type)	Adds a new nested element to this variable.
(package private) boolean	allowsNestedStates()	Returns whether this variable support individual states for nested items.
(package private) void	clear()	Clears the list.
void	freeze(String nestedElement)	Causes to freeze a nested value.
void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
IDatatype	getContainedType()	Returns the contained type of this container.
protected String	getElementName(int index)	Returns the symbolic name for an element in this container, such as the index for sequences.
IDecisionVariable	getNestedElement(int index)	Returns the element specified by index.
int	getNestedElementsCount()	Returns the number of nested elements.
IAssignmentState	getState()	Returns the assignment state of this variable.
int	indexOf(IDecisionVariable var)	Returns the 0-based index of var in this container.
boolean	notifyWasAssigned(Value value)	Inform the variable independent of its own tracking that we believe that a value was assigned (although we did not due to equal values/performance reasons), in particular after resetting the track through Enum.compareTo(CommandAssignmentState).
boolean	removeDerivedValues()	Removes all (nested) values which are in state AssignmentState.DERIVED, i.e., all values which are propagated bay the reasoner.
boolean	removeNestedElement(IDecisionVariable var)	Removes a (configured) element (IDecisionVariable) of this ContainerVariable.
void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).
void	setValue(Value value, IAssignmentState state, IConfigurationElement nested)	Changes the value of a nested variable.

Methods inherited from class net.ssehub.easy.varModel.confModel.DecisionVariable

accept, enableWasAssignedForIsDefined, getAttribute, getAttributesCount, getConfigProvider, getConfiguration, getDeclaration, getInstantiatableType, getNestedDepth, getNestedElement, getParent, getPathForNestedElement, getQualifiedName, getResolutionPath, getValue, hasNullValue, hasValue, isAttribute, isLocal, isNested, isVisible, notifyCreated, ownStateAllowed, setHistoryValue, setIndex, setState, setValue, toString, unfreeze, wasAssigned, wasCreated

Methods inherited from class java.lang.Object

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

Field Details

nestedElements

private List<IDecisionVariable> nestedElements

Constructor Details

ContainerVariable

protected ContainerVariable(IConfigurationElement parent,
 AbstractVariable varDeclaration,
 boolean isVisible,
 boolean isAttribute)

Sole constructor for this class.

Parameters:

parent - the parent this variable is part of, typically the Configuration instance, but in case of compounds/container also the containing IDecisionVariable

varDeclaration - the variable declaration instantiated by this decision

isVisible - Specifies whether this variables is exported by an interface or not:

• true: The variable is exported by an interface or there is no interface.
• false: There is an interface which does not export this variable.

isAttribute - whether this variable represents (a part of) an attribute or a variable

Method Details

clear

void clear()

Clears the list.

getNestedElementsCount

public int getNestedElementsCount()

Description copied from interface: IDecisionVariable

Returns the number of nested elements. The return value should be 0 unless this IDecisionVariable is a

• CompoundVariable
• ContainerVariable

Returns:

An integer value greater or equal to 0.

getNestedElement

public IDecisionVariable getNestedElement(int index)

Description copied from interface: IDecisionVariable

Returns the element specified by index. [also req SAP]

Parameters:

index - a 0-based index specifying the element to be returned

Returns:

the element

indexOf

public int indexOf(IDecisionVariable var)

Returns the 0-based index of var in this container.

Parameters:

var - the variable to search for

Returns:

the index of var or -1 if not found

setValue

public void setValue(Value value,
 IAssignmentState state,
 IConfigurationElement nested)
              throws ConfigurationException

Description copied from interface: IConfigurationElement

Changes the value of a nested variable.

Parameters:

value - the new value

state - the new assignment state

nested - the nested variable to be considered in the parent

Throws:

ConfigurationException - in case of type incompatibilities

setValue

public void setValue(Value value,
 IAssignmentState state)
              throws ConfigurationException

Description copied from interface: IDecisionVariable

Changes the value (for incremental buildup).

Specified by:

setValue in interface IDecisionVariable

Overrides:

setValue in class DecisionVariable

Parameters:

value - the value (may be null for incremental buildup)

state - the related assignment state

Throws:

ConfigurationException - in case that the types of IConfigurationElement.getDeclaration() and value do not comply

freeze

public void freeze(IFreezeSelector selector)

Description copied from interface: IConfigurationElement

Causes to freeze the current value.

Specified by:

freeze in interface IConfigurationElement

Overrides:

freeze in class DecisionVariable

Parameters:

selector - determines which parts shall be frozen

freeze

public void freeze(String nestedElement)

Description copied from interface: IConfigurationElement

Causes to freeze a nested value.

Parameters:

nestedElement - The name of the nested Element, which should be frozen.

allowsNestedStates

boolean allowsNestedStates()

Description copied from class: StructuredVariable

Returns whether this variable support individual states for nested items.

Specified by:

allowsNestedStates in class StructuredVariable

Returns:

true if nested items can have their own states, otherwise false.

getElementName

protected String getElementName(int index)

Returns the symbolic name for an element in this container, such as the index for sequences.

Parameters:

index - the position of the element within the container

Returns:

the symbolic name

addNestedElement

public IDecisionVariable addNestedElement()

Adds a new nested element to this variable. This nested element is empty, is in state AssignmentState.UNDEFINED and can be configured afterwards.

Returns:

the created decision variable

getContainedType

public IDatatype getContainedType()

Returns the contained type of this container.

Returns:

the contained type

addNestedElement

public IDecisionVariable addNestedElement(IDatatype type)

Adds a new nested element to this variable. This nested element is empty, is in state AssignmentState.UNDEFINED and can be configured afterwards.

Parameters:

type - the specific type to create the nested element for; if null, the declared contained type is used; if not assignable to the declared contained type, the declared contained type is used instead

Returns:

the created decision variable

removeNestedElement

public boolean removeNestedElement(IDecisionVariable var)

Removes a (configured) element (IDecisionVariable) of this ContainerVariable. This is the reverse function of addNestedElement().

Parameters:

var - A variable which is directly nested in this variable and shall be deleted.

Returns:

true if the specified element was found and deleted from this variable, false otherwise

See Also:

• addNestedElement()

getState

public IAssignmentState getState()

Description copied from interface: IConfigurationElement

Returns the assignment state of this variable.

Specified by:

getState in interface IConfigurationElement

Overrides:

getState in class DecisionVariable

Returns:

the assignment state

addNestedElement

void addNestedElement(IDecisionVariable var)

Adds a nested IDecisionVariable to this ContainerVariable. If an equal IDecisionVariable is already part of this ContainerVariable, the IDecisionVariable will be replaced by the new one.

Parameters:

var - The nested IDecisionVariable which should be added to this container.

removeDerivedValues

public boolean removeDerivedValues()

Description copied from interface: IDecisionVariable

Removes all (nested) values which are in state AssignmentState.DERIVED, i.e., all values which are propagated bay the reasoner. This will keep all user assigned AssignmentState.ASSIGNED and frozen AssignmentState.FROZEN values.

Returns:

true if there was a change, false if the variable keeps unchanged.

notifyWasAssigned

public boolean notifyWasAssigned(Value value)

Description copied from interface: IDecisionVariable

Inform the variable independent of its own tracking that we believe that a value was assigned (although we did not due to equal values/performance reasons), in particular after resetting the track through Enum.compareTo(CommandAssignmentState).

Specified by:

notifyWasAssigned in interface IDecisionVariable

Overrides:

notifyWasAssigned in class DecisionVariable

Parameters:

value - the new value

Returns:

true whether this variable was defined before, false else