org.eclipse.ocl.pivot.internal.evaluation

Class AbstractEvaluationVisitor

java.lang.Object

org.eclipse.ocl.pivot.util.AbstractVisitor<R,C>

org.eclipse.ocl.pivot.util.AbstractExtendingVisitor<java.lang.Object,ExecutorInternal.ExecutorInternalExtension>

org.eclipse.ocl.pivot.internal.evaluation.AbstractEvaluationVisitor

All Implemented Interfaces:

EvaluationVisitor, EvaluationVisitor.EvaluationVisitorExtension, Evaluator, Visitor<java.lang.Object>

Direct Known Subclasses:

BasicEvaluationVisitor

public abstract class AbstractEvaluationVisitor
extends AbstractExtendingVisitor<java.lang.Object,ExecutorInternal.ExecutorInternalExtension>
implements EvaluationVisitor.EvaluationVisitorExtension

An evaluation visitor implementation for OCL expressions.

Note that this class is not intended to be used or extended by clients. Use the EvaluationVisitor interface, instead.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ocl.pivot.evaluation.EvaluationVisitor

EvaluationVisitor.EvaluationVisitorExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected CompleteEnvironmentInternal	completeEnvironment Deprecated. Use environmentFactory.getEvaluationEnvirinment()
protected EnvironmentFactoryInternal	environmentFactory
protected EvaluationEnvironment	evaluationEnvironment Deprecated. Use getExecutor().getEvaluationEnvirinment()
protected IdResolver	idResolver
protected PivotMetamodelManager	metamodelManager Deprecated. Use environmentFactory.getMetamodelManager()
protected ModelManager	modelManager Deprecated. Use getExecutor().getModelManager()
protected org.eclipse.emf.common.util.Monitor	monitor Set non-null by setMonitor(org.eclipse.emf.common.util.Monitor) to terminate execution at next iteration/operation call.
protected StandardLibraryInternal	standardLibrary
protected EvaluationVisitor	undecoratedVisitor

Fields inherited from class org.eclipse.ocl.pivot.util.AbstractVisitor

context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEvaluationVisitor(EvaluationEnvironment evaluationEnvironment) Deprecated. Use ExecutorInternal
protected	AbstractEvaluationVisitor(ExecutorInternal executor)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.util.regex.Pattern>	createRegexCache() Deprecated. moved to Evaluator
CompleteEnvironment	getCompleteEnvironment() Deprecated. moved to Evaluator
int	getDiagnosticSeverity(int severityPreference, java.lang.Object resultValue) Deprecated. moved to Evaluator
EnvironmentFactory	getEnvironmentFactory() Obtains the environment factory that created me.
EvaluationEnvironment	getEvaluationEnvironment() Deprecated. moved to Evaluator
EvaluationVisitor	getEvaluator()
ExecutorInternal	getExecutor()
IdResolver	getIdResolver() Deprecated. moved to Evaluator
EvaluationLogger	getLogger() Deprecated. moved to Evaluator
PivotMetamodelManager	getMetamodelManager() Deprecated. moved to Evaluator
ModelManager	getModelManager() Deprecated. moved to Evaluator
org.eclipse.emf.common.util.Monitor	getMonitor()
java.util.regex.Pattern	getRegexPattern(java.lang.String regex) Deprecated. moved to Evaluator
int	getSeverity(java.lang.Object validationKey) Deprecated. moved to Evaluator
StandardLibrary	getStandardLibrary() Deprecated. moved to Evaluator
Class	getStaticTypeOf(java.lang.Object value) Deprecated. moved to Evaluator
Class	getStaticTypeOf(java.lang.Object value, java.lang.Iterable<?> values) Deprecated. moved to Evaluator
Class	getStaticTypeOf(java.lang.Object value, java.lang.Object... values) Deprecated. moved to Evaluator
protected EvaluationVisitor	getUndecoratedVisitor() Obtains the visitor on which I perform nested Visitable.accept(Visitor) calls.
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	setLogger(EvaluationLogger logger) Deprecated. moved to Evaluator
void	setMonitor(org.eclipse.emf.common.util.Monitor monitor)
void	setUndecoratedVisitor(EvaluationVisitor evaluationVisitor) Sets the visitor on which I perform nested Visitable.accept(Visitor) calls.
java.lang.String	toString()
java.lang.Object	visit(Visitable visitable) Perform a visit to the specified visitable.
java.lang.Object	visitConstraint(Constraint constraint) This default implementation asserts that the constraint is boolean-valued if it is an invariant, pre-condition, or post-condition constraint and returns the value of its body expression by delegation to Visitable.accept(Visitor).

Methods inherited from class org.eclipse.ocl.pivot.util.AbstractExtendingVisitor

visitAnnotation, visitAnyType, visitAssociationClass, visitAssociationClassCallExp, visitBagType, visitBehavior, visitBooleanLiteralExp, visitCallExp, visitCallOperationAction, visitClass, visitCollectionItem, visitCollectionLiteralExp, visitCollectionLiteralPart, visitCollectionRange, visitCollectionType, visitComment, visitCompleteClass, visitCompleteEnvironment, visitCompleteModel, visitCompletePackage, visitConnectionPointReference, visitDataType, visitDetail, visitDynamicBehavior, visitDynamicElement, visitDynamicProperty, visitDynamicType, visitDynamicValueSpecification, visitElement, visitElementExtension, visitEnumeration, visitEnumerationLiteral, visitEnumLiteralExp, visitExpressionInOCL, visitFeature, visitFeatureCallExp, visitFinalState, visitIfExp, visitImport, visitInstanceSpecification, visitIntegerLiteralExp, visitInvalidLiteralExp, visitInvalidType, visitIterateExp, visitIteration, visitIteratorExp, visitIteratorVariable, visitLambdaType, visitLanguageExpression, visitLetExp, visitLetVariable, visitLibrary, visitLiteralExp, visitLoopExp, visitMapLiteralExp, visitMapLiteralPart, visitMapType, visitMessageExp, visitMessageType, visitModel, visitNamedElement, visitNamespace, visitNavigationCallExp, visitNullLiteralExp, visitNumericLiteralExp, visitOCLExpression, visitOperation, visitOperationCallExp, visitOppositePropertyCallExp, visitOrderedSetType, visitOrphanCompletePackage, visitPackage, visitParameter, visitParameterVariable, visitPrecedence, visitPrimitiveCompletePackage, visitPrimitiveLiteralExp, visitPrimitiveType, visitProfile, visitProfileApplication, visitProperty, visitPropertyCallExp, visitPseudostate, visitRealLiteralExp, visitRegion, visitResultVariable, 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 class org.eclipse.ocl.pivot.util.AbstractVisitor

getAdapter, safeVisit

Methods inherited from class java.lang.Object

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

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

createNestedEvaluator, evaluate

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, 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, visitIteratorVariable, visitLambdaType, visitLanguageExpression, visitLetExp, visitLetVariable, visitLibrary, visitLiteralExp, visitLoopExp, visitMapLiteralExp, visitMapLiteralPart, visitMapType, visitMessageExp, visitMessageType, visitModel, visitNamedElement, visitNamespace, visitNavigationCallExp, visitNullLiteralExp, visitNumericLiteralExp, visitOCLExpression, visitOperation, visitOperationCallExp, visitOppositePropertyCallExp, visitOrderedSetType, visitOrphanCompletePackage, visitPackage, visitParameter, visitParameterVariable, visitPrecedence, visitPrimitiveCompletePackage, visitPrimitiveLiteralExp, visitPrimitiveType, visitProfile, visitProfileApplication, visitProperty, visitPropertyCallExp, visitPseudostate, visitRealLiteralExp, visitRegion, visitResultVariable, 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

Field Detail

environmentFactory

@NonNull
protected final EnvironmentFactoryInternal environmentFactory

metamodelManager

@Deprecated
 @NonNull
protected final PivotMetamodelManager metamodelManager

Deprecated. Use environmentFactory.getMetamodelManager()

idResolver

@NonNull
protected final IdResolver idResolver

Since:

1.1

standardLibrary

@NonNull
protected final StandardLibraryInternal standardLibrary

undecoratedVisitor

@NonNull
protected EvaluationVisitor undecoratedVisitor

monitor

@Nullable
protected org.eclipse.emf.common.util.Monitor monitor

Set non-null by setMonitor(org.eclipse.emf.common.util.Monitor) to terminate execution at next iteration/operation call.

evaluationEnvironment

@Deprecated
 @NonNull
protected final EvaluationEnvironment evaluationEnvironment

Deprecated. Use getExecutor().getEvaluationEnvirinment()

completeEnvironment

@Deprecated
 @NonNull
protected final CompleteEnvironmentInternal completeEnvironment

Deprecated. Use environmentFactory.getEvaluationEnvirinment()

modelManager

@Deprecated
 @NonNull
protected final ModelManager modelManager

Deprecated. Use getExecutor().getModelManager()

Constructor Detail

AbstractEvaluationVisitor

@Deprecated
protected AbstractEvaluationVisitor(@NonNull
                                                 EvaluationEnvironment evaluationEnvironment)

Deprecated. Use ExecutorInternal

AbstractEvaluationVisitor

protected AbstractEvaluationVisitor(@NonNull
                                    ExecutorInternal executor)

Since:

1.1

Method Detail

createRegexCache

@Deprecated
 @NonNull
protected java.util.Map<java.lang.String,java.util.regex.Pattern> createRegexCache()

Deprecated. moved to Evaluator

getCompleteEnvironment

@Deprecated
 @NonNull
public CompleteEnvironment getCompleteEnvironment()

Deprecated. moved to Evaluator

Specified by:

getCompleteEnvironment in interface Evaluator

getDiagnosticSeverity

@Deprecated
public int getDiagnosticSeverity(int severityPreference,
                                              @Nullable
                                              java.lang.Object resultValue)

Deprecated. moved to Evaluator

Description copied from interface: Evaluator

Return the org.eclipse.emf.common.util.Diagnostic severity to be reported for a non-true validation resultValue given a severityPreference defined by a StatusCodes value.

Specified by:

getDiagnosticSeverity in interface Evaluator

getEnvironmentFactory

@NonNull
public EnvironmentFactory getEnvironmentFactory()

Description copied from interface: EvaluationVisitor

Obtains the environment factory that created me.

Specified by:

getEnvironmentFactory in interface EvaluationVisitor

Returns:

the environment factory

getEvaluationEnvironment

@Deprecated
 @NonNull
public EvaluationEnvironment getEvaluationEnvironment()

Deprecated. moved to Evaluator

Description copied from interface: EvaluationVisitor

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

Specified by:

getEvaluationEnvironment in interface EvaluationVisitor

Specified by:

getEvaluationEnvironment in interface Evaluator

Returns:

the evaluation environment

getEvaluator

@NonNull
public EvaluationVisitor getEvaluator()

Specified by:

getEvaluator in interface EvaluationVisitor

Since:

1.1

getExecutor

@NonNull
public ExecutorInternal getExecutor()

Specified by:

getExecutor in interface EvaluationVisitor.EvaluationVisitorExtension

Since:

1.1

getIdResolver

@Deprecated
 @NonNull
public IdResolver getIdResolver()

Deprecated. moved to Evaluator

Specified by:

getIdResolver in interface Evaluator

getLogger

@Deprecated
 @Nullable
public EvaluationLogger getLogger()

Deprecated. moved to Evaluator

Description copied from interface: Evaluator

Return the logger handling oclLog() invocations or null for none.

Specified by:

getLogger in interface Evaluator

getMetamodelManager

@Deprecated
 @NonNull
public PivotMetamodelManager getMetamodelManager()

Deprecated. moved to Evaluator

Specified by:

getMetamodelManager in interface EvaluationVisitor

getModelManager

@Deprecated
 @NonNull
public 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 EvaluationVisitor

Specified by:

getModelManager in interface Evaluator

getMonitor

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

Specified by:

getMonitor in interface EvaluationVisitor

getRegexPattern

@Deprecated
 @NonNull
public java.util.regex.Pattern getRegexPattern(@NonNull
                                                                       java.lang.String regex)

Deprecated. moved to Evaluator

Return a cached matcher for a give regular expression.

Specified by:

getRegexPattern in interface Evaluator

getSeverity

@Deprecated
public int getSeverity(@Nullable
                                    java.lang.Object validationKey)

Deprecated. moved to Evaluator

Description copied from interface: Evaluator

Return the StatusCodes severity with which the validation identified by validationKey is reported. The validationKey is typically a string such as "ClassName::ConstraintName" for which static literals are available in an autogenerated *Table file as STR_Classname_c_c_ConstraintName.

StatusCodes.OK severity suppresses the validation altogether.
StatusCodes.Warning is returned for any null or unknown key.

Specified by:

getSeverity in interface Evaluator

getStandardLibrary

@Deprecated
 @NonNull
public StandardLibrary getStandardLibrary()

Deprecated. moved to Evaluator

Specified by:

getStandardLibrary in interface EvaluationVisitor

Specified by:

getStandardLibrary in interface Evaluator

getStaticTypeOf

@Deprecated
public Class getStaticTypeOf(@Nullable
                                          java.lang.Object value)

Deprecated. moved to Evaluator

Specified by:

getStaticTypeOf in interface Evaluator

getStaticTypeOf

@Deprecated
public Class getStaticTypeOf(@Nullable
                                          java.lang.Object value,
                                          @NonNull
                                          java.lang.Object... values)

Deprecated. moved to Evaluator

Specified by:

getStaticTypeOf in interface Evaluator

getStaticTypeOf

@Deprecated
public Class getStaticTypeOf(@Nullable
                                          java.lang.Object value,
                                          @NonNull
                                          java.lang.Iterable<?> values)

Deprecated. moved to Evaluator

Specified by:

getStaticTypeOf in interface Evaluator

getUndecoratedVisitor

@NonNull
protected final EvaluationVisitor getUndecoratedVisitor()

Obtains the visitor on which I perform nested Visitable.accept(Visitor) calls. This handles the case in which I am decorated by another visitor that must intercept every visitXxx() method. If I internally just recursively visit myself, then this decorator is cut out of the picture.

Returns:

my delegate visitor, which may be my own self or some other

isCanceled

public boolean isCanceled()

Description copied from interface: Evaluator

Return true if the evaluation has been canceled.

Specified by:

isCanceled in interface EvaluationVisitor

Specified by:

isCanceled in interface Evaluator

setCanceled

public 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 EvaluationVisitor

Specified by:

setCanceled in interface Evaluator

setLogger

@Deprecated
public void setLogger(@Nullable
                                   EvaluationLogger logger)

Deprecated. moved to Evaluator

Description copied from interface: Evaluator

Specify the logger to handle oclLog() invocations or null for none.

Specified by:

setLogger in interface Evaluator

setMonitor

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

Specified by:

setMonitor in interface EvaluationVisitor

setUndecoratedVisitor

public void setUndecoratedVisitor(@NonNull
                                  EvaluationVisitor evaluationVisitor)

Sets the visitor on which I perform nested Visitable.accept(Visitor) calls.

Specified by:

setUndecoratedVisitor in interface EvaluationVisitor

Parameters:

evaluationVisitor - my delegate visitor

See Also:

getUndecoratedVisitor()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

visit

@Nullable
public java.lang.Object visit(@NonNull
                                         Visitable visitable)

Description copied from class: AbstractVisitor

Perform a visit to the specified visitable.

Specified by:

visit in interface EvaluationVisitor.EvaluationVisitorExtension

Overrides:

visit in class AbstractVisitor<java.lang.Object,ExecutorInternal.ExecutorInternalExtension>

Parameters:

visitable - a visitable, or null

Returns:

null if the visitable is null; otherwise, the result of visiting it

visitConstraint

public java.lang.Object visitConstraint(@NonNull
                                        Constraint constraint)

This default implementation asserts that the constraint is boolean-valued if it is an invariant, pre-condition, or post-condition constraint and returns the value of its body expression by delegation to Visitable.accept(Visitor).

Specified by:

visitConstraint in interface Visitor<java.lang.Object>

Overrides:

visitConstraint in class AbstractExtendingVisitor<java.lang.Object,ExecutorInternal.ExecutorInternalExtension>