Package net.ssehub.easy.varModel.confModel

Class CompoundItemConfigProvider

java.lang.Object

net.ssehub.easy.varModel.confModel.VariableConfigProvider

net.ssehub.easy.varModel.confModel.NestedVarConfigProvider

net.ssehub.easy.varModel.confModel.CompoundItemConfigProvider

class CompoundItemConfigProvider
extends NestedVarConfigProvider

VariableConfigProvider for nested Elements of a ContainerVariable.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	slotName
private IAssignmentState	state

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompoundItemConfigProvider(CompoundVariable parent, java.lang.String slotName)	Sole constructor for creating a VariableConfigProvider for nested elements of a compound.

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 CompoundVariable	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.
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

slotName

private java.lang.String slotName

state

private IAssignmentState state

Constructor Detail

CompoundItemConfigProvider

protected CompoundItemConfigProvider(CompoundVariable parent,
                                     java.lang.String slotName)

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

Parameters:

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

slotName - The parent's slotName of the nested IDecisionVariable where this provider belongs to.

Method Detail

getParent

protected CompoundVariable 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.

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

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