Package net.ssehub.easy.varModel.confModel

Class ContainerItemConfigProvider

java.lang.Object

net.ssehub.easy.varModel.confModel.VariableConfigProvider

net.ssehub.easy.varModel.confModel.NestedVarConfigProvider

net.ssehub.easy.varModel.confModel.ContainerItemConfigProvider

class ContainerItemConfigProvider
extends NestedVarConfigProvider

VariableConfigProvider for nested variables of a ContainerVariable.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private int	index	this index is used to retrieve the correct sub value of the parent ContainerVariable.
private IAssignmentState	state

Constructor Summary

Constructors

Constructor	Description
ContainerItemConfigProvider(ContainerVariable parent, int index)	Sole constructor for creating a VariableConfigProvider for nested elements of a container.

Method Summary

Modifier and Type	Method	Description
protected void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
protected AbstractVariable	getDeclaration()	Returns the declaration of the related IDecisionVariable.
protected ContainerVariable	getParent()	Returns the StructuredVariable which hold the related IDecisionVariable where this provider belongs to.
protected IAssignmentState	getState()	Returns the assignment state of this variable.
protected Value	getValue()	Returns the current value of this IDecisionVariable.
protected void	setHistoryValue(Value value, IAssignmentState state)	Changes the value from value history.
(package private) void	setIndex(int newIndex)	Setter for the index.
protected void	setState(IAssignmentState state)	Setter for the IAssignmentState, needed by CompoundVariables.
protected void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).

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

getConfiguration, isStateChangeAllowed

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

freeze, unfreeze

Methods inherited from class java.lang.Object

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

Field Detail

index

private int index

this index is used to retrieve the correct sub value of the parent ContainerVariable.

state

private IAssignmentState state

Constructor Detail

ContainerItemConfigProvider

ContainerItemConfigProvider(ContainerVariable parent,
                            int index)

Sole constructor for creating a VariableConfigProvider for nested elements of a container.

Parameters:

parent - A CompoundVariable which will hold the nested IDecisionVariable where this provider belongs to.

index - The index of the nested IDecisionVariable inside the prant.

Method Detail

getValue

protected Value getValue()

Description copied from class: VariableConfigProvider

Returns the current value of this IDecisionVariable.

Specified by:

getValue in class VariableConfigProvider

Returns:

the value (may be null)

setValue

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

Description copied from class: VariableConfigProvider

Changes the value (for incremental buildup).

Specified by:

setValue in class VariableConfigProvider

Parameters:

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

state - the related assignment state

Throws:

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

getState

protected IAssignmentState getState()

Description copied from class: VariableConfigProvider

Returns the assignment state of this variable.

Specified by:

getState in class VariableConfigProvider

Returns:

the assignment state

setState

protected void setState(IAssignmentState state)

Description copied from class: VariableConfigProvider

Setter for the IAssignmentState, needed by CompoundVariables.

Specified by:

setState in class VariableConfigProvider

Parameters:

state - The new IAssignmentState, which should be set.

getDeclaration

protected AbstractVariable getDeclaration()

Description copied from class: VariableConfigProvider

Returns the declaration of the related IDecisionVariable.

Specified by:

getDeclaration in class VariableConfigProvider

Returns:

IConfigurationElement.getDeclaration().

getParent

protected ContainerVariable getParent()

Description copied from class: NestedVarConfigProvider

Returns the StructuredVariable which hold the related IDecisionVariable where this provider belongs to.

Overrides:

getParent in class NestedVarConfigProvider

Returns:

The StructuredVariable which hold the related IDecisionVariable.

setIndex

void setIndex(int newIndex)

Setter for the index. Should only be used inside the ContainerVariable classes to adjust the index after one element as been removed from the list of nested elements.

Parameters:

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

setHistoryValue

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

Description copied from class: VariableConfigProvider

Changes the value from value history.

Specified by:

setHistoryValue in class VariableConfigProvider

Parameters:

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

state - the related assignment state

Throws:

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

freeze

protected void freeze(IFreezeSelector selector)

Description copied from class: VariableConfigProvider

Causes to freeze the current value.

Specified by:

freeze in class VariableConfigProvider

Parameters:

selector - determines which parts shall be frozen