org.eclipse.ocl.ecore

Class EcoreEnvironmentFactory

java.lang.Object

org.eclipse.ocl.AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

org.eclipse.ocl.ecore.EcoreEnvironmentFactory

All Implemented Interfaces:

EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>, Adaptable

Direct Known Subclasses:

EcoreEnvironmentFactoryWithHiddenOpposites

public class EcoreEnvironmentFactory
extends AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Implementation of the EnvironmentFactory for parsing OCL expressions on Ecore models.

Author:

Christian W. Damus (cdamus)

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.EnvironmentFactory

EnvironmentFactory.Lookup<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Field Summary

Fields

Modifier and Type	Field and Description
static EcoreEnvironmentFactory	INSTANCE A convenient shared instance of the environment factory, that creates environments using the global package registry.

Constructor Summary

Constructors

Constructor and Description
EcoreEnvironmentFactory() Initializes me.
EcoreEnvironmentFactory(EPackage.Registry reg) Initializes me with an EPackage.Registry that the environments I create will use to look up packages.

Method Summary

Modifier and Type	Method and Description
Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>	createEnvironment() Creates a root environment, in which package contexts and/or classifier contexts will be created as nested environments.
Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>	createEnvironment(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> parent) Creates a child environment of a specified parent, for definition of nested scopes.
EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject>	createEvaluationEnvironment() Creates a new evaluation environment to track the values of variables in an OCL expression as it is evaluated.
EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject>	createEvaluationEnvironment(EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> parent) Creates a new evaluation environment as a nested environment of the specified parent.
EvaluationVisitor<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>	createEvaluationVisitor(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env, EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> evalEnv, Map<? extends EClass,? extends Set<? extends EObject>> extentMap) Creates a new evaluation visitor, for the evaluation of OCL expressions.
OCLAnalyzer	createOCLAnalyzer(AbstractOCLParser parser) Creates an instance of the OCLAnalyzer that will use a given parser to perform syntactic and lexical analysis.
OCLAnalyzer	createOCLAnalyzer(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env, String input) Creates an instance of the OCLAnalyzer that analyzes the given input on behalf of this environment.
OCLFactoryWithHistory	createOCLFactoryWithHistory(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env) Creates an instance of the OCLFactoryWithHistory object for this environment.
OCLSyntaxHelper	createOCLSyntaxHelper(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env) Creates an instance of the OCLSyntaxHelper object for this environment.
Visitor<Boolean,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint>	createValidationVisitor(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env) Obtains an instance of the validation visitor that validates against the specified environment, which presumably was used in parsing the OCL in the first place.
EPackage.Registry	getEPackageRegistry() Obtains the package registry used by environment that I create to look up packages.
OppositeEndFinder	getOppositeEndFinder()
Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>	loadEnvironment(Resource resource) Loads an environment from the specified resource.

Methods inherited from class org.eclipse.ocl.AbstractEnvironmentFactory

createAttributeContext, createClassifierContext, createInstanceContext, createOperationContext, createPackageContext, getAdapter

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static EcoreEnvironmentFactory INSTANCE

A convenient shared instance of the environment factory, that creates environments using the global package registry.

Constructor Detail

EcoreEnvironmentFactory

public EcoreEnvironmentFactory()

Initializes me. Environments that I create will use the global package registry to look up packages.

EcoreEnvironmentFactory

public EcoreEnvironmentFactory(EPackage.Registry reg)

Initializes me with an EPackage.Registry that the environments I create will use to look up packages.

Parameters:

reg - my package registry (must not be null). Package descriptors that are not yet resolved will not be resolved for OCL package name lookups. To ensure that packages can be referenced by their name, clients shall EPackage.Registry.getEPackage(String) those packages explicitly before asking OCL to look them up. See also ParsingOptions.PACKAGE_LOOKUP_STRATEGY for different package lookup strategies. Note also, that if a "delegating registry" is used, packages contained only by the delegate will not be found by an OCL lookup because EPackage.Registry.values() only enumerates the packages / descriptors contained by the outer registry.

Method Detail

createEnvironment

public Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> createEnvironment()

Description copied from interface: EnvironmentFactory

Creates a root environment, in which package contexts and/or classifier contexts will be created as nested environments. All operation body constraints, attribute initial/derived value constraints, and definitions of additional attributes and operations should be maintained by the root environment, so that they will be accessible from constraints parsed in any nested environment.

Returns:

a new root environment

loadEnvironment

public Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> loadEnvironment(Resource resource)

Description copied from interface: EnvironmentFactory

Loads an environment from the specified resource. If not already loaded, this method will load the resource. This resource will subsequently be used to persist new OCL constraints, so supplying a new, empty resource will allow the client to determine where the environment is persisted.

Parameters:

resource - a resource containing the persisted environment

getEPackageRegistry

public final EPackage.Registry getEPackageRegistry()

Obtains the package registry used by environment that I create to look up packages.

Returns:

my package registry

createEnvironment

public Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> createEnvironment(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> parent)

Description copied from interface: EnvironmentFactory

Creates a child environment of a specified parent, for definition of nested scopes.

Parameters:

parent - the parent environment

Returns:

the child environment

createEvaluationEnvironment

public EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> createEvaluationEnvironment()

Description copied from interface: EnvironmentFactory

Creates a new evaluation environment to track the values of variables in an OCL expression as it is evaluated.

Returns:

a new evaluation environment

createEvaluationEnvironment

public EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> createEvaluationEnvironment(EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> parent)

Description copied from interface: EnvironmentFactory

Creates a new evaluation environment as a nested environment of the specified parent.

Parameters:

parent - a nesting evaluation environment

Returns:

a new nested evaluation environment

createOCLAnalyzer

public OCLAnalyzer createOCLAnalyzer(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env,
                                     String input)

Description copied from interface: EnvironmentFactory

Creates an instance of the OCLAnalyzer that analyzes the given input on behalf of this environment.

Specified by:

createOCLAnalyzer in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createOCLAnalyzer in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

input - the text to be analyzed

Returns:

an OCLAnalyzer instance for this environment

Since:

3.1

createOCLAnalyzer

public OCLAnalyzer createOCLAnalyzer(AbstractOCLParser parser)

Description copied from interface: EnvironmentFactory

Creates an instance of the OCLAnalyzer that will use a given parser to perform syntactic and lexical analysis.

Specified by:

createOCLAnalyzer in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createOCLAnalyzer in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Parameters:

parser - performing syntax analysis

Returns:

an OCLAnalyzer instance for this environment

Since:

3.1

createOCLFactoryWithHistory

public OCLFactoryWithHistory createOCLFactoryWithHistory(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env)

Description copied from interface: EnvironmentFactory

Creates an instance of the OCLFactoryWithHistory object for this environment.

Specified by:

createOCLFactoryWithHistory in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createOCLFactoryWithHistory in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Parameters:

env - an OCL environment (must not be null)

Returns:

an OCLFactoryWithHistory instance for this environment

Since:

3.1

createOCLSyntaxHelper

public OCLSyntaxHelper createOCLSyntaxHelper(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env)

Description copied from interface: EnvironmentFactory

Creates an instance of the OCLSyntaxHelper object for this environment.

Specified by:

createOCLSyntaxHelper in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createOCLSyntaxHelper in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Parameters:

env - an OCL environment (must not be null)

Returns:

an OCLSyntaxHelper instance for this environment

Since:

3.1

createValidationVisitor

public Visitor<Boolean,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint> createValidationVisitor(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env)

Description copied from interface: EnvironmentFactory

Obtains an instance of the validation visitor that validates against the specified environment, which presumably was used in parsing the OCL in the first place.

Specified by:

createValidationVisitor in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createValidationVisitor in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Parameters:

env - an OCL environment (must not be null)

Returns:

a validation visitor instance for the specified environment

Since:

3.1

getOppositeEndFinder

public OppositeEndFinder getOppositeEndFinder()

Since:

3.1

createEvaluationVisitor

public EvaluationVisitor<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> createEvaluationVisitor(Environment<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject> env,
                                                                                                                                                                                                    EvaluationEnvironment<EClassifier,EOperation,EStructuralFeature,EClass,EObject> evalEnv,
                                                                                                                                                                                                    Map<? extends EClass,? extends Set<? extends EObject>> extentMap)

Description copied from interface: EnvironmentFactory

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

Specified by:

createEvaluationVisitor in interface EnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

Overrides:

createEvaluationVisitor in class AbstractEnvironmentFactory<EPackage,EClassifier,EOperation,EStructuralFeature,EEnumLiteral,EParameter,EObject,CallOperationAction,SendSignalAction,Constraint,EClass,EObject>

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.

extentMap - the map of Classes to their extends

Returns:

the new evaluation visitor

Since:

3.1