org.eclipse.ocl.pivot.internal.evaluation

Class BasicEvaluationEnvironment

java.lang.Object

org.eclipse.ocl.pivot.internal.evaluation.AbstractCustomizable

org.eclipse.ocl.pivot.internal.evaluation.BasicEvaluationEnvironment

All Implemented Interfaces:

EvaluationEnvironment, EvaluationEnvironment.EvaluationEnvironmentExtension, Adaptable, Customizable

Direct Known Subclasses:

AbstractVMEvaluationEnvironment

public class BasicEvaluationEnvironment
extends AbstractCustomizable
implements EvaluationEnvironment.EvaluationEnvironmentExtension

Basic implementation of the EvaluationEnvironment interface, providing some useful common behaviors. Implementors of metamodel-specific environments are encourage to extend this class rather than implement an evaluation environment "from scratch."

Author:

Christian W. Damus (cdamus)

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.evaluation.EvaluationEnvironment

EvaluationEnvironment.EvaluationEnvironmentExtension

Constructor Summary

Constructors

Constructor and Description
BasicEvaluationEnvironment(EnvironmentFactory environmentFactory, NamedElement executableObject, ModelManager modelManager) Deprecated. use an executor
BasicEvaluationEnvironment(EvaluationEnvironment.EvaluationEnvironmentExtension parent, NamedElement executableObject, Object caller)
BasicEvaluationEnvironment(EvaluationEnvironment.EvaluationEnvironmentExtension parent, NamedElement executableObject, OCLExpression caller) Deprecated. use TypedElement argument.
BasicEvaluationEnvironment(EvaluationEnvironment parent, NamedElement executableObject) Deprecated. supply a callingObject
BasicEvaluationEnvironment(ExecutorInternal executor, NamedElement executableObject)

Method Summary

Modifier and Type	Method and Description
void	add(TypedElement referredVariable, Object value) Adds the supplied referredVariable and value binding to the environment
void	clear() Clears the environment of variables.
void	dispose() Dispose of any owned objects.
<T> T	getAdapter(Class<T> adapterType) Implements the interface method by testing whether I am an instance of the requested adapter type.
EnvironmentFactory	getEnvironmentFactory()
NamedElement	getExecutableObject()
ExecutorInternal	getExecutor()
ModelManager	getModelManager() Deprecated. moved to Evaluator
EvaluationEnvironment	getParent()
EvaluationEnvironment.EvaluationEnvironmentExtension	getParentEvaluationEnvironment()
<T> T	getValue(Option<T> option) Obtains the value of the specified option's setting in the my options map.
Object	getValueOf(TypedElement referredVariable) Returns the value associated with the supplied referredVariable
Set<TypedElement>	getVariables() Return the set of all locally registered variables.
Object	remove(TypedElement referredVariable) Removes the supplied referredVariable and binding from the environment (if it exists) and returns it.
void	replace(TypedElement referredVariable, Object value) Replaces the current value of the supplied referredVariable with the supplied value.
String	toString() Returns a string representation of the bindings

Methods inherited from class org.eclipse.ocl.pivot.internal.evaluation.AbstractCustomizable

clearOptions, getOptions, isEnabled, putOptions, removeOption, removeOptions, setOption

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.ocl.pivot.utilities.Customizable

clearOptions, getOptions, isEnabled, putOptions, removeOption, removeOptions, setOption

Constructor Detail

BasicEvaluationEnvironment

@Deprecated
public BasicEvaluationEnvironment(EnvironmentFactory environmentFactory,
                                              NamedElement executableObject,
                                              ModelManager modelManager)

Deprecated. use an executor

BasicEvaluationEnvironment

public BasicEvaluationEnvironment(ExecutorInternal executor,
                                  NamedElement executableObject)

Since:

1.1

BasicEvaluationEnvironment

@Deprecated
public BasicEvaluationEnvironment(EvaluationEnvironment parent,
                                              NamedElement executableObject)

Deprecated. supply a callingObject

BasicEvaluationEnvironment

public BasicEvaluationEnvironment(EvaluationEnvironment.EvaluationEnvironmentExtension parent,
                                  NamedElement executableObject,
                                  Object caller)

Since:

1.3

BasicEvaluationEnvironment

@Deprecated
public BasicEvaluationEnvironment(EvaluationEnvironment.EvaluationEnvironmentExtension parent,
                                              NamedElement executableObject,
                                              OCLExpression caller)

Deprecated. use TypedElement argument.

Since:

1.1

Method Detail

add

public void add(TypedElement referredVariable,
                Object value)

Adds the supplied referredVariable and value binding to the environment

Specified by:

add in interface EvaluationEnvironment

Parameters:

referredVariable - the referredVariable to add

value - the associated binding

See Also:

EvaluationEnvironment.replace(TypedElement, Object)

clear

public void clear()

Clears the environment of variables.

Specified by:

clear in interface EvaluationEnvironment

dispose

public void dispose()

Dispose of any owned objects.

Specified by:

dispose in interface EvaluationEnvironment

getAdapter

public <T> T getAdapter(Class<T> adapterType)

Implements the interface method by testing whether I am an instance of the requested adapter type.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class AbstractCustomizable

Type Parameters:

T - the requested adapter interface

Parameters:

adapterType - the requested adapter interface

Returns:

an instance of the requested interface, or null if this environment does not adapt to it

getEnvironmentFactory

public EnvironmentFactory getEnvironmentFactory()

Specified by:

getEnvironmentFactory in interface EvaluationEnvironment

getExecutableObject

public NamedElement getExecutableObject()

Specified by:

getExecutableObject in interface EvaluationEnvironment

getExecutor

public ExecutorInternal getExecutor()

Specified by:

getExecutor in interface EvaluationEnvironment.EvaluationEnvironmentExtension

Since:

1.1

getModelManager

@Deprecated
public ModelManager getModelManager()

Deprecated. moved to Evaluator

Specified by:

getModelManager in interface EvaluationEnvironment

getParent

public EvaluationEnvironment getParent()

getParentEvaluationEnvironment

public EvaluationEnvironment.EvaluationEnvironmentExtension getParentEvaluationEnvironment()

Specified by:

getParentEvaluationEnvironment in interface EvaluationEnvironment.EvaluationEnvironmentExtension

Since:

1.1

getValue

public <T> T getValue(Option<T> option)

Description copied from interface: Customizable

Obtains the value of the specified option's setting in the my options map. Options not explicitly set in an environment are inherited from the parent environment, if any, otherwise they are at their default values.

Specified by:

getValue in interface Customizable

Overrides:

getValue in class AbstractCustomizable

Parameters:

option - the option to query

Returns:

value of the option

getValueOf

public Object getValueOf(TypedElement referredVariable)

Returns the value associated with the supplied referredVariable

Specified by:

getValueOf in interface EvaluationEnvironment

Parameters:

referredVariable - the referredVariable whose value is to be returned

Returns:

the value associated with the referredVariable

getVariables

public Set<TypedElement> getVariables()

Description copied from interface: EvaluationEnvironment

Return the set of all locally registered variables.

Specified by:

getVariables in interface EvaluationEnvironment

remove

public Object remove(TypedElement referredVariable)

Removes the supplied referredVariable and binding from the environment (if it exists) and returns it.

Specified by:

remove in interface EvaluationEnvironment

Parameters:

referredVariable - the referredVariable to remove

Returns:

the value associated with the removed referredVariable

replace

public void replace(TypedElement referredVariable,
                    Object value)

Replaces the current value of the supplied referredVariable with the supplied value.

Specified by:

replace in interface EvaluationEnvironment

Parameters:

referredVariable - the referredVariable

value - the new value

toString

public String toString()

Returns a string representation of the bindings

Overrides:

toString in class Object