org.eclipse.ocl.pivot.evaluation

Interface EvaluationVisitor

All Superinterfaces:

Evaluator, Visitor<java.lang.Object>

All Known Subinterfaces:

EvaluationVisitor.EvaluationVisitorExtension, VMEvaluationVisitor

All Known Implementing Classes:

AbstractEvaluationVisitor, AbstractEvaluationVisitorDecorator, BasicEvaluationVisitor, EvaluationVisitorDecorator, OCLAbstractTracingEvaluationVisitor, OCLEvaluationVisitor, OCLTracingEvaluationVisitor, OCLVMEvaluationVisitor, OCLVMEvaluationVisitorDecorator, TracingEvaluationVisitor

public interface EvaluationVisitor
extends Visitor<java.lang.Object>, Evaluator

A specialized visitor that is used for evaluation an OCL expression by walking its AST. The Evaluator interface is deprecated. Its facilities should be obtained by getEvaluator().

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EvaluationVisitor.EvaluationVisitorExtension

Method Summary

Modifier and Type	Method and Description
EvaluationVisitor	createNestedEvaluator() Deprecated. no longer used
java.lang.Object	evaluate(OCLExpression body)
EnvironmentFactory	getEnvironmentFactory() Obtains the environment factory that created me.
EvaluationEnvironment	getEvaluationEnvironment() Obtains the evaluation environment that keeps track of variable values and knows how to call operations, navigate properties, etc.
EvaluationVisitor	getEvaluator() Deprecated. use getExecutor
MetamodelManager	getMetamodelManager() Deprecated. moved to Evaluator
ModelManager	getModelManager() Deprecated. moved to Evaluator
org.eclipse.emf.common.util.Monitor	getMonitor()
StandardLibrary	getStandardLibrary() Deprecated. moved to Evaluator
boolean	isCanceled() Return true if the evaluation has been canceled.
void	setCanceled(boolean isCanceled) Request cancelation of the current the evaluation, or reset the request for a new evaluation.
void	setMonitor(org.eclipse.emf.common.util.Monitor monitor)
void	setUndecoratedVisitor(EvaluationVisitor evaluationVisitor) Configures the specified decorated visitor to correctly handle the invocation of recursive visitXxx(...) calls.

Methods inherited from interface org.eclipse.ocl.pivot.util.Visitor

getAdapter, visitAnnotation, visitAnyType, visitAssociationClass, visitAssociationClassCallExp, visitBagType, visitBehavior, visitBooleanLiteralExp, visitCallExp, visitCallOperationAction, visitClass, visitCollectionItem, visitCollectionLiteralExp, visitCollectionLiteralPart, visitCollectionRange, visitCollectionType, visitComment, visitCompleteClass, visitCompleteEnvironment, visitCompleteModel, visitCompletePackage, visitConnectionPointReference, visitConstraint, visitDataType, visitDetail, visitDynamicBehavior, visitDynamicElement, visitDynamicProperty, visitDynamicType, visitDynamicValueSpecification, visitElement, visitElementExtension, visitEnumeration, visitEnumerationLiteral, visitEnumLiteralExp, visitExpressionInOCL, visitFeature, visitFeatureCallExp, visitFinalState, visitIfExp, visitImport, visiting, visitInstanceSpecification, visitIntegerLiteralExp, visitInvalidLiteralExp, visitInvalidType, visitIterateExp, visitIteration, visitIteratorExp, visitLambdaType, visitLanguageExpression, visitLetExp, visitLibrary, visitLiteralExp, visitLoopExp, visitMapLiteralExp, visitMapLiteralPart, visitMapType, visitMessageExp, visitMessageType, visitModel, visitNamedElement, visitNamespace, visitNavigationCallExp, visitNullLiteralExp, visitNumericLiteralExp, visitOCLExpression, visitOperation, visitOperationCallExp, visitOppositePropertyCallExp, visitOrderedSetType, visitOrphanCompletePackage, visitPackage, visitParameter, visitPrecedence, visitPrimitiveCompletePackage, visitPrimitiveLiteralExp, visitPrimitiveType, visitProfile, visitProfileApplication, visitProperty, visitPropertyCallExp, visitPseudostate, visitRealLiteralExp, visitRegion, visitSelfType, visitSendSignalAction, visitSequenceType, visitSetType, visitShadowExp, visitShadowPart, visitSignal, visitSlot, visitStandardLibrary, visitState, visitStateExp, visitStateMachine, visitStereotype, visitStereotypeExtender, visitStringLiteralExp, visitTemplateableElement, visitTemplateBinding, visitTemplateParameter, visitTemplateParameterSubstitution, visitTemplateSignature, visitTransition, visitTrigger, visitTupleLiteralExp, visitTupleLiteralPart, visitTupleType, visitType, visitTypedElement, visitTypeExp, visitUnlimitedNaturalLiteralExp, visitUnspecifiedValueExp, visitValueSpecification, visitVariable, visitVariableDeclaration, visitVariableExp, visitVertex, visitVoidType, visitWildcardType

Methods inherited from interface org.eclipse.ocl.pivot.evaluation.Evaluator

dispose, getCompleteEnvironment, getDiagnosticSeverity, getIdResolver, getLogger, getRegexPattern, getSeverity, getStaticTypeOf, getStaticTypeOf, getStaticTypeOf, setLogger

Method Detail

createNestedEvaluator

@Deprecated
 @NonNull
EvaluationVisitor createNestedEvaluator()

Deprecated. no longer used

Specified by:

createNestedEvaluator in interface Evaluator

evaluate

@Nullable
java.lang.Object evaluate(@NonNull
                                     OCLExpression body)

Specified by:

evaluate in interface Evaluator

getEnvironmentFactory

@NonNull
EnvironmentFactory getEnvironmentFactory()

Obtains the environment factory that created me.

Returns:

the environment factory

getEvaluationEnvironment

@NonNull
EvaluationEnvironment getEvaluationEnvironment()

Obtains the evaluation environment that keeps track of variable values and knows how to call operations, navigate properties, etc.

Specified by:

getEvaluationEnvironment in interface Evaluator

Returns:

the evaluation environment

getEvaluator

@Deprecated
 @NonNull
EvaluationVisitor getEvaluator()

Deprecated. use getExecutor

getMetamodelManager

@Deprecated
 @NonNull
MetamodelManager getMetamodelManager()

Deprecated. moved to Evaluator

getModelManager

@Deprecated
 @NonNull
ModelManager getModelManager()

Deprecated. moved to Evaluator

Description copied from interface: Evaluator

Return the manager of all model instances for use by allInstances() and hidden opposite support.

Specified by:

getModelManager in interface Evaluator

getMonitor

@Nullable
org.eclipse.emf.common.util.Monitor getMonitor()

getStandardLibrary

@Deprecated
 @NonNull
StandardLibrary getStandardLibrary()

Deprecated. moved to Evaluator

Specified by:

getStandardLibrary in interface Evaluator

isCanceled

boolean isCanceled()

Description copied from interface: Evaluator

Return true if the evaluation has been canceled.

Specified by:

isCanceled in interface Evaluator

setCanceled

void setCanceled(boolean isCanceled)

Description copied from interface: Evaluator

Request cancelation of the current the evaluation, or reset the request for a new evaluation. Cancelation occurs by throwing an EvaluationHaltedException when an expression, operation or iteration is next invoked.

Specified by:

setCanceled in interface Evaluator

setMonitor

void setMonitor(@Nullable
                org.eclipse.emf.common.util.Monitor monitor)

setUndecoratedVisitor

void setUndecoratedVisitor(@NonNull
                           EvaluationVisitor evaluationVisitor)

Configures the specified decorated visitor to correctly handle the invocation of recursive visitXxx(...) calls. In particular, the tail of a chain of decorators is informed (if it is an AbstractEvaluationVisitor of the head decorator of the chain, so that recursive visitation follows the entire decorator chain at every step.

Parameters:

evaluationVisitor - the evaluationVisitor that is not decorated/