org.eclipse.ocl.pivot.utilities

Interface ParserContext

All Known Implementing Classes:

AbstractParserContext, ClassContext, DiagnosticContext, EClassContext, EInvocationContext, EObjectContext, ModelContext, OperationContext, PropertyContext

public interface ParserContext

A ParserContext captures the context in which source text is parsed. A derived context is constructed with the relevant context, then createBaseResource creates a Concrete Syntax resource for a Concrete Syntax expression string. Then parse creates a corresponding Abstract Syntax ExpressionInOCL. initialize is invoked during the parse to install the derived context into the ExpressionInOCL.

Method Summary

Modifier and Type	Method and Description
CSResource	createBaseResource(java.lang.String expression) Create a Concrete Syntax resource containing the parsed expression.
Type	getClassContext() Return the type of the self variable.
ExpressionInOCL	getExpression(CSResource resource) Extract an Abstract Syntax ExpressionInOCL fronm a Concrete Syntax resource.
MetamodelManager	getMetamodelManager() Return the MetamodelManager in use.
Element	getRootElement() Optional pre-existing AS root element to be updated by the parse.
void	initialize(Base2ASConversion conversion, ExpressionInOCL expression) Callback to initialize the ExpressionInOCL with the derived context such as a contextvariable for the self type, parameter and result variables.
ExpressionInOCL	parse(org.eclipse.emf.ecore.EObject owner, java.lang.String expression) Create an Abstract Syntax ExpressionInOCL containing the parsed expression on behalf of a potential owner.
void	setRootElement(Element rootElement)

Method Detail

createBaseResource

@NonNull
CSResource createBaseResource(@NonNull
                                        java.lang.String expression)
                                 throws java.io.IOException,
                                        ParserException

Create a Concrete Syntax resource containing the parsed expression. Semantic errors may be found at the Resource.errors and may be converted to ParseExceptions by invoking PivitUtil.checkResourceErrors.

Throws:

java.io.IOException - if resource loading fails

ParserException

getClassContext

@Nullable
Type getClassContext()

Return the type of the self variable.

getExpression

@Nullable
ExpressionInOCL getExpression(@NonNull
                                         CSResource resource)
                                  throws ParserException

Extract an Abstract Syntax ExpressionInOCL fronm a Concrete Syntax resource.

Throws:

ParserException - if parsing fails

getMetamodelManager

@NonNull
MetamodelManager getMetamodelManager()

Return the MetamodelManager in use.

getRootElement

@Nullable
Element getRootElement()

Optional pre-existing AS root element to be updated by the parse.

initialize

void initialize(@NonNull
                Base2ASConversion conversion,
                @NonNull
                ExpressionInOCL expression)

Callback to initialize the ExpressionInOCL with the derived context such as a contextvariable for the self type, parameter and result variables.

parse

@NonNull
ExpressionInOCL parse(@Nullable
                                org.eclipse.emf.ecore.EObject owner,
                                @NonNull
                                java.lang.String expression)
                         throws ParserException

Create an Abstract Syntax ExpressionInOCL containing the parsed expression on behalf of a potential owner.

This an invariant/precondition may specify its constraint as the owner
an operation body may specify the operation as the owner

The owner should be non-null but a null value is tolerated for deprecated compatibility.

Throws:

ParserException - if parsing fails

setRootElement

void setRootElement(@Nullable
                    Element rootElement)