org.eclipse.ocl.examples.pivot
Class AbstractEnvironmentFactory

java.lang.Object
  org.eclipse.ocl.examples.pivot.AbstractEnvironmentFactory

All Implemented Interfaces:

Adaptable, EnvironmentFactory

Direct Known Subclasses:

PivotEnvironmentFactory

public abstract class AbstractEnvironmentFactory
extends java.lang.Object
implements EnvironmentFactory, Adaptable

Partial implementation of the EnvironmentFactory interface, useful for subclassing to define the OCL binding for a metamodel. This abstract class takes care of some of the more common (and mundane) chores, such as:

• defining the "self" variable in the classifier context
• creating variables for operation parameters in an operation context

The subclass's responsibility (in addition to implementing any other interface methods not implemented here) is to define how to:

• obtain the classifier in the user model of an input element (which may already be a classifier or an may be an M0 instance)
• lookup a package in the model associated with this environment factory

This class is intended to be extended by clients, for the purpose of implementing metamodel-specific environment factories.

See the EnvironmentFactory class for a description of the generic type parameters of this class.

Author:

Christian W. Damus (cdamus)

Constructor Summary

protected

AbstractEnvironmentFactory() Initializes me.

Method Summary

Environment	createClassifierContext(Environment parent, Type context) Creates an environment suitable for parsing OCL expressions in the specified context, which is some classifier in the client's model.
EvaluationVisitor	createEvaluationVisitor(Environment env, EvaluationEnvironment evalEnv, DomainModelManager modelManager) Creates a new evaluation visitor, for the evaluation of OCL expressions.
EvaluationVisitor	createEvaluationVisitor(Environment environment, java.lang.Object context, ExpressionInOCL expression, DomainModelManager modelManager) Creates a new evaluation visitor, for the evaluation of an OCL expression on a context using an environment and a modelManager.
Environment	createInstanceContext(Environment parent, java.lang.Object context) Creates an environment suitable for parsing OCL expressions on the specified context object, which is an instance of some classifier in the client's model.
Environment	createOperationContext(Environment parent, Operation operation) Creates an environment suitable for parsing OCL expressions on the specified operation, which is some operation in the client's metamodel.
protected Environment	createPackageContext(Environment parent, Package context) Creates an environment for the specified package context.
Environment	createPropertyContext(Environment parent, Property property) Creates an environment suitable for parsing OCL expressions on the specified property, which is some attribute in the client's metamodel.
<T> T	getAdapter(java.lang.Class<T> adapterType) The abstract environment factory implementation is adaptable.
protected abstract Type	getClassifier(java.lang.Object context) Obtains client metamodel's classifier for the specified context object, which may be an instance of a classifier in the user model or may actually be a classifier in the user model.
protected boolean	isEvaluationTracingEnabled() Queries whether tracing of evaluation is enabled.
void	setEvaluationTracingEnabled(boolean b) Sets whether tracing of evaluation is enabled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.examples.pivot.EnvironmentFactory

createEnvironment, createEnvironment, createEvaluationEnvironment, createEvaluationEnvironment, loadEnvironment

Constructor Detail

AbstractEnvironmentFactory

protected AbstractEnvironmentFactory()

Initializes me.

Method Detail

createPackageContext

protected Environment createPackageContext(@NonNull
                                           Environment parent,
                                           @NonNull
                                           Package context)

Creates an environment for the specified package context.

Parameters:

parent - the parent environment of the environment to be created

context - the package context (must not be null)

Returns:

the new nested environment

createClassifierContext

@NonNull
public Environment createClassifierContext(@NonNull
                                                   Environment parent,
                                                   @NonNull
                                                   Type context)

Description copied from interface: EnvironmentFactory

Creates an environment suitable for parsing OCL expressions in the specified context, which is some classifier in the client's model.

Specified by:

createClassifierContext in interface EnvironmentFactory

context - the context classifier

Returns:

the environment

See Also:

#createOperationContext(Environment, Object), #createAttributeContext(Environment, Object), EnvironmentFactory.createInstanceContext(Environment, Object)

createInstanceContext

@NonNull
public Environment createInstanceContext(@NonNull
                                                 Environment parent,
                                                 @NonNull
                                                 java.lang.Object context)

Description copied from interface: EnvironmentFactory

Creates an environment suitable for parsing OCL expressions on the specified context object, which is an instance of some classifier in the client's model.

The context may be an instance of a model class or a data type value on which an OCL expression would be evaluated. Note that the actual OCL context classifier (as an OCL type or classifier) will be inferred from the context instance according to the metamodel that the environment factory supports, if possible. If not possible, then the OclAny type is assumed.

Specified by:

createInstanceContext in interface EnvironmentFactory

context - the context object or value

Returns:

the environment

See Also:

#createClassifierContext(Environment, Object), DomainStandardLibrary#getOclAny()

createOperationContext

@NonNull
public Environment createOperationContext(@NonNull
                                                  Environment parent,
                                                  @NonNull
                                                  Operation operation)

Description copied from interface: EnvironmentFactory

Creates an environment suitable for parsing OCL expressions on the specified operation, which is some operation in the client's metamodel. Note that operation contexts can be defined in the context of any classifier to which that operation is applicable.

Specified by:

createOperationContext in interface EnvironmentFactory

Parameters:

parent - the parent environment, defining the classifier context

operation - an operation in the client's metamodel

Returns:

the environment

See Also:

#createClassifierContext(Environment, Object)

createPropertyContext

@NonNull
public Environment createPropertyContext(@NonNull
                                                 Environment parent,
                                                 @NonNull
                                                 Property property)

Description copied from interface: EnvironmentFactory

Creates an environment suitable for parsing OCL expressions on the specified property, which is some attribute in the client's metamodel. Note that attribute contexts can be defined in the context of any classifier in which that attribute is available.

Specified by:

createPropertyContext in interface EnvironmentFactory

Parameters:

parent - the parent environment, defining the classifier context

property - an attribute in the client's metamodel

Returns:

the environment

See Also:

#createClassifierContext(Environment, Object)

createEvaluationVisitor

@NonNull
public EvaluationVisitor createEvaluationVisitor(@Nullable
                                                         Environment environment,
                                                         @Nullable
                                                         java.lang.Object context,
                                                         @NonNull
                                                         ExpressionInOCL expression,
                                                         @Nullable
                                                         DomainModelManager modelManager)

Description copied from interface: EnvironmentFactory

Creates a new evaluation visitor, for the evaluation of an OCL expression on a context using an environment and a modelManager. If environment is null, a root environment is created and used. If context is null and the expression uses self subsequent evaluations will give invalid as the result. If modelManager is null, the context object's ResoutceSet is analyzed to create one.

Specified by:

createEvaluationVisitor in interface EnvironmentFactory

createEvaluationVisitor

@NonNull
public EvaluationVisitor createEvaluationVisitor(@NonNull
                                                         Environment env,
                                                         @NonNull
                                                         EvaluationEnvironment evalEnv,
                                                         @NonNull
                                                         DomainModelManager modelManager)

Description copied from interface: EnvironmentFactory

Creates a new evaluation visitor, for the evaluation of OCL expressions.

Specified by:

createEvaluationVisitor in interface EnvironmentFactory

Parameters:

env - the environment in which the expression was originally parsed (or some compatible environment)

evalEnv - the evaluation environment that the visitor is to use for tracking variables, navigating properties, etc.

modelManager - the map of Classes to their extends

Returns:

the new evaluation visitor

getClassifier

@NonNull
protected abstract Type getClassifier(@NonNull
                                              java.lang.Object context)

Obtains client metamodel's classifier for the specified context object, which may be an instance of a classifier in the user model or may actually be a classifier in the user model.

Parameters:

context - a context object or classifier

Returns:

the user model's classifier for this context object, or the context itself if it is a classifier

isEvaluationTracingEnabled

protected boolean isEvaluationTracingEnabled()

Queries whether tracing of evaluation is enabled. Tracing logs the progress of evaluation to the console, which may be of use in diagnosing problems.

In an Eclipse environment, tracing is also enabled by turning on the org.eclipse.ocl/debug/evaluation debug option.

Returns:

whether evaluation tracing is enabled

See Also:

setEvaluationTracingEnabled(boolean)

setEvaluationTracingEnabled

public void setEvaluationTracingEnabled(boolean b)

Sets whether tracing of evaluation is enabled. Tracing logs the progress of parsing to the console, which may be of use in diagnosing problems.

In an Eclipse environment, tracing is also enabled by turning on the org.eclipse.ocl/debug/evaluation debug option.

param b whether evaluation tracing is enabled

See Also:

isEvaluationTracingEnabled()

getAdapter

public <T> T getAdapter(java.lang.Class<T> adapterType)

The abstract environment factory implementation is adaptable. The default implementation adapts to and interface actually implemented by the receiver.

Subclasses may override or extend this implementation.

Specified by:

getAdapter in interface Adaptable

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