org.eclipse.ocl.pivot.internal.helper

Class OCLHelperImpl

java.lang.Object

org.eclipse.ocl.pivot.internal.helper.OCLHelperImpl

All Implemented Interfaces:

OCLHelper

public class OCLHelperImpl
extends java.lang.Object
implements OCLHelper

Implementation of the OCLHelper convenience interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.emf.ecore.EObject	context
protected OCL	ocl

Constructor Summary

Constructors

Constructor and Description
OCLHelperImpl(OCL ocl, org.eclipse.emf.ecore.EObject context) Initializes me with my environment.

Method Summary

Modifier and Type	Method and Description
ExpressionInOCL	createBodyCondition(java.lang.String expression) Creates an operation body.
ExpressionInOCL	createDerivedValueExpression(java.lang.String expression) Creates a property derived value expression.
ExpressionInOCL	createInvariant(java.lang.String expression) Creates an invariant constraint in the current classifier context.
ExpressionInOCL	createPostcondition(java.lang.String expression) Creates an operation postcondition constraint.
ExpressionInOCL	createPrecondition(java.lang.String expression) Creates an operation precondition constraint.
ExpressionInOCL	createQuery(java.lang.String expression) Creates a query expression in the current classifier context.
protected ExpressionInOCL	createSpecification(java.lang.String expression)
Type	getContextClass() Obtains my OCL context classifier as a classifier.
Operation	getContextOperation() Obtains my context operation, if my environment is an operation context.
Property	getContextProperty() Obtains my context attribute, if my environment is an attribute context.
EnvironmentFactory	getEnvironmentFactory()
MetamodelManager	getMetamodelManager()
OCL	getOCL() Obtains the OCL instance that created me.

Methods inherited from class java.lang.Object

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

Field Detail

ocl

@NonNull
protected final OCL ocl

context

@Nullable
protected final org.eclipse.emf.ecore.EObject context

Constructor Detail

OCLHelperImpl

public OCLHelperImpl(@NonNull
                     OCL ocl,
                     @Nullable
                     org.eclipse.emf.ecore.EObject context)
              throws ParserException

Initializes me with my environment.

Parameters:

ocl - the OCL environment

Throws:

ParserException

Method Detail

createBodyCondition

@NonNull
public ExpressionInOCL createBodyCondition(@NonNull
                                                     java.lang.String expression)
                                              throws ParserException

Description copied from interface: OCLHelper

Creates an operation body. This is appropriate only if my context is an operation.

Specified by:

createBodyCondition in interface OCLHelper

Parameters:

expression - the constraint expression (without any context declaration). Ordinarily, this is an expression of the same type as the operation, specifying the value of the operation. Alternatively, this may be a boolean-valued expression phrased like a post-condition (according to the well-formedness rules of UML constraints)

Returns:

the body condition

Throws:

ParserException - if the expression fails to parse

createDerivedValueExpression

@NonNull
public ExpressionInOCL createDerivedValueExpression(@NonNull
                                                              java.lang.String expression)
                                                       throws ParserException

Description copied from interface: OCLHelper

Creates a property derived value expression. This is appropriate only if my context is a property.

Specified by:

createDerivedValueExpression in interface OCLHelper

Parameters:

expression - the derived value expression (without any context declaration). This must conform to my context property type

Returns:

the derived value expression

Throws:

ParserException - if the expression fails to parse or is not valid for my context property

createInvariant

@NonNull
public ExpressionInOCL createInvariant(@NonNull
                                                 java.lang.String expression)
                                          throws ParserException

Description copied from interface: OCLHelper

Creates an invariant constraint in the current classifier context.

Specified by:

createInvariant in interface OCLHelper

Parameters:

expression - the constraint expression (without any context declaration). This must be a boolean-valued expression

Returns:

the invariant constraint

Throws:

ParserException - if the expression fails to parse

createPostcondition

@NonNull
public ExpressionInOCL createPostcondition(@NonNull
                                                     java.lang.String expression)
                                              throws ParserException

Description copied from interface: OCLHelper

Creates an operation postcondition constraint. This is appropriate only if my context is an operation.

Specified by:

createPostcondition in interface OCLHelper

Parameters:

expression - the constraint expression (without any context declaration). This must be a boolean-valued expression

Returns:

the postcondition

Throws:

ParserException - if the expression fails to parse

createPrecondition

@NonNull
public ExpressionInOCL createPrecondition(@NonNull
                                                    java.lang.String expression)
                                             throws ParserException

Description copied from interface: OCLHelper

Creates an operation precondition constraint. This is appropriate only if my context is an operation.

Specified by:

createPrecondition in interface OCLHelper

Parameters:

expression - the constraint expression (without any context declaration). This must be a boolean-valued expression

Returns:

the precondition

Throws:

ParserException - if the expression fails to parse

createQuery

@NonNull
public ExpressionInOCL createQuery(@NonNull
                                             java.lang.String expression)
                                      throws ParserException

Description copied from interface: OCLHelper

Creates a query expression in the current classifier context. This may be specified, for example, as an expression value in the model.

Specified by:

createQuery in interface OCLHelper

Parameters:

expression - the expression (without any context declaration). This expression can have any result type; it needs not be a boolean

Returns:

the query expression

Throws:

ParserException - if the expression fails to parse

createSpecification

@NonNull
protected ExpressionInOCL createSpecification(@NonNull
                                                        java.lang.String expression)
                                                 throws ParserException

Throws:

ParserException

getContextClass

@Nullable
public Type getContextClass()

Description copied from interface: OCLHelper

Obtains my OCL context classifier as a classifier.

Specified by:

getContextClass in interface OCLHelper

Returns:

my context classifier (never null)

getContextProperty

@Nullable
public Property getContextProperty()

Description copied from interface: OCLHelper

Obtains my context attribute, if my environment is an attribute context.

Specified by:

getContextProperty in interface OCLHelper

Returns:

my context attribute, or null if there is only a classifier or operation context

getContextOperation

@Nullable
public Operation getContextOperation()

Description copied from interface: OCLHelper

Obtains my context operation, if my environment is an operation context.

Specified by:

getContextOperation in interface OCLHelper

Returns:

my context operation, or null if there is only a classifier or attribute context

getEnvironmentFactory

@NonNull
public EnvironmentFactory getEnvironmentFactory()

getMetamodelManager

@NonNull
public MetamodelManager getMetamodelManager()

getOCL

@NonNull
public OCL getOCL()

Description copied from interface: OCLHelper

Obtains the OCL instance that created me. Note that many of the generic type parameter bindings will not be known, so clients should keep track of the OCL instance themselves where that is a problem.

Specified by:

getOCL in interface OCLHelper

Returns:

the OCL instance that created me