Package net.ssehub.easy.varModel.confModel

Class ToplevelVarConfigProvider

java.lang.Object

net.ssehub.easy.varModel.confModel.VariableConfigProvider

net.ssehub.easy.varModel.confModel.ToplevelVarConfigProvider

class ToplevelVarConfigProvider
extends VariableConfigProvider

VariableConfigProvider for not nested variables.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private static final net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger	LOGGER
private IDecisionVariable	relatedVariable
private IAssignmentState	state
private Value	value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ToplevelVarConfigProvider(IDecisionVariable relatedVariable, Value value, IAssignmentState state)	Sole constructor for creating a VariableConfigProvider for a toplevel IDecisionVariable.

Method Summary

Modifier and Type	Method	Description
private Value	assignCompoundValue(CompoundValue value, IAssignmentState state, boolean allowDeletation, CompoundValue oldValue)	Assigns a CompoundValue.
private Value	assignContainerValue(ContainerValue conValue, IAssignmentState state, boolean allowDeletation)	Assigns a ContainerValue.
private void	assignValue(Value value, IAssignmentState state, boolean allowDeletation)	Assigns a value.
protected void	freeze(IFreezeSelector selector)	Causes to freeze the current value.
protected final Configuration	getConfiguration()	Return the Configuration where the related IDecisionVariable belongs to.
protected final AbstractVariable	getDeclaration()	Returns the Declaration of the related IDecisionVariable.
protected IAssignmentState	getState()	Returns the assignment state of this variable.
protected Value	getValue()	Returns the current value of this IDecisionVariable.
protected final boolean	isStateChangeAllowed()	Specifies whether the related IDecisionVariable can have its own IAssignmentState.
protected void	setHistoryValue(Value value, IAssignmentState state)	Changes the value from value history.
protected final void	setState(IAssignmentState state)	Setter for the IAssignmentState, needed by CompoundVariables.
protected void	setValue(Value value, IAssignmentState state)	Changes the value (for incremental buildup).
private void	setValueImpl(Value value)	Changes the value adjusting Value.setValueParent(net.ssehub.easy.varModel.model.values.IValueParent) the parent variable of the involved values).

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 Details

LOGGER

private static final net.ssehub.easy.basics.logger.EASyLoggerFactory.EASyLogger LOGGER

value

private Value value

state

private IAssignmentState state

relatedVariable

private IDecisionVariable relatedVariable

Constructor Details

ToplevelVarConfigProvider

protected ToplevelVarConfigProvider(IDecisionVariable relatedVariable,
 Value value,
 IAssignmentState state)

Sole constructor for creating a VariableConfigProvider for a toplevel IDecisionVariable.

Parameters:

relatedVariable - The IDecisionVariable where this VariableConfigProvider belongs to (must not be null).

value - The (initial) value of the related IDecisionVariable (can be null for lazy initialization).

state - The initial IAssignmentState of the related IDecisionVariable. In case of null the state will be set to AssignmentState.UNDEFINED.

Method Details

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.

isStateChangeAllowed

protected final boolean isStateChangeAllowed()

Description copied from class: VariableConfigProvider

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

Specified by:

isStateChangeAllowed in class VariableConfigProvider

Returns:

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

getDeclaration

protected final AbstractVariable getDeclaration()

Returns the Declaration of the related IDecisionVariable.

Specified by:

getDeclaration in class VariableConfigProvider

Returns:

IConfigurationElement.getDeclaration().

getConfiguration

protected final Configuration getConfiguration()

Return the Configuration where the related IDecisionVariable belongs to.

Specified by:

getConfiguration in class VariableConfigProvider

Returns:

IConfigurationElement.getConfiguration().

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

assignValue

private void assignValue(Value value,
 IAssignmentState state,
 boolean allowDeletation)
                  throws ConfigurationException

Assigns a value. The boolean parameter facilitates a differentiation between assignment of old values and new values. In case of old values, already assigned slots of a compound can be set to null. This must be avoided in case of new values (incremental build up).

Parameters:

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

state - the related assignment state

allowDeletation - true if null values can overwrite already set values of an compound.

Throws:

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

assignCompoundValue

private Value assignCompoundValue(CompoundValue value,
 IAssignmentState state,
 boolean allowDeletation,
 CompoundValue oldValue)
                           throws ConfigurationException

Assigns a CompoundValue.

Parameters:

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

state - the related assignment state

allowDeletation - true if null values can overwrite already set values of an compound.

oldValue - copy of value.

Returns:

value

Throws:

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

assignContainerValue

private Value assignContainerValue(ContainerValue conValue,
 IAssignmentState state,
 boolean allowDeletation)
                            throws ConfigurationException

Assigns a ContainerValue.

Parameters:

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

state - the related assignment state

allowDeletation - true if null values can overwrite already set values of an compound.

Returns:

value

Throws:

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

setValueImpl

private void setValueImpl(Value value)

Changes the value adjusting Value.setValueParent(net.ssehub.easy.varModel.model.values.IValueParent) the parent variable of the involved values).

Parameters:

value - the new value

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