Package net.ssehub.easy.varModel.cstEvaluation

Class CompoundSlotAccessor

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.EvaluationAccessor

net.ssehub.easy.varModel.cstEvaluation.AbstractDecisionVariableEvaluationAccessor

net.ssehub.easy.varModel.cstEvaluation.CompoundSlotAccessor

class CompoundSlotAccessor
extends AbstractDecisionVariableEvaluationAccessor

Implements an accessor for decision variables.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
static Pool<CompoundSlotAccessor>	POOL
private IDecisionVariable	slotVariable

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompoundSlotAccessor()	Creates an instance.

Method Summary

Modifier and Type	Method	Description
private boolean	assignValue(Value value, boolean asAssignment)	Assigns the value.
CompoundSlotAccessor	bind(IDecisionVariable variable, java.lang.String slotName, EvaluationContext context)	Binds the accessor to the given variable and context.
CompoundSlotAccessor	bind(LocalDecisionVariable variable, java.lang.String slotName, EvaluationContext context)	Binds the accessor to the given variable and context.
void	clear()	Clears the accessor for reuse.
Value	getValue()	Returns the value of the accessed element.
EvaluationAccessor	getValue(EvaluationAccessor accessor)	Returns a nested value based on the given accessor.
IDecisionVariable	getVariable()	Returns the underlying variable.
boolean	isAssignable()	Returns whether values can be assigned to this evaluator.
void	release()	Releases this instance.
boolean	setValue(Value value, boolean asAssignment)	Defines a new value for the accessed element.

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

bind, getReferenceValue, 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, setValue, 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<CompoundSlotAccessor> POOL

slotVariable

private IDecisionVariable slotVariable

Constructor Detail

CompoundSlotAccessor

private CompoundSlotAccessor()

Creates an instance. Private due to pooling.

Method Detail

bind

public CompoundSlotAccessor bind(IDecisionVariable variable,
                                 java.lang.String slotName,
                                 EvaluationContext context)

Binds the accessor to the given variable and context.

Parameters:

variable - the underlying variable

slotName - the name of the slot within value

context - the evaluation context

Returns:

this (builder pattern)

bind

public CompoundSlotAccessor bind(LocalDecisionVariable variable,
                                 java.lang.String slotName,
                                 EvaluationContext context)

Binds the accessor to the given variable and context.

Parameters:

variable - the underlying variable

slotName - the name of the slot within value

context - the evaluation context

Returns:

this (builder pattern)

clear

public void clear()

Description copied from class: EvaluationAccessor

Clears the accessor for reuse.

Overrides:

clear in class AbstractDecisionVariableEvaluationAccessor

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)

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

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

assignValue

private final boolean assignValue(Value value,
                                  boolean asAssignment)

Assigns the value.

Parameters:

value - the value

asAssignment - does this happen through an IVML assignment operation

Returns:

whether the assignment was successful or not

getVariable

public IDecisionVariable getVariable()

Description copied from class: EvaluationAccessor

Returns the underlying variable.

Overrides:

getVariable in class AbstractDecisionVariableEvaluationAccessor

Returns:

the underlying variable (may be null)

release

public void release()

Description copied from class: EvaluationAccessor

Releases this instance.

Specified by:

release in class EvaluationAccessor

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