org.eclipse.ocl

Class AbstractEvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

java.lang.Object

org.eclipse.ocl.utilities.AbstractVisitor<Object,C,O,P,EL,PM,S,COA,SSA,CT>

org.eclipse.ocl.AbstractEvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

All Implemented Interfaces:

EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>, Visitor<Object,C,O,P,EL,PM,S,COA,SSA,CT>

Direct Known Subclasses:

EvaluationVisitorImpl

public abstract class AbstractEvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>
extends AbstractVisitor<Object,C,O,P,EL,PM,S,COA,SSA,CT>
implements EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

An evaluation visitor implementation for OCL expressions.

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

See the Environment class for a description of the generic type parameters of this class.

Author:

Tim Klinger (tklinger), Christian W. Damus (cdamus)

Method Summary

Modifier and Type	Method and Description
Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>	getEnvironment() Obtains the environment that provides the metamodel semantics for the expression to be evaluated.
EvaluationEnvironment<C,O,P,CLS,E>	getEvaluationEnvironment() Obtains the evaluation environment that keeps track of variable values and knows how to call operations, navigate properties, etc.
Map<? extends CLS,? extends Set<? extends E>>	getExtentMap() Obtains the mapping of model classes to their extends.
String	toString()
Object	visitConstraint(CT 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 visitExpression(OCLExpression).
Object	visitExpression(OCLExpression<C> expression) This default implementation simply asks the expression to accept me.

Methods inherited from class org.eclipse.ocl.utilities.AbstractVisitor

visitAssociationClassCallExp, visitBooleanLiteralExp, visitCollectionItem, visitCollectionLiteralExp, visitCollectionRange, visitEnumLiteralExp, visitExpressionInOCL, visitIfExp, visitIntegerLiteralExp, visitInvalidLiteralExp, visitIterateExp, visitIteratorExp, visitLetExp, visitMessageExp, visitNullLiteralExp, visitOperationCallExp, visitPropertyCallExp, visitRealLiteralExp, visitStateExp, visitStringLiteralExp, visitTupleLiteralExp, visitTupleLiteralPart, visitTypeExp, visitUnlimitedNaturalLiteralExp, visitUnspecifiedValueExp, visitVariable, visitVariableExp

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.ocl.utilities.Visitor

visitAssociationClassCallExp, visitBooleanLiteralExp, visitCollectionItem, visitCollectionLiteralExp, visitCollectionRange, visitEnumLiteralExp, visitExpressionInOCL, visitIfExp, visitIntegerLiteralExp, visitInvalidLiteralExp, visitIterateExp, visitIteratorExp, visitLetExp, visitMessageExp, visitNullLiteralExp, visitOperationCallExp, visitPropertyCallExp, visitRealLiteralExp, visitStateExp, visitStringLiteralExp, visitTupleLiteralExp, visitTupleLiteralPart, visitTypeExp, visitUnlimitedNaturalLiteralExp, visitUnspecifiedValueExp, visitVariable, visitVariableExp

Method Detail

getEvaluationEnvironment

public EvaluationEnvironment<C,O,P,CLS,E> getEvaluationEnvironment()

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<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Returns:

the evaluation environment

getEnvironment

public Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> getEnvironment()

Description copied from interface: EvaluationVisitor

Obtains the environment that provides the metamodel semantics for the expression to be evaluated.

Specified by:

getEnvironment in interface EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Returns:

the environment

getExtentMap

public Map<? extends CLS,? extends Set<? extends E>> getExtentMap()

Description copied from interface: EvaluationVisitor

Obtains the mapping of model classes to their extends.

Specified by:

getExtentMap in interface EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Returns:

the extent map

visitExpression

public Object visitExpression(OCLExpression<C> expression)

This default implementation simply asks the expression to accept me.

Specified by:

visitExpression in interface EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Parameters:

expression - an OCL expression to evaluate

Returns:

the result of the evaluation

visitConstraint

public Object visitConstraint(CT 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 visitExpression(OCLExpression).

Specified by:

visitConstraint in interface EvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

Specified by:

visitConstraint in interface Visitor<Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitConstraint in class AbstractVisitor<Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

for boolean-valued constraints (invariant, precondition, postcondition) Boolean.TRUE if the constraint holds and Boolean.FALSE if it is violated (including evaluations that result in OclInvalid). For operation body conditions, the value of the operation result

See Also:

AbstractVisitor.getSpecification(Object)

toString

public String toString()

Overrides:

toString in class Object