Package org.apache.cayenne.ejbql
Interface EJBQLExpressionVisitor
- All Known Implementing Classes:
- DB2EJBQLConditionTranslator,- DerbyEJBQLConditionTranslator,- EJBQLBaseVisitor,- EJBQLConditionTranslator,- EJBQLDbPathTranslator,- EJBQLDeleteTranslator,- EJBQLFromTranslator,- EJBQLPathTranslator,- EJBQLSelectColumnsTranslator,- EJBQLSelectTranslator,- FirebirdEJBQLConditionTranslator,- HSQLEJBQLConditionTranslator
public interface EJBQLExpressionVisitor
A visitor interface to inspect the EJBQL expression tree. Visit methods return
 booleans, indicating whether the children of a given node should be visited.
- Since:
- 3.0
- 
Method SummaryModifier and Type Method Description booleanvisitAbs(EJBQLExpression expression, int finishedChildIndex)booleanvisitAbstractSchemaName(EJBQLExpression expression)booleanvisitAdd(EJBQLExpression expression, int finishedChildIndex)Called on visiting "add" expression and also after visiting every expression child.booleanvisitAggregate(EJBQLExpression expression)booleanvisitAll(EJBQLExpression expression)booleanvisitAnd(EJBQLExpression expression, int finishedChildIndex)Called on visiting "and" expression and also after visiting every expression child.booleanvisitAny(EJBQLExpression expression)booleanvisitAscending(EJBQLExpression expression)booleanvisitAverage(EJBQLAggregateColumn expression)booleanvisitBetween(EJBQLExpression expression, int finishedChildIndex)Called on visiting "between" expression and also after visiting every expression child.booleanvisitBooleanLiteral(EJBQLExpression expression)booleanvisitClassName(EJBQLExpression expression)booleanvisitConcat(EJBQLExpression expression, int finishedChildIndex)booleanvisitConstructor(EJBQLExpression expression)booleanvisitConstructorParameter(EJBQLExpression expression)booleanvisitConstructorParameters(EJBQLExpression expression)booleanvisitCount(EJBQLAggregateColumn expression)booleanvisitCurrentDate(EJBQLExpression expression)booleanvisitCurrentTime(EJBQLExpression expression)booleanvisitCurrentTimestamp(EJBQLExpression expression)booleanvisitDbPath(EJBQLExpression expression, int finishedChildIndex)booleanvisitDecimalLiteral(EJBQLDecimalLiteral expression)booleanvisitDelete(EJBQLExpression expression)booleanvisitDescending(EJBQLExpression expression)booleanvisitDistinct(EJBQLExpression expression)booleanvisitDivide(EJBQLExpression expression, int finishedChildIndex)Called on visiting "divide" expression and also after visiting every expression child.booleanvisitEquals(EJBQLExpression expression, int finishedChildIndex)Called on visiting "equals" expression and also after visiting every expression child.booleanvisitEscapeCharacter(EJBQLExpression expression)booleanvisitExists(EJBQLExpression expression)booleanvisitFrom(EJBQLExpression expression, int finishedChildIndex)booleanvisitFromItem(EJBQLFromItem expression, int finishedChildIndex)booleanvisitGreaterOrEqual(EJBQLExpression expression, int finishedChildIndex)Called on visiting ">=" expression and also after visiting every expression child.booleanvisitGreaterThan(EJBQLExpression expression, int finishedChildIndex)Called on visiting ">=" expression and also after visiting every expression child.booleanvisitGroupBy(EJBQLExpression expression)booleanvisitHaving(EJBQLExpression expression)booleanvisitIdentificationVariable(EJBQLExpression expression)booleanvisitIdentifier(EJBQLExpression expression)booleanvisitIn(EJBQLExpression expression, int finishedChildIndex)booleanvisitInnerFetchJoin(EJBQLJoin join)booleanvisitInnerJoin(EJBQLJoin join)booleanvisitIntegerLiteral(EJBQLIntegerLiteral expression)booleanvisitIsEmpty(EJBQLExpression expression)booleanvisitIsNull(EJBQLExpression expression, int finishedChildIndex)booleanvisitLength(EJBQLExpression expression, int finishedChildIndex)booleanvisitLessOrEqual(EJBQLExpression expression, int finishedChildIndex)Called on visiting "<=" expression and also after visiting every expression child.booleanvisitLessThan(EJBQLExpression expression, int finishedChildIndex)Called on visiting "<" expression and also after visiting every expression child.booleanvisitLike(EJBQLExpression expression, int finishedChildIndex)Called on visiting "LIKE" expression and also after visiting every expression child.booleanvisitLocate(EJBQLExpression expression, int finishedChildIndex)booleanvisitLower(EJBQLExpression expression, int finishedChildIndex)booleanvisitMax(EJBQLAggregateColumn expression)booleanvisitMemberOf(EJBQLExpression expression)booleanvisitMin(EJBQLAggregateColumn expression)booleanvisitMod(EJBQLExpression expression, int finishedChildIndex)booleanvisitMultiply(EJBQLExpression expression, int finishedChildIndex)Called on visiting "*" expression and also after visiting every expression child.booleanvisitNamedInputParameter(EJBQLExpression expression)booleanvisitNamedInputParameterForIn(EJBQLExpression expression)This method is invoked from the processing of theEJBQLInin order to handle a query such as;booleanvisitNegative(EJBQLExpression expression)booleanvisitNot(EJBQLExpression expression)booleanvisitNotEquals(EJBQLExpression expression, int finishedChildIndex)Called on visiting "!=" expression and also after visiting every expression child.booleanvisitOr(EJBQLExpression expression, int finishedChildIndex)Called on visiting "or" expression and also after visiting every expression child.booleanvisitOrderBy(EJBQLExpression expression)booleanvisitOrderByItem(EJBQLExpression expression)booleanvisitOuterFetchJoin(EJBQLJoin join)booleanvisitOuterJoin(EJBQLJoin join)booleanvisitPath(EJBQLExpression expression, int finishedChildIndex)Called on visiting "path" expression and also after visiting every expression child.booleanvisitPatternValue(EJBQLExpression expression)booleanvisitPositionalInputParameter(EJBQLPositionalInputParameter expression)booleanvisitPositionalInputParameterForIn(EJBQLPositionalInputParameter expression)This method is invoked from the processing of theEJBQLInin order to handle a query such as;booleanvisitSelect(EJBQLExpression expression)booleanvisitSelectClause(EJBQLExpression expression)booleanvisitSelectExpression(EJBQLExpression expression)booleanvisitSelectExpressions(EJBQLExpression expression)booleanvisitSize(EJBQLExpression expression)booleanvisitSqrt(EJBQLExpression expression, int finishedChildIndex)booleanvisitStringLiteral(EJBQLExpression expression)booleanvisitSubselect(EJBQLExpression expression)booleanvisitSubstring(EJBQLExpression expression, int finishedChildIndex)booleanvisitSubtract(EJBQLExpression expression, int finishedChildIndex)Called on visiting "subtract" expression and also after visiting every expression child.booleanvisitSum(EJBQLAggregateColumn expression)booleanvisitTok(EJBQLExpression expression)booleanvisitTrim(EJBQLExpression expression, int finishedChildIndex)booleanvisitTrimBoth(EJBQLExpression expression)booleanvisitTrimCharacter(EJBQLExpression expression)booleanvisitTrimLeading(EJBQLExpression expression)booleanvisitTrimTrailing(EJBQLExpression expression)booleanvisitUpdate(EJBQLExpression expression)booleanvisitUpdateField(EJBQLExpression expression, int finishedChildIndex)booleanvisitUpdateItem(EJBQLExpression expression, int finishedChildIndex)booleanvisitUpdateValue(EJBQLExpression expression)booleanvisitUpper(EJBQLExpression expression, int finishedChildIndex)booleanvisitWhere(EJBQLExpression expression)
- 
Method Details- 
visitAbs
- 
visitAbstractSchemaName
- 
visitAddCalled on visiting "add" expression and also after visiting every expression child.- Parameters:
- expression- an "add" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitAggregate
- 
visitAll
- 
visitAndCalled on visiting "and" expression and also after visiting every expression child.- Parameters:
- expression- an "and" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitAny
- 
visitAscending
- 
visitAverage
- 
visitBetweenCalled on visiting "between" expression and also after visiting every expression child.- Parameters:
- expression- an "between" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitBooleanLiteral
- 
visitClassName
- 
visitConcat
- 
visitConstructor
- 
visitConstructorParameter
- 
visitConstructorParameters
- 
visitCount
- 
visitCurrentDate
- 
visitCurrentTime
- 
visitCurrentTimestamp
- 
visitDecimalLiteral
- 
visitDelete
- 
visitDescending
- 
visitDistinct
- 
visitDivideCalled on visiting "divide" expression and also after visiting every expression child.- Parameters:
- expression- an "divide" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitEqualsCalled on visiting "equals" expression and also after visiting every expression child.- Parameters:
- expression- an "equals" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitEscapeCharacter
- 
visitExists
- 
visitFrom
- 
visitFromItem
- 
visitGreaterOrEqualCalled on visiting ">=" expression and also after visiting every expression child.- Parameters:
- expression- an ">=" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitGreaterThanCalled on visiting ">=" expression and also after visiting every expression child.- Parameters:
- expression- an ">=" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitGroupBy
- 
visitHaving
- 
visitIdentificationVariable
- 
visitIdentifier
- 
visitIn
- 
visitInnerFetchJoin
- 
visitInnerJoin
- 
visitIntegerLiteral
- 
visitIsEmpty
- 
visitIsNull
- 
visitLength
- 
visitLessOrEqualCalled on visiting "<=" expression and also after visiting every expression child.- Parameters:
- expression- an "<=" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitLessThanCalled on visiting "<" expression and also after visiting every expression child.- Parameters:
- expression- an "<" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitLikeCalled on visiting "LIKE" expression and also after visiting every expression child.- Parameters:
- expression- an "LIKE" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitLocate
- 
visitLower
- 
visitMax
- 
visitMemberOf
- 
visitMin
- 
visitMod
- 
visitMultiplyCalled on visiting "*" expression and also after visiting every expression child.- Parameters:
- expression- an "*" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitNamedInputParameterForInThis method is invoked from the processing of the EJBQLInin order to handle a query such as;p.toArtist IN (:artists)
- 
visitNamedInputParameter
- 
visitNegative
- 
visitNot
- 
visitNotEqualsCalled on visiting "!=" expression and also after visiting every expression child.- Parameters:
- expression- an "!=" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitOrCalled on visiting "or" expression and also after visiting every expression child.- Parameters:
- expression- an "or" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitOrderBy
- 
visitOrderByItem
- 
visitOuterFetchJoin
- 
visitOuterJoin
- 
visitPathCalled on visiting "path" expression and also after visiting every expression child.- Parameters:
- expression- a "path" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitDbPath
- 
visitPatternValue
- 
visitPositionalInputParameterForInThis method is invoked from the processing of the EJBQLInin order to handle a query such as;p.toArtist IN (?1)
- 
visitPositionalInputParameter
- 
visitSelect
- 
visitSelectClause
- 
visitSelectExpression
- 
visitSelectExpressions
- 
visitSize
- 
visitSqrt
- 
visitStringLiteral
- 
visitSubselect
- 
visitSubstring
- 
visitSubtractCalled on visiting "subtract" expression and also after visiting every expression child.- Parameters:
- expression- an "subtract" node being visited.
- finishedChildIndex- "-1" when the expression node is visited for the first time, before its children; otherwise this is an index of a child just visited.
 
- 
visitSum
- 
visitTok
- 
visitTrim
- 
visitTrimBoth
- 
visitTrimCharacter
- 
visitTrimLeading
- 
visitTrimTrailing
- 
visitUpdate
- 
visitUpdateField
- 
visitUpdateItem
- 
visitUpdateValue
- 
visitUpper
- 
visitWhere
 
-