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

java.lang.Object
  org.eclipse.ocl.utilities.AbstractVisitor<java.lang.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>
          org.eclipse.ocl.EvaluationVisitorImpl<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<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Direct Known Subclasses:

EvaluationVisitorImpl

public class EvaluationVisitorImpl<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>
extends AbstractEvaluationVisitor<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E>

An evaluation visitor implementation for OCL expressions.

Since:

1.3

Author:

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

Field Summary

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

result

Constructor Summary

EvaluationVisitorImpl(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> env, EvaluationEnvironment<C,O,P,CLS,E> evalEnv, java.util.Map<? extends CLS,? extends java.util.Set<? extends E>> extentMap)
Constructor

Method Summary

protected java.util.Map<java.lang.String,java.util.regex.Matcher>	createRegexCache() Creates (on demand) the regular-expression matcher cache.
protected TypeChecker.Cached<C,O,P>	createTypeChecker() Create the TypeChecker used to facilitate dynamic dispatch.
protected java.util.regex.Matcher	getRegexMatcher(java.lang.String regex, java.lang.String stringToMatch) Obtains a cached matcher for the given regex initialized to a string to match.
java.lang.Object	visitAssociationClassCallExp(AssociationClassCallExp<C,P> ae) Callback for an AssociationClassCallExp visit.
java.lang.Object	visitBooleanLiteralExp(BooleanLiteralExp<C> bl) Callback for a BooleanLiteralExp visit.
java.lang.Object	visitCollectionLiteralExp(CollectionLiteralExp<C> cl) Callback for a CollectionLiteralExp visit.
java.lang.Object	visitEnumLiteralExp(EnumLiteralExp<C,EL> el) Callback for an EnumLiteralExp visit.
java.lang.Object	visitIfExp(IfExp<C> ie) Callback for an IfExp visit.
java.lang.Object	visitIntegerLiteralExp(IntegerLiteralExp<C> il) Callback for an IntegerLiteralExp visit.
java.lang.Object	visitInvalidLiteralExp(InvalidLiteralExp<C> il) Simply returns AbstractVisitor.result.
java.lang.Object	visitIterateExp(IterateExp<C,PM> ie) Callback for an IterateExp visit.
java.lang.Object	visitIteratorExp(IteratorExp<C,PM> ie) Callback for an IteratorExp visit.
java.lang.Object	visitLetExp(LetExp<C,PM> l) Callback for LetExp visit.
java.lang.Object	visitMessageExp(MessageExp<C,COA,SSA> m) Visits the message expression's target and then its arguments.
java.lang.Object	visitNullLiteralExp(NullLiteralExp<C> il) Simply returns AbstractVisitor.result.
java.lang.Object	visitOperationCallExp(OperationCallExp<C,O> oc) Callback for an OperationCallExp visit.
java.lang.Object	visitPropertyCallExp(PropertyCallExp<C,P> pc) Callback for a PropertyCallExp visit.
java.lang.Object	visitRealLiteralExp(RealLiteralExp<C> rl) Callback for a RealLiteralExp visit.
java.lang.Object	visitStateExp(StateExp<C,S> s) Simply returns AbstractVisitor.result.
java.lang.Object	visitStringLiteralExp(StringLiteralExp<C> sl) Callback for a StringLiteralExp visit.
java.lang.Object	visitTupleLiteralExp(TupleLiteralExp<C,P> tl) Callback for a TupleLiteralExp visit.
java.lang.Object	visitTupleLiteralPart(TupleLiteralPart<C,P> tp) Visits the tuple literal part's value, if any.
java.lang.Object	visitTypeExp(TypeExp<C> t) Callback for a TypeExp visiy.
java.lang.Object	visitUnlimitedNaturalLiteralExp(UnlimitedNaturalLiteralExp<C> literalExp) Callback for an UnlimitedNaturalLiteralExp visit.
java.lang.Object	visitUnspecifiedValueExp(UnspecifiedValueExp<C> uv) Callback for an UnspecifiedValueExp visit.
java.lang.Object	visitVariable(Variable<C,PM> vd) Callback for a VariableDeclaration visit.
java.lang.Object	visitVariableExp(VariableExp<C,PM> v) Callback for a VariableExp visit.

Methods inherited from class org.eclipse.ocl.AbstractEvaluationVisitor

call, coerceNumber, getBoolean, getEnvironment, getEvaluationEnvironment, getExtentMap, getInteger, getInvalid, getName, getOperationBody, getPropertyBody, getReal, getSpecification, getStandardLibrary, getString, getUMLReflection, getUnlimitedNatural, getVisitor, higherPrecisionNumber, isLaxNullHandling, isUndefined, navigate, oclIsKindOf, oclIsTypeOf, safeVisitExpression, setEvaluationEnvironment, toString, visitConstraint, visitExpression

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

handleAssociationClassCallExp, handleCollectionItem, handleCollectionLiteralExp, handleCollectionRange, handleConstraint, handleExpressionInOCL, handleIfExp, handleIterateExp, handleIteratorExp, handleLetExp, handleMessageExp, handleOperationCallExp, handlePropertyCallExp, handleTupleLiteralExp, handleTupleLiteralPart, handleVariable, safeVisit, visitCollectionItem, visitCollectionRange, visitExpressionInOCL

Methods inherited from class java.lang.Object

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

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

visitCollectionItem, visitCollectionRange, visitExpressionInOCL

Constructor Detail

EvaluationVisitorImpl

public EvaluationVisitorImpl(Environment<PK,C,O,P,EL,PM,S,COA,SSA,CT,CLS,E> env,
                             EvaluationEnvironment<C,O,P,CLS,E> evalEnv,
                             java.util.Map<? extends CLS,? extends java.util.Set<? extends E>> extentMap)

Constructor

Parameters:

env - an evaluation environment (map of variable names to values)

extentMap - a map of classes to their instance lists

Method Detail

createTypeChecker

protected TypeChecker.Cached<C,O,P> createTypeChecker()

Create the TypeChecker used to facilitate dynamic dispatch. The default implementation attempts to re-use an analysis type checker, creating an evaluation one if no analysis one available.

Since:

3.2

visitOperationCallExp

public java.lang.Object visitOperationCallExp(OperationCallExp<C,O> oc)

Callback for an OperationCallExp visit.

Specified by:

visitOperationCallExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitOperationCallExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitIterateExp

public java.lang.Object visitIterateExp(IterateExp<C,PM> ie)

Callback for an IterateExp visit.

Specified by:

visitIterateExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitIterateExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitIteratorExp

public java.lang.Object visitIteratorExp(IteratorExp<C,PM> ie)

Callback for an IteratorExp visit.

Specified by:

visitIteratorExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitIteratorExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitEnumLiteralExp

public java.lang.Object visitEnumLiteralExp(EnumLiteralExp<C,EL> el)

Callback for an EnumLiteralExp visit. Get the referred enum literal and return it as an Integer.

Specified by:

visitEnumLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitEnumLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Parameters:

el - the enumeration literal expresion

Returns:

the enumeration literal as an Integer

visitVariableExp

public java.lang.Object visitVariableExp(VariableExp<C,PM> v)

Callback for a VariableExp visit.

Specified by:

visitVariableExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitVariableExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Parameters:

v - the variable expression

Returns:

the value of the variable

visitPropertyCallExp

public java.lang.Object visitPropertyCallExp(PropertyCallExp<C,P> pc)

Callback for a PropertyCallExp visit. Evaluates the source of the expression and then reflectively gets the value of the property on the result. For example, in "self.foo", "self" is the source and would be evaluated first, then the value of the property "foo" would be accessed on that object.

Specified by:

visitPropertyCallExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitPropertyCallExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitAssociationClassCallExp

public java.lang.Object visitAssociationClassCallExp(AssociationClassCallExp<C,P> ae)

Callback for an AssociationClassCallExp visit. Evaluates the source of the expression and then reflectively gets the value of the reference on the result. For example, in "self.foo", "self" is the source and would be evaluated first, then the value of the reference "foo" would be derived on that object.

Specified by:

visitAssociationClassCallExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitAssociationClassCallExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitVariable

public java.lang.Object visitVariable(Variable<C,PM> vd)

Callback for a VariableDeclaration visit.

Specified by:

visitVariable in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitVariable in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitIfExp

public java.lang.Object visitIfExp(IfExp<C> ie)

Callback for an IfExp visit.

Specified by:

visitIfExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitIfExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitTypeExp

public java.lang.Object visitTypeExp(TypeExp<C> t)

Callback for a TypeExp visiy.

Specified by:

visitTypeExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitTypeExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitStateExp

public java.lang.Object visitStateExp(StateExp<C,S> s)

Description copied from class: AbstractVisitor

Simply returns AbstractVisitor.result.

Specified by:

visitStateExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitStateExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitMessageExp

public java.lang.Object visitMessageExp(MessageExp<C,COA,SSA> m)

Description copied from class: AbstractVisitor

Visits the message expression's target and then its arguments. Returns the result of AbstractVisitor.handleMessageExp(MessageExp, Object, List).

Specified by:

visitMessageExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitMessageExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitUnspecifiedValueExp

public java.lang.Object visitUnspecifiedValueExp(UnspecifiedValueExp<C> uv)

Callback for an UnspecifiedValueExp visit.

Specified by:

visitUnspecifiedValueExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitUnspecifiedValueExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitIntegerLiteralExp

public java.lang.Object visitIntegerLiteralExp(IntegerLiteralExp<C> il)

Callback for an IntegerLiteralExp visit.

Specified by:

visitIntegerLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitIntegerLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

the value of the integer literal as a java.lang.Integer.

visitUnlimitedNaturalLiteralExp

public java.lang.Object visitUnlimitedNaturalLiteralExp(UnlimitedNaturalLiteralExp<C> literalExp)

Callback for an UnlimitedNaturalLiteralExp visit.

Specified by:

visitUnlimitedNaturalLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitUnlimitedNaturalLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

the value of the natural literal as a java.lang.Integer.

visitRealLiteralExp

public java.lang.Object visitRealLiteralExp(RealLiteralExp<C> rl)

Callback for a RealLiteralExp visit.

Specified by:

visitRealLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitRealLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

the value of the real literal as a java.lang.Double.

visitStringLiteralExp

public java.lang.Object visitStringLiteralExp(StringLiteralExp<C> sl)

Callback for a StringLiteralExp visit.

Specified by:

visitStringLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitStringLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

the value of the string literal as a java.lang.String.

visitBooleanLiteralExp

public java.lang.Object visitBooleanLiteralExp(BooleanLiteralExp<C> bl)

Callback for a BooleanLiteralExp visit.

Specified by:

visitBooleanLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitBooleanLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Returns:

the value of the boolean literal as a java.lang.Boolean.

visitInvalidLiteralExp

public java.lang.Object visitInvalidLiteralExp(InvalidLiteralExp<C> il)

Description copied from class: AbstractVisitor

Simply returns AbstractVisitor.result.

Specified by:

visitInvalidLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitInvalidLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitNullLiteralExp

public java.lang.Object visitNullLiteralExp(NullLiteralExp<C> il)

Description copied from class: AbstractVisitor

Simply returns AbstractVisitor.result.

Specified by:

visitNullLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitNullLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitLetExp

public java.lang.Object visitLetExp(LetExp<C,PM> l)

Callback for LetExp visit.

Specified by:

visitLetExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitLetExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitCollectionLiteralExp

public java.lang.Object visitCollectionLiteralExp(CollectionLiteralExp<C> cl)

Callback for a CollectionLiteralExp visit.

Specified by:

visitCollectionLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitCollectionLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

visitTupleLiteralExp

public java.lang.Object visitTupleLiteralExp(TupleLiteralExp<C,P> tl)

Callback for a TupleLiteralExp visit.

Specified by:

visitTupleLiteralExp in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitTupleLiteralExp in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Parameters:

tl - tuple literal expression

Returns:

String

visitTupleLiteralPart

public java.lang.Object visitTupleLiteralPart(TupleLiteralPart<C,P> tp)

Description copied from class: AbstractVisitor

Visits the tuple literal part's value, if any. Returns the result of AbstractVisitor.handleTupleLiteralPart(TupleLiteralPart, Object).

Specified by:

visitTupleLiteralPart in interface Visitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

Overrides:

visitTupleLiteralPart in class AbstractVisitor<java.lang.Object,C,O,P,EL,PM,S,COA,SSA,CT>

getRegexMatcher

protected java.util.regex.Matcher getRegexMatcher(java.lang.String regex,
                                                  java.lang.String stringToMatch)

Obtains a cached matcher for the given regex initialized to a string to match.

Parameters:

regex - a regular expression to get from (or create in) the cache

stringToMatch - the search string with which to (re-)initialize the matcher

Returns:

the cached matcher; never null (failure to parse the regex raises an exception)

Since:

3.4

See Also:

createRegexCache()

createRegexCache

protected java.util.Map<java.lang.String,java.util.regex.Matcher> createRegexCache()

Creates (on demand) the regular-expression matcher cache. The default implementation creates an access-ordered LRU cache with a limit of 16 entries. Subclasses may override to create a map with whatever different performance characteristics may be required.

Returns:

the new regular-expression matcher cache

Since:

3.4

See Also:

getRegexMatcher(String, String)