Package net.ssehub.easy.varModel.cstEvaluation

Class LocalDecisionVariable

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.LocalDecisionVariable

All Implemented Interfaces:

IConfigurationElement, IConfigurationVisitable, IDecisionVariable, IValueParent

public class LocalDecisionVariable
extends java.lang.Object
implements IDecisionVariable

A local decision variable representing a parameter or a local variable. A local decision variable must also return local decision variables (in order to remain "local").

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private IConfiguration	conf
private DecisionVariableDeclaration	decl
(package private) static java.lang.String	ITERATOR_RESULT_VARNAME
private IValueChangeListener	listener
private IDecisionVariable	parent
private IAssignmentState	state
private Value	value

Constructor Summary

Constructors

Constructor	Description
LocalDecisionVariable(DecisionVariableDeclaration decl, IConfiguration conf, IDecisionVariable parent)	Creates a local decision variable.

Method Summary

Modifier and Type	Method	Description
void	accept(IConfigurationVisitor visitor)	Accepts and calls the given visitor.
boolean	enableWasAssignedForIsDefined()	Shall we take the local IDecisionVariable.wasAssigned() over IConfigurationElement.getState() in the implementation of IVML "isDefined".
void	freeze(java.lang.String nestedElement)	Causes to freeze a nested value.
void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
IDecisionVariable	getAttribute(int index)	Returns a specific attribute.
int	getAttributesCount()	Returns the number of attributes.
Configuration	getConfiguration()	Returns the topLevel parent.
AbstractVariable	getDeclaration()	Returns the declaration of the variable.
int	getNestedDepth()	Returns how many parent IDecisionVariables exist for this variable.
IDecisionVariable	getNestedElement(int index)	Returns the element specified by index.
IDecisionVariable	getNestedElement(java.lang.String name)	Returns an element specified by its name.
int	getNestedElementsCount()	Returns the number of nested elements.
IDecisionVariable	getNestedVariable(java.lang.String slotName)	Returns the nested variable for the given slot name.
IConfigurationElement	getParent()	Returns the element this element is part of.
java.lang.String	getQualifiedName()	Returns the qualified name of the declaration instance.
IResolutionPathElement	getResolutionPath()	Returns a resolution path for this variable.
IAssignmentState	getState()	Returns the assignment state of this variable.
Value	getValue()	Returns the current value of this IDecisionVariable.
private IValueParent	getValueParent(Value value)	Returns the value parent of value.
IDecisionVariable	getVariable()	Returns the underlying variable.
boolean	hasNullValue()	Checks whether the variable has a NullValue.
boolean	hasValue()	Checks whether the variable has a configured Value.
boolean	isLocal()	Returns whether this variable is local, e.g., as a parameter of a user-defined function, a variable defined by a let-expression, or an iterator in a container operation.
boolean	isNested()	Returns whether this decision variable is nested.
boolean	isVisible()	Returns whether this variable is visible by the user.
void	notifyCreated()	Notifies this variable that it was created.
private void	notifyValueChanged(Value oldValue, IAssignmentState oldState, IValueChangeListener.ChangeKind kind)	Notifies the change listener if defined.
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 CommandAssignmentState#compareTo(CommandAssignmentState).
private IValueParent	obtainValueParent(Value value)	Obtains the value parent for the stored value, the given value or the value of one of the parents.
boolean	removeDerivedValues()	Removes all (nested) values which are in state AssignmentState.DERIVED, i.e., all values which are propagated bay the reasoner.
void	setHistoryValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup) from value history.
void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).
void	setValue(Value value, IAssignmentState state, boolean asAssignment)	Changes the value.
void	setValue(Value value, IAssignmentState state, IConfigurationElement nested)	Changes the value of a nested variable.
void	setValueChangeListener(IValueChangeListener listener)	Defines the value change listener to be informed.
void	setVariable(IDecisionVariable variable)	Changes the underlying variable taking precedence over the stored value.
void	unfreeze(IAssignmentState state)	Causes to unfreeze the current value.
boolean	wasAssigned()	Returns whether a value was assigned (correlated, but independent of IConfigurationElement.getState()).
boolean	wasCreated()	Returns whether the variable value was explicitly created.

Methods inherited from class java.lang.Object

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

Field Detail

ITERATOR_RESULT_VARNAME

static final java.lang.String ITERATOR_RESULT_VARNAME

See Also:

Constant Field Values

decl

private DecisionVariableDeclaration decl

value

private Value value

state

private IAssignmentState state

conf

private IConfiguration conf

parent

private IDecisionVariable parent

listener

private IValueChangeListener listener

Constructor Detail

LocalDecisionVariable

public LocalDecisionVariable(DecisionVariableDeclaration decl,
                             IConfiguration conf,
                             IDecisionVariable parent)

Creates a local decision variable.

Parameters:

decl - the defining variable declaration

conf - the configuration

parent - the parent decision variable for call-by-reference, may be null

Method Detail

getParent

public IConfigurationElement getParent()

Description copied from interface: IConfigurationElement

Returns the element this element is part of.

Specified by:

getParent in interface IConfigurationElement

Returns:

the parent element (may be null in case of the top-level configuration)

getConfiguration

public Configuration getConfiguration()

Description copied from interface: IConfigurationElement

Returns the topLevel parent.

Specified by:

getConfiguration in interface IConfigurationElement

Returns:

should be the configuration

isNested

public boolean isNested()

Description copied from interface: IConfigurationElement

Returns whether this decision variable is nested. Being member of a Configuration does not imply isNested == true.

Specified by:

isNested in interface IConfigurationElement

Returns:

true if it is nested in another decision variable, false else

getState

public IAssignmentState getState()

Description copied from interface: IConfigurationElement

Returns the assignment state of this variable.

Specified by:

getState in interface IConfigurationElement

Returns:

the assignment state

notifyValueChanged

private void notifyValueChanged(Value oldValue,
                                IAssignmentState oldState,
                                IValueChangeListener.ChangeKind kind)

Notifies the change listener if defined.

Parameters:

oldValue - the old value before the change, may be null

oldState - the old state of variable before the change

kind - the change kind

setValue

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

Description copied from interface: IDecisionVariable

Changes the value.

Specified by:

setValue in interface IDecisionVariable

Parameters:

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

state - the related assignment state

asAssignment - does this call happen as part of evaluating an IVML assignment operation

Throws:

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

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

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

setValue

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

Description copied from interface: IConfigurationElement

Changes the value of a nested variable.

Specified by:

setValue in interface IConfigurationElement

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

obtainValueParent

private IValueParent obtainValueParent(Value value)

Obtains the value parent for the stored value, the given value or the value of one of the parents.

Parameters:

value - the value to consider (may be null)

Returns:

the value parent, may be null for none

getValueParent

private IValueParent getValueParent(Value value)

Returns the value parent of value.

Parameters:

value - the value to return the parent for (may be null)

Returns:

the value parent (may be null)

freeze

public void freeze(IFreezeSelector selector)

Description copied from interface: IConfigurationElement

Causes to freeze the current value.

Specified by:

freeze in interface IConfigurationElement

Parameters:

selector - determines which parts shall be frozen

unfreeze

public void unfreeze(IAssignmentState state)

Description copied from interface: IConfigurationElement

Causes to unfreeze the current value.

Specified by:

unfreeze in interface IConfigurationElement

Parameters:

state - the target state for unfreezing (must not be AssignmentState.FROZEN)

freeze

public void freeze(java.lang.String nestedElement)

Description copied from interface: IConfigurationElement

Causes to freeze a nested value.

Specified by:

freeze in interface IConfigurationElement

Parameters:

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

getDeclaration

public AbstractVariable getDeclaration()

Description copied from interface: IConfigurationElement

Returns the declaration of the variable.

Specified by:

getDeclaration in interface IConfigurationElement

Returns:

the declaration of the decision variable

accept

public void accept(IConfigurationVisitor visitor)

Description copied from interface: IConfigurationVisitable

Accepts and calls the given visitor.

Specified by:

accept in interface IConfigurationVisitable

Parameters:

visitor - the visitor

getValue

public Value getValue()

Description copied from interface: IDecisionVariable

Returns the current value of this IDecisionVariable.

Specified by:

getValue in interface IDecisionVariable

Returns:

the value (may be null)

setHistoryValue

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

Description copied from interface: IDecisionVariable

Changes the value (for incremental buildup) from value history.

Specified by:

setHistoryValue in interface IDecisionVariable

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

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

Specified by:

getNestedElementsCount in interface IDecisionVariable

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]

Specified by:

getNestedElement in interface IDecisionVariable

Parameters:

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

Returns:

the element

getNestedVariable

public IDecisionVariable getNestedVariable(java.lang.String slotName)

Returns the nested variable for the given slot name.

Parameters:

slotName - the slot name

Returns:

the nested variable or null if it does not exist

getNestedElement

public IDecisionVariable getNestedElement(java.lang.String name)

Description copied from interface: IDecisionVariable

Returns an element specified by its name.

Specified by:

getNestedElement in interface IDecisionVariable

Parameters:

name - the name of the nested element

Returns:

the nested element (may be null)

getAttributesCount

public int getAttributesCount()

Description copied from interface: IDecisionVariable

Returns the number of attributes.

Specified by:

getAttributesCount in interface IDecisionVariable

Returns:

the number of attributes

getAttribute

public IDecisionVariable getAttribute(int index)

Description copied from interface: IDecisionVariable

Returns a specific attribute.

Specified by:

getAttribute in interface IDecisionVariable

Parameters:

index - the index of the attribute

Returns:

the attribute

getNestedDepth

public int getNestedDepth()

Description copied from interface: IDecisionVariable

Returns how many parent IDecisionVariables exist for this variable.

Specified by:

getNestedDepth in interface IDecisionVariable

Returns:

0 if the Configuration is the direct parent of this IDecisionVariable, otherwise a number greater than 0 indicating how many IDecisionVariables between the Configuration and this variable exist.

isVisible

public boolean isVisible()

Description copied from interface: IDecisionVariable

Returns whether this variable is visible by the user.

Specified by:

isVisible in interface IDecisionVariable

Returns:

false if the variable is hidden by an interface, true otherwise

hasValue

public boolean hasValue()

Description copied from interface: IDecisionVariable

Checks whether the variable has a configured Value.

Specified by:

hasValue in interface IDecisionVariable

Returns:

true if the variable has a value, false otherwise.

hasNullValue

public boolean hasNullValue()

Description copied from interface: IDecisionVariable

Checks whether the variable has a NullValue. Note: this method does not check whether the variable has a value.

Specified by:

hasNullValue in interface IDecisionVariable

Returns:

true if the variable has a NullValue, false otherwise.

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.

Specified by:

removeDerivedValues in interface IDecisionVariable

Returns:

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

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: IDecisionVariable

Returns the qualified name of the declaration instance. This is build as follows:
<Project name> :: [<Parent name>::]* <Declaration name>

Specified by:

getQualifiedName in interface IDecisionVariable

Returns:

The qualified and unique name of the variable.

getResolutionPath

public IResolutionPathElement getResolutionPath()

Description copied from interface: IDecisionVariable

Returns a resolution path for this variable.

Specified by:

getResolutionPath in interface IDecisionVariable

Returns:

the resolution path

isLocal

public boolean isLocal()

Description copied from interface: IDecisionVariable

Returns whether this variable is local, e.g., as a parameter of a user-defined function, a variable defined by a let-expression, or an iterator in a container operation.

Specified by:

isLocal in interface IDecisionVariable

Returns:

false if the variable is not local and part of an usual configuration, true if the variable is local

setVariable

public void setVariable(IDecisionVariable variable)

Changes the underlying variable taking precedence over the stored value.

Parameters:

variable - the variable (may be null) to ignore

getVariable

public IDecisionVariable getVariable()

Returns the underlying variable.

Returns:

variable the variable (may be null)

setValueChangeListener

public void setValueChangeListener(IValueChangeListener listener)

Defines the value change listener to be informed.

Parameters:

listener - the listener instance or null for none

wasCreated

public boolean wasCreated()

Description copied from interface: IConfigurationElement

Returns whether the variable value was explicitly created.

Specified by:

wasCreated in interface IConfigurationElement

Returns:

true for created, false else

notifyCreated

public void notifyCreated()

Description copied from interface: IDecisionVariable

Notifies this variable that it was created.

Specified by:

notifyCreated in interface IDecisionVariable

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 CommandAssignmentState#compareTo(CommandAssignmentState).

Specified by:

notifyWasAssigned in interface IDecisionVariable

Parameters:

value - the new value

Returns:

true whether this variable was defined before, false else

wasAssigned

public boolean wasAssigned()

Description copied from interface: IDecisionVariable

Returns whether a value was assigned (correlated, but independent of IConfigurationElement.getState()).

Specified by:

wasAssigned in interface IDecisionVariable

Returns:

true if a value was assigned, false else

enableWasAssignedForIsDefined

public boolean enableWasAssignedForIsDefined()

Description copied from interface: IDecisionVariable

Shall we take the local IDecisionVariable.wasAssigned() over IConfigurationElement.getState() in the implementation of IVML "isDefined".

Specified by:

enableWasAssignedForIsDefined in interface IDecisionVariable

Returns:

true take IDecisionVariable.wasAssigned(), false for IConfigurationElement.getState().