Package net.ssehub.easy.varModel.confModel

Class VariableConfigProvider

java.lang.Object

net.ssehub.easy.varModel.confModel.VariableConfigProvider

Direct Known Subclasses:

NestedVarConfigProvider, ToplevelVarConfigProvider

abstract class VariableConfigProvider
extends Object

Delegate for handling the value and state of a IDecisionVariable. This provider returns an own value and state for the associated IDecisionVariable. The value of this provider can be a nested value of a structured variable or an own value of a top level variable.

Author:

El-Sharkawy

Constructor Summary

Constructors

Constructor	Description
VariableConfigProvider()

Method Summary

Modifier and Type	Method	Description
protected final void	freeze()	Causes to freeze the current value.
protected abstract void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
protected abstract Configuration	getConfiguration()	Return the configuration containing the related IDecisionVariable.
protected abstract AbstractVariable	getDeclaration()	Returns the declaration of the related IDecisionVariable.
protected abstract IAssignmentState	getState()	Returns the assignment state of this variable.
protected abstract Value	getValue()	Returns the current value of this IDecisionVariable.
protected abstract boolean	isStateChangeAllowed()	Specifies whether the related IDecisionVariable can have its own IAssignmentState.
protected abstract void	setHistoryValue(Value value, IAssignmentState state)	Changes the value from value history.
protected abstract void	setState(IAssignmentState state)	Setter for the IAssignmentState, needed by CompoundVariables.
protected abstract void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).
protected final void	unfreeze(IAssignmentState state)	Unfreezes this variable to the given state.

Methods inherited from class java.lang.Object

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

Constructor Details

VariableConfigProvider

VariableConfigProvider()

Method Details

getValue

protected abstract Value getValue()

Returns the current value of this IDecisionVariable.

Returns:

the value (may be null)

setValue

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

Changes the value (for incremental buildup).

Parameters:

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

state - the related assignment state

Throws:

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

setHistoryValue

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

Changes the value from value history.

Parameters:

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

state - the related assignment state

Throws:

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

getState

protected abstract IAssignmentState getState()

Returns the assignment state of this variable.

Returns:

the assignment state

freeze

protected abstract void freeze(IFreezeSelector selector)

Causes to freeze the current value.

Parameters:

selector - determines which parts shall be frozen

freeze

protected final void freeze()

Causes to freeze the current value.

unfreeze

protected final void unfreeze(IAssignmentState state)

Unfreezes this variable to the given state.

Parameters:

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

isStateChangeAllowed

protected abstract boolean isStateChangeAllowed()

Specifies whether the related IDecisionVariable can have its own IAssignmentState. In case of a nested IDecisionVariable of a StructuredVariable, this is not supported.

Returns:

true if the related IDecisionVariable can have its own IAssignmentState, otherwise false.

setState

protected abstract void setState(IAssignmentState state)

Setter for the IAssignmentState, needed by CompoundVariables.

Parameters:

state - The new IAssignmentState, which should be set.

getDeclaration

protected abstract AbstractVariable getDeclaration()

Returns the declaration of the related IDecisionVariable.

Returns:

IConfigurationElement.getDeclaration().

getConfiguration

protected abstract Configuration getConfiguration()

Return the configuration containing the related IDecisionVariable.

Returns:

IConfigurationElement.getConfiguration().