org.eclipse.ocl.uml

Class UMLEnvironment

java.lang.Object

org.eclipse.ocl.lpg.AbstractBasicEnvironment

org.eclipse.ocl.AbstractEnvironment<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject>

org.eclipse.ocl.uml.UMLEnvironment

All Implemented Interfaces:

Environment<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject>, Environment.Internal<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject>, Environment.Lookup<Package,Classifier,Operation,Property>, BasicEnvironment, BasicEnvironment2, Customizable, Adaptable

public class UMLEnvironment
extends AbstractEnvironment<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject>

Implementation of the Environment for parsing OCL expressions on UML models. The UMLEnvironment uses a client-supplied resource set to look up UML Packages in UML resources. It also uses an EPackage registry to find the corresponding Ecore definitions of packages when evaluating expressions on instances of the UML model (in the case of evaluation on UML2-generated API objects).

Author:

Christian W. Damus (cdamus)

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	OCL_STANDARD_LIBRARY_NS_URI The namespace URI of the UML representation of the OCL Standard Library.

Fields inherited from interface org.eclipse.ocl.Environment

OCL_NAMESPACE_URI, RESULT_VARIABLE_NAME, SELF_VARIABLE_NAME

Method Summary

Modifier and Type	Method and Description
Property	defineAttribute(Classifier owner, Variable<Classifier,Parameter> variable, Constraint constraint) In processing an additional attribute definition, constructs the property and associates it with its definition constraint.
Operation	defineOperation(Classifier owner, String name, Classifier type, List<Variable<Classifier,Parameter>> params, Constraint constraint) In processing an additional operation definition, constructs the operation and associates it with its definition constraint.
Constraint	getDefinition(Object feature) Obtains the definition constraint of the specified feature, if it is an additional attribute or operation defined via an OCL constraint.
EClassifier	getEClassifier(Classifier type, Object element) Looks up the Ecore definition of the specified UML classifier, using the specified element as a context for finding profile applications in the case that the classifier is a stereotype or some other type in a Profile.
EnvironmentFactory<org.eclipse.uml2.uml.Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,org.eclipse.uml2.uml.Class,EObject>	getFactory() Obtains the factory that created me, or an appropriate default factory if I was not created using a factory.
FormattingHelper	getFormatter() I provide a custom formatting helper for UML metamodel.
OCLFactory	getOCLFactory() Obtains a factory for the creation of types that are parameterized by model elements.
OCLStandardLibrary<Classifier>	getOCLStandardLibrary() Obtains the collection of core types representing the OCL Standard Library.
List<State>	getStates(Classifier owner, List<String> pathPrefix) Retrieves a list of all possible states of the specified owner whose paths are prefixed by the specified partial name.
TypeResolver<Classifier,Operation,Property>	getTypeResolver() Obtains a type resolver to be used to create (and cache) concrete bindings for the generic OCL types, based on the user model types provided by this environment.
UMLReflection<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint>	getUMLReflection() Obtains a utility for for reflection on the UML metaclasses that are used by the OCL abstract syntax.
boolean	isInPostcondition(OCLExpression<Classifier> exp) Checks whether the specified OCL expression is in an operation postcondition constraint.
Classifier	lookupClassifier(List<String> names) Finds the classifier identified by the specified sequence of names (a qualified name).
org.eclipse.uml2.uml.Package	lookupPackage(List<String> path) Finds the package identified by the specified sequence of names (a qualified name).
void	setParent(Environment<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject> env) Sets my parent environment.
void	undefine(Object feature) Removes the definition of an additional operation or property.

Methods inherited from class org.eclipse.ocl.AbstractEnvironment

addElement, addHelperOperation, addHelperProperty, deleteElement, dispose, getAdapter, getAdditionalAttributes, getAdditionalOperations, getBodyCondition, getContextClassifier, getContextOperation, getContextPackage, getContextProperty, getDeriveConstraint, getInitConstraint, getInternalParent, getParent, getSelfVariable, getVariables, isEmpty, lookup, lookupAssociationClassReference, lookupImplicitSourceForAssociationClass, lookupImplicitSourceForOperation, lookupImplicitSourceForProperty, lookupImplicitSourceForSignal, lookupImplicitSourceForState, lookupLocal, lookupOperation, lookupProperty, lookupSignal, lookupState, notOK, setBodyCondition, setDeriveConstraint, setInitConstraint, setInternalParent, setSelfVariable, tryLookupAssociationClassReference, tryLookupClassifier, tryLookupOperation, tryLookupPackage, tryLookupProperty, tryLookupSignal

Methods inherited from class org.eclipse.ocl.lpg.AbstractBasicEnvironment

analyzerError, analyzerError, analyzerError, analyzerWarning, clearOptions, getASTMapping, getASTNodeToCSTNodeMap, getOptions, getParser, getProblemHandler, getValue, initASTMapping, initASTMapping, isEnabled, lexerError, parserError, problem, putOptions, removeOption, removeOptions, setASTNodeToCSTNodeMap, setOption, setParser, setProblemHandler, utilityError, validatorError

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.lpg.BasicEnvironment

analyzerError, analyzerError, analyzerError, analyzerWarning, getASTMapping, getParser, getProblemHandler, initASTMapping, lexerError, parserError, problem, setParser, setProblemHandler, utilityError, validatorError

Methods inherited from interface org.eclipse.ocl.options.Customizable

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

Field Detail

OCL_STANDARD_LIBRARY_NS_URI

public static final String OCL_STANDARD_LIBRARY_NS_URI

The namespace URI of the UML representation of the OCL Standard Library.

Since:

2.0

See Also:

Constant Field Values

Method Detail

getFactory

public EnvironmentFactory<org.eclipse.uml2.uml.Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,org.eclipse.uml2.uml.Class,EObject> getFactory()

Description copied from interface: Environment

Obtains the factory that created me, or an appropriate default factory if I was not created using a factory. This factory can be used to create nested environments within me.

Returns:

my originating factory

See Also:

EnvironmentFactory.createEnvironment(Environment)

getEClassifier

public EClassifier getEClassifier(Classifier type,
                                  Object element)

Looks up the Ecore definition of the specified UML classifier, using the specified element as a context for finding profile applications in the case that the classifier is a stereotype or some other type in a Profile. Finding the Ecore definition of a profile type requires finding the actual applied version of the profile.

Parameters:

type - a UML classifier

element - an element in the context of which the OCL evaluation is being performed

Returns:

the corresponding Ecore classifier, or null if not found

Since:

3.0

setParent

public void setParent(Environment<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint,Class,EObject> env)

Description copied from interface: Environment

Sets my parent environment. The parent environment should not generally be set to null if it was not already null.

Parameters:

env - my new parent environment

getOCLStandardLibrary

public OCLStandardLibrary<Classifier> getOCLStandardLibrary()

Description copied from interface: Environment

Obtains the collection of core types representing the OCL Standard Library. These are the singleton or generic instances of the OCL-defined classifiers such as OclAny, Collection(T), etc. Implementers of OCL metamodel bindings are encouraged to share a single instance of the standard library amonst all of the Environments constructed by a particular EnvironmentFactory.

Returns:

the OCL Standard Library implementation for this environment

getTypeResolver

public TypeResolver<Classifier,Operation,Property> getTypeResolver()

Description copied from interface: Environment

Obtains a type resolver to be used to create (and cache) concrete bindings for the generic OCL types, based on the user model types provided by this environment. These are the types that are parameterized by particular user model elements: collections of particular classifiers, meta-types for particular classifiers, message types for particular operations or signals, and tuple types.

Returns:

the type resolver

getOCLFactory

public OCLFactory getOCLFactory()

Description copied from interface: Environment

Obtains a factory for the creation of types that are parameterized by model elements. This type factory must create types that are instances of the metaclass describing classifiers in the client metamodel.

Returns:

the appropriate type factory

getUMLReflection

public UMLReflection<Package,Classifier,Operation,Property,EnumerationLiteral,Parameter,State,CallOperationAction,SendSignalAction,Constraint> getUMLReflection()

Description copied from interface: Environment

Obtains a utility for for reflection on the UML metaclasses that are used by the OCL abstract syntax.

Returns:

the appropriate reflection instance

lookupPackage

public org.eclipse.uml2.uml.Package lookupPackage(List<String> path)

Finds the package identified by the specified sequence of names (a qualified name).

Implements the inherited specification by looking in my resource set for a resource containing the specified package.

Parameters:

path - the qualified name

Returns:

the matching package, or null if not found

lookupClassifier

public Classifier lookupClassifier(List<String> names)

Description copied from interface: Environment

Finds the classifier identified by the specified sequence of names (a qualified name).

Parameters:

names - the qualified name

Returns:

the matching classifier, or null if not found

getStates

public List<State> getStates(Classifier owner,
                             List<String> pathPrefix)

Description copied from interface: Environment

Retrieves a list of all possible states of the specified owner whose paths are prefixed by the specified partial name. If the owner is null, then the target of the oclIsInState() operation call is implicit and must be looked up in the usual way for implicit operation call targets. This method is used for content-assist.

Parameters:

owner - the classifier for which states are being sought. Can be null in the case of an oclIsInState() call on an implicit target

pathPrefix - partial path name of the states being sought. This can be empty to find the first level of state names

Returns:

the list of all possible states directly contained in the namespace indicated by the path prefix (i.e., only one level of state nesting)

defineAttribute

public Property defineAttribute(Classifier owner,
                                Variable<Classifier,Parameter> variable,
                                Constraint constraint)

Description copied from interface: Environment

In processing an additional attribute definition, constructs the property and associates it with its definition constraint. The operation definition is local to this environment.

Parameters:

owner - the context classifier of the property definition constraint

variable - the name and type of the property (conveniently encapsulated in a variable)

constraint - the definition constraint

Returns:

the defined property

defineOperation

public Operation defineOperation(Classifier owner,
                                 String name,
                                 Classifier type,
                                 List<Variable<Classifier,Parameter>> params,
                                 Constraint constraint)

Description copied from interface: Environment

In processing an additional operation definition, constructs the operation and associates it with its definition constraint. The operation definition is local to this environment.

Parameters:

owner - the context classifier of the property definition constraint

name - the operation name

params - the names and types of the parameters, if any (conveniently encapsulated in variables)

constraint - the definition constraint

Returns:

the defined operation

undefine

public void undefine(Object feature)

Description copied from interface: Environment

Removes the definition of an additional operation or property.

Parameters:

feature - an additional property or operation

getDefinition

public Constraint getDefinition(Object feature)

Description copied from interface: Environment

Obtains the definition constraint of the specified feature, if it is an additional attribute or operation defined via an OCL constraint.

Parameters:

feature - a property or operation

Returns:

the definition constraint that defines it, or null if this feature is not defined by OCL

isInPostcondition

public boolean isInPostcondition(OCLExpression<Classifier> exp)

Description copied from interface: Environment

Checks whether the specified OCL expression is in an operation postcondition constraint. This is used in validating the usage of constructs that are only valid in postconditions (e.g., oclIsNew()).

Parameters:

exp - an OCL expression

Returns:

true if it is in a postcondition constraint; false, otherwise (including case of no constraint at all)

getFormatter

public FormattingHelper getFormatter()

I provide a custom formatting helper for UML metamodel.

Specified by:

getFormatter in interface BasicEnvironment

Overrides:

getFormatter in class AbstractBasicEnvironment

Returns:

non-null message formatter

Since:

1.2