Package org.eclipse.emf.ocl.helper

Definition of the OCL Helper API for syntax completion support and a simplified parsing model.

See:
Description

Interface Summary

IOCLHelper

A utility object that provides OCL syntax completion suggestions for OCL expressions on the metamodel and user model levels.

Class Summary

Choice	Representation of a particular OCL expression syntax completion suggestion.
ChoiceType	An enumeration of OCL syntax completion choice types.
ConstraintType	An enumeration of OCL constraint types, primarily for determining the appropriate choices for syntax completion.
HelperUtil	Factory class for the creation of IOCLHelpers.

Exception Summary

OCLParsingException

Exception indicating that OCL parsing failed.

Package org.eclipse.emf.ocl.helper Description

Definition of the OCL Helper API for syntax completion support and a simplified parsing model.

Package Specification

The primary interface in this package is the IOCLHelper, which provides OCL syntax completion assistance and parsing support. Instances are obtained from the HelperUtil class.

OCL code completion suggestions are represented as Choices, which indicate the text of a language construct, a description, and the type of construct.

The IOCLHelper also provides simple, but flexible, support for parsing OCL expressions: invariants in a classifier context, and pre/post conditions and body conditions in an operation context. Evaluation is also supported for invariant constraints. The helper is constructed with an EnvironmentFactory that creates the necessary environments for parsing the client's metamodel. This allows clients of other metamodels than Ecore (e.g., SQL, UML2) that describe software systems in terms of classifiers to use OCL to expression constraints. An environment maps the metamodel in question to the OCL parser's extended Ecore metamodel.