Package net.ssehub.easy.varModel.confModel

Class DecisionVariable

java.lang.Object

net.ssehub.easy.varModel.confModel.DecisionVariable

All Implemented Interfaces:

IConfigurationElement, IConfigurationVisitable, IDecisionVariable, IValueParent

Direct Known Subclasses:

BasisVariable, StructuredVariable

abstract class DecisionVariable
extends Object
implements IDecisionVariable

Implements a decision variable representing a specific decision. Initializes and stores attributes on decision variables.

Author:

Holger Eichelberger, El-Sharkawy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DecisionVariable.InitializationAnnotationVisitor	Initializes annotation variables of the containing decision variable.

Field Summary

Fields

Modifier and Type	Field	Description
private IDecisionVariable[]	attributes
private VariableConfigProvider	configProvider
private AbstractVariable	declaration
private boolean	isAttribute
private boolean	isVisible
private IConfigurationElement	parent
private boolean	wasAssigned

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DecisionVariable(IConfigurationElement parent, AbstractVariable varDeclaration, boolean isVisible, boolean isAttribute)	Creates a new decision variable representing a specific decision.

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(IFreezeSelector selector)	Causes to freeze the current value.
IDecisionVariable	getAttribute(int index)	Returns a specific attribute.
int	getAttributesCount()	Returns the number of attributes.
(package private) VariableConfigProvider	getConfigProvider()	Getter for the VariableConfigProvider.
final Configuration	getConfiguration()	Returns the topLevel parent.
AbstractVariable	getDeclaration()	Returns the declaration of the variable.
IDatatype	getInstantiatableType()	Returns one of the actual types required to instantiate this variable.
final int	getNestedDepth()	Returns how many parent IDecisionVariables exist for this variable.
IDecisionVariable	getNestedElement(String name)	Returns an element specified by its name.
final IConfigurationElement	getParent()	Returns the element this element is part of.
protected IResolutionPathElement	getPathForNestedElement(IDecisionVariable nested)	Returns the resolution path for a nested element.
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.
boolean	hasNullValue()	Checks whether the variable has a NullValue.
boolean	hasValue()	Checks whether the variable has a configured Value.
protected boolean	isAttribute()	Returns whether this decision variable represents an attribute.
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.
final 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.
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).
(package private) boolean	ownStateAllowed()	Returns whether this variable can have its own IAssignmentState.
void	setHistoryValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup) from value history.
(package private) void	setIndex(int newIndex)	Changes the index of the nested DecisionVariable.
(package private) void	setState(IAssignmentState state)	For setting states of nested variables.
void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).
void	setValue(Value value, IAssignmentState state, boolean asAssignment)	Changes the value.
String	toString()
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, wait, wait, wait

Methods inherited from interface net.ssehub.easy.varModel.confModel.IConfigurationElement

freeze, setValue

Methods inherited from interface net.ssehub.easy.varModel.confModel.IDecisionVariable

getNestedElement, getNestedElementsCount, removeDerivedValues

Field Details

parent

private IConfigurationElement parent

configProvider

private VariableConfigProvider configProvider

declaration

private AbstractVariable declaration

attributes

private IDecisionVariable[] attributes

isVisible

private boolean isVisible

isAttribute

private boolean isAttribute

wasAssigned

private boolean wasAssigned

Constructor Details

DecisionVariable

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

Creates a new decision variable representing a specific decision. The assignment state will be AssignmentState.UNDEFINED.

Parameters:

parent - the parent this variable is part of, typically the Configuration instance, but in case of compounds/container also the holding 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

getAttributesCount

public int getAttributesCount()

Returns the number of attributes.

Specified by:

getAttributesCount in interface IDecisionVariable

Returns:

the number of attributes

getAttribute

public IDecisionVariable getAttribute(int index)

Returns a specific attribute.

Specified by:

getAttribute in interface IDecisionVariable

Parameters:

index - the index of the attribute

Returns:

the attribute

Throws:

IndexOutOfBoundsException - if index<0 || index>=getAttributesCount()

isNested

public final 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

getParent

public final 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 final Configuration getConfiguration()

Description copied from interface: IConfigurationElement

Returns the topLevel parent.

Specified by:

getConfiguration in interface IConfigurationElement

Returns:

should be the configuration

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)

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

getNestedElement

public IDecisionVariable getNestedElement(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)

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

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

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)

toString

public String toString()

Overrides:

toString in class Object

getNestedDepth

public final 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.

setIndex

void setIndex(int newIndex)

Changes the index of the nested DecisionVariable. This method is only supported if this variable is nested inside a ContainerVariable. This method must be called after a nested element was removed out of the container, to ensure that this variable will retrieve the correct sub value of the related ContainerVariable. this method will also ensure that this nested Variable will display the correct name.

Parameters:

newIndex - The new index inside the parent IDecisionVariable. This value must be in the range (this is not checked): (0 <= newIndex < getParent().getNestedElementsCount())

getConfigProvider

VariableConfigProvider getConfigProvider()

Getter for the VariableConfigProvider.

Returns:

Returns the VariableConfigProvider used in this class. This VariableConfigProvider should not be null, however, it can be null during initialization it can be null.

ownStateAllowed

boolean ownStateAllowed()

Returns whether this variable can have its own IAssignmentState.

Returns:

false if one of the parents is a ContainerVariable, otherwise it should be true.

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

isAttribute

protected boolean isAttribute()

Returns whether this decision variable represents an attribute.

Returns:

true for attribute, false else

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

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.

setState

void setState(IAssignmentState state)

For setting states of nested variables.

Parameters:

state - The state of the parent, which should the nested variable also have.

getQualifiedName

public 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

getPathForNestedElement

protected IResolutionPathElement getPathForNestedElement(IDecisionVariable nested)

Returns the resolution path for a nested element.

Parameters:

nested - the nested element

Returns:

the resolution path

getInstantiatableType

public IDatatype getInstantiatableType()

Returns one of the actual types required to instantiate this variable. This is typically the type of the underlying variable declaration, but, in case of abstract variables, may also be one of the subtypes if defined. As changing the value with a different permitted type leads to a take over of the respective dynamic type, the indeterminism shall not lead to problems.

Returns:

the instantiatable type

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

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 Enum.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().