Package net.ssehub.easy.varModel.cstEvaluation

Class EvaluationContext

java.lang.Object

net.ssehub.easy.varModel.cstEvaluation.EvaluationContext

All Implemented Interfaces:

IConfiguration

Direct Known Subclasses:

EvaluationVisitor.EvaluationContextImpl

public abstract class EvaluationContext
extends java.lang.Object
implements IConfiguration

Some basic functionality required by the evaluators without exposing the EvaluationVisitor.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Locale	locale

Constructor Summary

Constructors

Constructor	Description
EvaluationContext()

Method Summary

Modifier and Type	Method	Description
void	addErrorMessage(java.lang.String message, int code)	Adds an evaluation error message.
void	addErrorMessage(java.lang.String message, IDecisionVariable variable, int code)	Adds an evaluation error message.
void	addErrorMessage(java.lang.Throwable throwable)	Adds an evaluation error message based on a throwable.
abstract void	addMessage(EvaluationVisitor.Message message)	Adds an evaluation message.
abstract boolean	allowAssignValues()	Returns whether values shall be assigned, i.e., the configuration may be changed.
abstract boolean	allowPropagation()	Returns whether the expression to be evaluated is a propagation.
(package private) void	clear()	Clears this instance for reuse.
abstract IAssignmentState	getAssignmentState()	Returns the global (target) assignment state for the actual evaluation.
java.text.Collator	getCollator()	Returns the collator corresponding to the actual locale of this context.
Value	getDereferencedValue(Value value)	Dereferences a value within this context.
java.util.Locale	getLocale()	Returns the actual locale for evaluation.
abstract IAssignmentState	getTargetState(IDecisionVariable variable)	Returns the target state of the evaluation for variable.
abstract void	issueWarning()	Indicates that the evaluation of this constraint shall lead to a warning.
abstract void	notifyChangeListener(IDecisionVariable variable, Value oldValue, IAssignmentState oldState, IValueChangeListener.ChangeKind kind)	Notifies the change listener, i.e., the value of variable has changed.
void	setLocale(java.util.Locale locale)	Changes the locale for evaluation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.varModel.confModel.IConfiguration

getAllInstances, getDecision

Field Detail

locale

private java.util.Locale locale

Constructor Detail

EvaluationContext

public EvaluationContext()

Method Detail

clear

void clear()

Clears this instance for reuse.

getLocale

public java.util.Locale getLocale()

Returns the actual locale for evaluation.

Returns:

the locale

setLocale

public void setLocale(java.util.Locale locale)

Changes the locale for evaluation.

Parameters:

locale - the new locale, ignored if null

getCollator

public java.text.Collator getCollator()

Returns the collator corresponding to the actual locale of this context.

Returns:

the collator

allowAssignValues

public abstract boolean allowAssignValues()

Returns whether values shall be assigned, i.e., the configuration may be changed.

Returns:

true if values shall be assigned, false else

notifyChangeListener

public abstract void notifyChangeListener(IDecisionVariable variable,
                                          Value oldValue,
                                          IAssignmentState oldState,
                                          IValueChangeListener.ChangeKind kind)

Notifies the change listener, i.e., the value of variable has changed.

Parameters:

variable - the changed variable

oldValue - the value of variable before the change (may be null)

oldState - the old state of variable before the change

kind - the change kind

addMessage

public abstract void addMessage(EvaluationVisitor.Message message)

Adds an evaluation message.

Parameters:

message - the message to be added

getTargetState

public abstract IAssignmentState getTargetState(IDecisionVariable variable)

Returns the target state of the evaluation for variable.

Parameters:

variable - the variable to return the target state for (do not modify!!!)

Returns:

the target state (may be null if the actual value cannot be assigned do to a state conflict)

addErrorMessage

public void addErrorMessage(java.lang.String message,
                            int code)

Adds an evaluation error message.

Parameters:

message - the message to be added

code - the error code

addErrorMessage

public void addErrorMessage(java.lang.String message,
                            IDecisionVariable variable,
                            int code)

Adds an evaluation error message.

Parameters:

message - the message to be added

variable - Optional IDecisionVariable which caused the error

code - the error code

addErrorMessage

public void addErrorMessage(java.lang.Throwable throwable)

Adds an evaluation error message based on a throwable.

Parameters:

throwable - the throwable carrying the message

issueWarning

public abstract void issueWarning()

Indicates that the evaluation of this constraint shall lead to a warning.

allowPropagation

public abstract boolean allowPropagation()

Returns whether the expression to be evaluated is a propagation.

Returns:

true if it is a propagation, i.e. propagation shall be allowed, false else

getDereferencedValue

public Value getDereferencedValue(Value value)

Dereferences a value within this context.

Parameters:

value - the value to dereference

Returns:

the dereferenced value (may be null if undefined)

getAssignmentState

public abstract IAssignmentState getAssignmentState()

Returns the global (target) assignment state for the actual evaluation. This may differ from getTargetState(IDecisionVariable).

Returns:

the assignment state