Package net.ssehub.easy.varModel.cstEvaluation

Class VariableAccessor

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.EvaluationAccessor

net.ssehub.easy.varModel.cstEvaluation.AbstractDecisionVariableEvaluationAccessor

net.ssehub.easy.varModel.cstEvaluation.VariableAccessor

class VariableAccessor
extends AbstractDecisionVariableEvaluationAccessor

Implements an accessor for decision variables.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
static Pool<VariableAccessor>	POOL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	VariableAccessor()	Creates an instance.

Method Summary

Modifier and Type	Method	Description
VariableAccessor	bind(IDecisionVariable variable, EvaluationContext context)	Binds the accessor to the given (non-local) variable and context.
VariableAccessor	bind(IDecisionVariable variable, EvaluationContext context, boolean isLocal)	Binds the accessor to the given (local or non-local) variable and context.
VariableAccessor	bind(AbstractVariable variable, EvaluationContext context)	Binds the accessor to the given variable and context.
private java.lang.Integer	getIndex(ContainerValue value, EvaluationAccessor accessor)	Returns the (valid) index from accessor for value.
Value	getValue()	Returns the value of the accessed element.
EvaluationAccessor	getValue(EvaluationAccessor accessor)	Returns a nested value based on the given accessor.
boolean	isAssignable()	Returns whether values can be assigned to this evaluator.
void	release()	Releases this instance.
void	setValue(EvaluationAccessor accessor, Value value)	Changes a nested value based on the given accessor.
private boolean	setValue(EvaluationContext context, Value value, boolean asAssignment)	Changes the value within the given evaluation context.
boolean	setValue(Value value, boolean asAssignment)	Defines a new value for the accessed element.

Methods inherited from class net.ssehub.easy.varModel.cstEvaluation.AbstractDecisionVariableEvaluationAccessor

clear, getReferenceValue, getVariable, isLocal, notifyVariableChange, toString

Methods inherited from class net.ssehub.easy.varModel.cstEvaluation.EvaluationAccessor

addBoundContainerElement, addBoundContainerElement, bind, bindContainer, bindContainer, clearContainerElements, dereferenceIfNeeded, getBoundContainerElement, getBoundContainerElementCount, getContext, getDereferencedValue, isAssigned, isConstant, release, validateContext

Methods inherited from class java.lang.Object

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

Field Detail

POOL

public static final Pool<VariableAccessor> POOL

Constructor Detail

VariableAccessor

private VariableAccessor()

Creates an instance. Private due to pooling.

Method Detail

bind

public VariableAccessor bind(AbstractVariable variable,
                             EvaluationContext context)

Binds the accessor to the given variable and context.

Parameters:

variable - the underlying variable

context - the evaluation context

Returns:

this (builder pattern)

bind

public VariableAccessor bind(IDecisionVariable variable,
                             EvaluationContext context)

Binds the accessor to the given (non-local) variable and context.

Overrides:

bind in class AbstractDecisionVariableEvaluationAccessor

Parameters:

variable - the underlying variable

context - the evaluation context

Returns:

this (builder pattern)

bind

public VariableAccessor bind(IDecisionVariable variable,
                             EvaluationContext context,
                             boolean isLocal)

Binds the accessor to the given (local or non-local) variable and context.

Parameters:

variable - the underlying variable

context - the evaluation context

isLocal - whether the variable is local and does not need a target state check

Returns:

this (builder pattern)

getValue

public Value getValue()

Description copied from class: EvaluationAccessor

Returns the value of the accessed element.

Specified by:

getValue in class EvaluationAccessor

Returns:

the value (may be null if undefined)

setValue

public boolean setValue(Value value,
                        boolean asAssignment)

Description copied from class: EvaluationAccessor

Defines a new value for the accessed element. In case of failures, add appropriate messages to the context.

Specified by:

setValue in class EvaluationAccessor

Parameters:

value - the new value

asAssignment - does this happen through an IVML assignment operation

Returns:

true if successful, false else

setValue

private boolean setValue(EvaluationContext context,
                         Value value,
                         boolean asAssignment)

Changes the value within the given evaluation context.

Parameters:

context - the evaluation context

value - the new value

asAssignment - called within an assignment or equality expression

Returns:

true for success, false else

isAssignable

public boolean isAssignable()

Description copied from class: EvaluationAccessor

Returns whether values can be assigned to this evaluator.

Specified by:

isAssignable in class EvaluationAccessor

Returns:

true if values can be assigned, false else

getValue

public EvaluationAccessor getValue(EvaluationAccessor accessor)

Description copied from class: EvaluationAccessor

Returns a nested value based on the given accessor.

Overrides:

getValue in class EvaluationAccessor

Parameters:

accessor - the accessor to determine the nested value

Returns:

the nested value

getIndex

private java.lang.Integer getIndex(ContainerValue value,
                                   EvaluationAccessor accessor)

Returns the (valid) index from accessor for value.

Parameters:

value - the container to be accessed

accessor - the accessor expression

Returns:

the index value (invalid if null)

setValue

public void setValue(EvaluationAccessor accessor,
                     Value value)

Changes a nested value based on the given accessor.

Overrides:

setValue in class EvaluationAccessor

Parameters:

accessor - the accessor to determine the nested value

value - the new nested value

release

public void release()

Description copied from class: EvaluationAccessor

Releases this instance.

Specified by:

release in class EvaluationAccessor