Package net.ssehub.easy.varModel.confModel

Class CompoundVariable

java.lang.Object

net.ssehub.easy.varModel.confModel.DecisionVariable

net.ssehub.easy.varModel.confModel.StructuredVariable

net.ssehub.easy.varModel.confModel.CompoundVariable

All Implemented Interfaces:

IConfigurationElement, IConfigurationVisitable, IDecisionVariable, IValueParent

public class CompoundVariable
extends StructuredVariable

Class for variables of Compounds.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	created
private Compound	instantiatableType
private Map<String,IDecisionVariable>	nestedElements

Constructor Summary

Constructors

Constructor	Description
CompoundVariable(IConfigurationElement parent, AbstractVariable varDeclaration, boolean isVisible, boolean isAttribute)	Sole constructor for creating ContainerVariable's.

Method Summary

Modifier and Type	Method	Description
(package private) boolean	allowsNestedStates()	Returns whether this variable support individual states for nested items.
private IDecisionVariable	createNestedElement(AbstractVariable decl, boolean isVisible, boolean isAttribute, boolean force)	Creates a nested element due to its declaration and registers it.
boolean	enableWasAssignedForIsDefined()	Shall we take the local IDecisionVariable.wasAssigned() over IConfigurationElement.getState() in the implementation of IVML "isDefined".
void	freeze(String nestedElement)	Causes to freeze a nested value.
void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
IDatatype	getInstantiatableType()	Returns one of the actual types required to instantiate this variable.
protected net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger	getLogger()	Returns the logger for this instance.
IDecisionVariable	getNestedElement(int index)	Returns the element specified by index.
IDecisionVariable	getNestedElement(String name)	Returns an element specified by its name.
int	getNestedElementsCount()	Returns the number of nested elements.
IDecisionVariable	getNestedVariable(String slotName)	Returns a nested IDecisionVariable.
protected IResolutionPathElement	getPathForNestedElement(IDecisionVariable nested)	Returns the resolution path for a nested element.
IAssignmentState	getState()	Returns the assignment state of this variable.
Value	getValue()	Returns the current value of this IDecisionVariable.
private boolean	isDirectTypeRecursive(AbstractVariable slot)	Returns whether slot has a directly recursive type (same or somehow refined) to the containing type.
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).
boolean	removeDerivedValues()	Removes all (nested) values which are in state AssignmentState.DERIVED, i.e., all values which are propagated bay the reasoner.
private void	resolveAssignBlocks(AttributeAssignment assignBlock, Map<String,Value> annotationValues)	Second recursive part of resolveAssignBlocks(Compound), find (nested assign blocks) inside the currently visited compound and set values to the associated IDecisionVariables.
private void	resolveAssignBlocks(Compound cType)	Recursive part of the constructor to resolve annotation assignment blocks of (parent/this) compound.
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.
void	unfreeze(IAssignmentState state)	Causes to unfreeze the current value.
boolean	wasCreated()	Returns whether the variable value was explicitly created.

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

accept, getAttribute, getAttributesCount, getConfigProvider, getConfiguration, getDeclaration, getNestedDepth, getParent, getQualifiedName, getResolutionPath, hasNullValue, hasValue, isAttribute, isLocal, isNested, isVisible, ownStateAllowed, setHistoryValue, setIndex, setState, setValue, toString, wasAssigned

Methods inherited from class java.lang.Object

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

Field Details

nestedElements

private Map<String,IDecisionVariable> nestedElements

instantiatableType

private Compound instantiatableType

created

private boolean created

Constructor Details

CompoundVariable

CompoundVariable(IConfigurationElement parent,
 AbstractVariable varDeclaration,
 boolean isVisible,
 boolean isAttribute)

Sole constructor for creating ContainerVariable's.

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

getInstantiatableType

public IDatatype getInstantiatableType()

Description copied from class: DecisionVariable

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.

Overrides:

getInstantiatableType in class DecisionVariable

Returns:

the instantiatable type

resolveAssignBlocks

private void resolveAssignBlocks(Compound cType)

Recursive part of the constructor to resolve annotation assignment blocks of (parent/this) compound.

Parameters:

cType - The currently analyzed compound (should be called the (refined) compound type of this variable instance).

resolveAssignBlocks

private void resolveAssignBlocks(AttributeAssignment assignBlock,
 Map<String,Value> annotationValues)

Second recursive part of resolveAssignBlocks(Compound), find (nested assign blocks) inside the currently visited compound and set values to the associated IDecisionVariables.

Parameters:

assignBlock - The currently visited assign block (start with assign blocks directly nested inside the compound).

annotationValues - Mapping of (annotation name, value). Start with an empty map and copy values into a new map for each recursive call.

isDirectTypeRecursive

private boolean isDirectTypeRecursive(AbstractVariable slot)

Returns whether slot has a directly recursive type (same or somehow refined) to the containing type.

Parameters:

slot - the slot to look for

Returns:

true in case of a directly recursive type, false else

createNestedElement

private IDecisionVariable createNestedElement(AbstractVariable decl,
 boolean isVisible,
 boolean isAttribute,
 boolean force)

Creates a nested element due to its declaration and registers it.

Parameters:

decl - the variable declaration

isVisible - specifies whether the parent variable is exported by an interface or not

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

force - enforce creation of nested element even if isDirectTypeRecursive(AbstractVariable)

Returns:

the created variable, null if creation did not happen or failed (see log)

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

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

getNestedElement

public IDecisionVariable getNestedElement(String name)

Description copied from interface: IDecisionVariable

Returns an element specified by its name.

Specified by:

getNestedElement in interface IDecisionVariable

Overrides:

getNestedElement in class DecisionVariable

Parameters:

name - the name of the nested element

Returns:

the nested element (may be null)

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

Changes the value (for incremental buildup).
Sets also the states for the nested elements.

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

getNestedVariable

public IDecisionVariable getNestedVariable(String slotName)

Returns a nested IDecisionVariable.

Parameters:

slotName - The name of the nested IDecisionVariable to be returned.

Returns:

The nested IDecisionVariable with the same name or null.

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.

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

unfreeze

public void unfreeze(IAssignmentState state)

Description copied from interface: IConfigurationElement

Causes to unfreeze the current value.

Specified by:

unfreeze in interface IConfigurationElement

Overrides:

unfreeze in class DecisionVariable

Parameters:

state - the target state for unfreezing (must not be AssignmentState.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.

getValue

public Value getValue()

Description copied from interface: IDecisionVariable

Returns the current value of this IDecisionVariable.

Specified by:

getValue in interface IDecisionVariable

Overrides:

getValue in class DecisionVariable

Returns:

the value (may be null)

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.

getPathForNestedElement

protected IResolutionPathElement getPathForNestedElement(IDecisionVariable nested)

Returns the resolution path for a nested element.

Overrides:

getPathForNestedElement in class DecisionVariable

Parameters:

nested - the nested element

Returns:

the resolution path

getLogger

protected net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger getLogger()

Returns the logger for this instance.

Returns:

the logger

notifyCreated

public void notifyCreated()

Description copied from interface: IDecisionVariable

Notifies this variable that it was created.

Specified by:

notifyCreated in interface IDecisionVariable

Overrides:

notifyCreated in class DecisionVariable

wasCreated

public boolean wasCreated()

Description copied from interface: IConfigurationElement

Returns whether the variable value was explicitly created.

Specified by:

wasCreated in interface IConfigurationElement

Overrides:

wasCreated in class DecisionVariable

Returns:

true for created, 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

Overrides:

enableWasAssignedForIsDefined in class DecisionVariable

Returns:

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

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