AbstractContentAssistVisitor.AppendableExpressionVisitor (EclipseLink 2.4.2, build 'v20130514-5956486' API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.persistence.jpa.jpql
Class AbstractContentAssistVisitor.AppendableExpressionVisitor

java.lang.Object
  org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
      org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor
          org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AppendableExpressionVisitor

All Implemented Interfaces:: ExpressionVisitor

Direct Known Subclasses:: EclipseLinkContentAssistVisitor.AppendableExpressionVisitor

Enclosing class:: AbstractContentAssistVisitor

protected class AbstractContentAssistVisitor.AppendableExpressionVisitor
extends AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor
extends AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor

This visitor scans the visited Expression and determines if a JPQL identifier can be added ("appended") when the position of the cursor is at the end of the expression.

For instance:

In "SELECT e, AVG(e.age) F|", F is parsed as a result variable but can also be seen as the first letter for FROM;
In "SELECT e FROM Employee e WHERE e.name |", the compound identifiers can be added, eg: 'IS NOT NULL', or '=', etc
In "SELECT e FROM Employee e WHERE e.name NOT B|", only the composite identifier "BETWEEN" and "NOT BETWEEN" can be added because the NOT expression does not have a valid expression: "B" is not a valid expression.
In "SELECT e FROM Employee e FROM e.age|", the arithmetic and comparison identifiers are allowed, but the logical and compound identifiers.

Field Summary
`protected AbstractContentAssistVisitor.AppendableType`	`appendableType` The type of the JPQL identifiers can can be possible proposals.
`protected boolean`	`clauseOfItems` Internal flag indicating if a clause is being visited which can have a collection of children.
`protected CollectionExpression`	`collectionExpression` Caches the visited `CollectionExpression` so a child could use it.
`protected boolean`	`hasComma` When visiting a `CollectionExpression`, this indicates if there is a comma before the child being visited.
`protected int`	`positionInCollection` When visiting a `CollectionExpression`, this indicates the position within that collection of the child being visited.
`protected boolean`	`subExpression` Internal flag indicating the `Expression` being visited is encapsulated by parenthesis.

Fields inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor
`appendable`

Constructor Summary
`protected`	`AbstractContentAssistVisitor.AppendableExpressionVisitor()` Creates a new `AppendableExpressionVisitor`.

Method Summary
`void`	`visit(AdditionExpression expression)` Visits the `AdditionExpression` expression.
`void`	`visit(AndExpression expression)` Visits the `AndExpression` expression.
`void`	`visit(CollectionExpression expression)` Visits the `CollectionExpression` expression.
`void`	`visit(CollectionMemberDeclaration expression)` Visits the `CollectionMemberDeclaration` expression.
`void`	`visit(CollectionMemberExpression expression)` Visits the `CollectionMemberExpression` expression.
`void`	`visit(ComparisonExpression expression)` Visits the `ComparisonExpression` expression.
`void`	`visit(DateTime expression)` Visits the `DateTime` expression.
`void`	`visit(DeleteClause expression)` Visits the `DeleteClause` expression.
`void`	`visit(DivisionExpression expression)` Visits the `DivisionExpression` expression.
`void`	`visit(EmptyCollectionComparisonExpression expression)` Visits the `EmptyCollectionComparisonExpression` expression.
`protected void`	`visit(Expression expression)` Blindly visit the given `Expression`.
`void`	`visit(FromClause expression)` Visits the `FromClause` expression.
`void`	`visit(GroupByClause expression)` Visits the `GroupByClause` expression.
`void`	`visit(HavingClause expression)` Visits the `HavingClause` expression.
`void`	`visit(IdentificationVariable expression)` Visits the `IdentificationVariable` expression.
`void`	`visit(IdentificationVariableDeclaration expression)` Visits the `IdentificationVariableDeclaration` expression.
`void`	`visit(KeywordExpression expression)` Visits the `KeywordExpression` expression.
`void`	`visit(MultiplicationExpression expression)` Visits the `MultiplicationExpression` expression.
`void`	`visit(NotExpression expression)` Visits the `NotExpression` expression.
`void`	`visit(NullComparisonExpression expression)` Visits the `NullComparisonExpression` expression.
`void`	`visit(OnClause expression)` Visits the `OnClause` expression.
`void`	`visit(OrderByClause expression)` Visits the `OrderByClause` expression.
`void`	`visit(OrderByItem expression)` Visits the `OrderByItem` expression.
`void`	`visit(OrExpression expression)` Visits the `OrExpression` expression.
`void`	`visit(RangeVariableDeclaration expression)` Visits the `RangeVariableDeclaration` expression.
`void`	`visit(ResultVariable expression)` Visits the `ResultVariable` expression.
`void`	`visit(SelectClause expression)` Visits the `SelectClause` expression.
`void`	`visit(SimpleFromClause expression)` Visits the `SimpleFromClause` expression.
`void`	`visit(SimpleSelectClause expression)` Visits the `SimpleSelectClause` expression.
`void`	`visit(StateFieldPathExpression expression)` Visits the `StateFieldPathExpression` expression.
`void`	`visit(SubExpression expression)` Visits the `SubExpression` expression.
`void`	`visit(SubtractionExpression expression)` Visits the `SubtractionExpression` expression.
`void`	`visit(WhereClause expression)` Visits the `WhereClause` expression.

Methods inherited from class org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.AbstractAppendableExpressionVisitor
`dispose, isAppendable`

Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AnonymousExpressionVisitor
`visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

appendableType

protected AbstractContentAssistVisitor.AppendableType appendableType

The type of the JPQL identifiers can can be possible proposals.

clauseOfItems

protected boolean clauseOfItems

Internal flag indicating if a clause is being visited which can have a collection of children.

collectionExpression

protected CollectionExpression collectionExpression

Caches the visited CollectionExpression so a child could use it.

hasComma

protected boolean hasComma

When visiting a CollectionExpression, this indicates if there is a comma before the child being visited.

positionInCollection

protected int positionInCollection

When visiting a CollectionExpression, this indicates the position within that collection of the child being visited.

subExpression

protected boolean subExpression

Internal flag indicating the Expression being visited is encapsulated by parenthesis.

Constructor Detail