AbstractContentAssistVisitor.EndingQueryPositionBuilder (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.EndingQueryPositionBuilder

java.lang.Object
  org.eclipse.persistence.jpa.jpql.AbstractContentAssistVisitor.EndingQueryPositionBuilder

All Implemented Interfaces:: ExpressionVisitor

Direct Known Subclasses:: EclipseLinkContentAssistVisitor.EndingQueryPositionBuilder

Enclosing class:: AbstractContentAssistVisitor

protected class AbstractContentAssistVisitor.EndingQueryPositionBuilder
extends java.lang.Object
implements ExpressionVisitor
extends java.lang.Object
implements ExpressionVisitor

This builder populates a QueryPosition by traversing the valid portion of the JPQL query. The position is the end of each Expression.

For instance, "SELECT e FROM Employee e O WHERE e.name = 'JPQL'", the valid fragment is "SELECT e FROM Employee e", the positions will be:

JPQLExpression = 24
SelectStatement = 24
FromClause = 15
IdentificationVariableDeclaration = 10
RangeVariableDeclaration = 10
IdentificationVariable = 1

Field Summary
`protected boolean`	`badExpression` This internal flag helps to determine if the `Expression` where the cursor is located was flagged to be invalid.
`protected int`	`correction` This is used to correct the length of an `Expression`
`protected Expression`	`invalidExpression` The `Expression` containing the invalid fragment.
`protected int`	`positionWithinInvalidExpression` The position of the cursor within the invalid expression.
`QueryPosition`	`queryPosition` This `QueryPosition` has the position of each `Expression` within the valid fragment of the JPQL query.
`boolean`	`virtualSpace` Indicates whether a virtual space should be added to the stack or not.

Constructor Summary
`protected`	`AbstractContentAssistVisitor.EndingQueryPositionBuilder()`

Method Summary
`void`	`dispose()` Disposes the internal data.
`QueryPosition`	`getQueryPosition()` Returns the new `QueryPosition` that was created.
`boolean`	`hasVirtualSpace()` Determines whether a virtual space should be added to the stack or not.
`void`	`prepare(Expression invalidExpression)` Prepares this visitor before visiting an `Expression`.
`void`	`visit(AbsExpression expression)` Visits the `AbsExpression` expression.
`void`	`visit(AbstractSchemaName expression)` Visits the `AbstractSchemaName` expression.
`void`	`visit(AdditionExpression expression)` Visits the `AdditionExpression` expression.
`void`	`visit(AllOrAnyExpression expression)` Visits the `AllOrAnyExpression` expression.
`void`	`visit(AndExpression expression)` Visits the `AndExpression` expression.
`void`	`visit(ArithmeticFactor expression)` Visits the `ArithmeticFactor` expression.
`void`	`visit(AvgFunction expression)` Visits the `AvgFunction` expression.
`void`	`visit(BadExpression expression)` Visits the `BadExpression` expression.
`void`	`visit(BetweenExpression expression)` Visits the `BetweenExpression` expression.
`void`	`visit(CaseExpression expression)` Visits the `CaseExpression` expression.
`void`	`visit(CoalesceExpression expression)` Visits the `CoalesceExpression` 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(CollectionValuedPathExpression expression)` Visits the `CollectionValuedPathExpression` expression.
`void`	`visit(ComparisonExpression expression)` Visits the `ComparisonExpression` expression.
`void`	`visit(ConcatExpression expression)` Visits the `ConcatExpression` expression.
`void`	`visit(ConstructorExpression expression)` Visits the `ConstructorExpression` expression.
`void`	`visit(CountFunction expression)` Visits the `CountFunction` expression.
`void`	`visit(DateTime expression)` Visits the `DateTime` expression.
`void`	`visit(DeleteClause expression)` Visits the `DeleteClause` expression.
`void`	`visit(DeleteStatement expression)` Visits the `DeleteStatement` expression.
`void`	`visit(DivisionExpression expression)` Visits the `DivisionExpression` expression.
`void`	`visit(EmptyCollectionComparisonExpression expression)` Visits the `EmptyCollectionComparisonExpression` expression.
`void`	`visit(EntityTypeLiteral expression)` Visits the `EntityTypeLiteral` expression.
`void`	`visit(EntryExpression expression)` Visits the `EntryExpression` expression.
`void`	`visit(ExistsExpression expression)` Visits the `ExistsExpression` expression.
`void`	`visit(FromClause expression)` Visits the `FromClause` expression.
`void`	`visit(FunctionExpression expression)` Visits the `FunctionExpression` 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(IndexExpression expression)` Visits the `IndexExpression` expression.
`void`	`visit(InExpression expression)` Visits the `InExpression` expression.
`void`	`visit(InputParameter expression)` Visits the `InputParameter` expression.
`void`	`visit(Join expression)` Visits the `Join` expression.
`void`	`visit(JPQLExpression expression)` Visits the `JPQLExpression` expression.
`void`	`visit(KeyExpression expression)` Visits the `KeyExpression` expression.
`void`	`visit(KeywordExpression expression)` Visits the `KeywordExpression` expression.
`void`	`visit(LengthExpression expression)` Visits the `LengthExpression` expression.
`void`	`visit(LikeExpression expression)` Visits the `LikeExpression` expression.
`void`	`visit(LocateExpression expression)` Visits the `LocateExpression` expression.
`void`	`visit(LowerExpression expression)` Visits the `LowerExpression` expression.
`void`	`visit(MaxFunction expression)` Visits the `MaxFunction` expression.
`void`	`visit(MinFunction expression)` Visits the `MinFunction` expression.
`void`	`visit(ModExpression expression)` Visits the `ModExpression` 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(NullExpression expression)` Visits the `NullExpression` expression.
`void`	`visit(NullIfExpression expression)` Visits the `NullIfExpression` expression.
`void`	`visit(NumericLiteral expression)` Visits the `NumericLiteral` expression.
`void`	`visit(ObjectExpression expression)` Visits the `ObjectExpression` 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(SelectStatement expression)` Visits the `SelectStatement` expression.
`void`	`visit(SimpleFromClause expression)` Visits the `SimpleFromClause` expression.
`void`	`visit(SimpleSelectClause expression)` Visits the `SimpleSelectClause` expression.
`void`	`visit(SimpleSelectStatement expression)` Visits the `SimpleSelectStatement` expression.
`void`	`visit(SizeExpression expression)` Visits the `SizeExpression` expression.
`void`	`visit(SqrtExpression expression)` Visits the `SqrtExpression` expression.
`void`	`visit(StateFieldPathExpression expression)` Visits the `StateFieldPathExpression` expression.
`void`	`visit(StringLiteral expression)` Visits the `StringLiteral` expression.
`void`	`visit(SubExpression expression)` Visits the `SubExpression` expression.
`void`	`visit(SubstringExpression expression)` Visits the `SubstringExpression` expression.
`void`	`visit(SubtractionExpression expression)` Visits the `SubtractionExpression` expression.
`void`	`visit(SumFunction expression)` Visits the `SumFunction` expression.
`void`	`visit(TreatExpression expression)` Visits the `TreatExpression` expression.
`void`	`visit(TrimExpression expression)` Visits the `TrimExpression` expression.
`void`	`visit(TypeExpression expression)` Visits the `TypeExpression` expression.
`void`	`visit(UnknownExpression expression)` Visits the `UnknownExpression` expression.
`void`	`visit(UpdateClause expression)` Visits the `UpdateClause` expression.
`void`	`visit(UpdateItem expression)` Visits the `UpdateItem` expression.
`void`	`visit(UpdateStatement expression)` Visits the `UpdateStatement` expression.
`void`	`visit(UpperExpression expression)` Visits the `UpperExpression` expression.
`void`	`visit(ValueExpression expression)` Visits the `ValueExpression` expression.
`void`	`visit(WhenClause expression)` Visits the `WhenClause` expression.
`void`	`visit(WhereClause expression)` Visits the `WhereClause` expression.
`protected void`	`visitAbstractConditionalClause(AbstractConditionalClause expression)`
`protected void`	`visitAbstractDoubleEncapsulatedExpression(AbstractDoubleEncapsulatedExpression expression)`
`protected void`	`visitAbstractFromClause(AbstractFromClause expression)`
`protected void`	`visitAbstractSingleEncapsulatedExpression(AbstractSingleEncapsulatedExpression expression)`
`protected void`	`visitAbstractTripleEncapsulatedExpression(AbstractTripleEncapsulatedExpression expression)`
`protected void`	`visitCompoundExpression(CompoundExpression expression)`

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

Field Detail

badExpression

protected boolean badExpression

This internal flag helps to determine if the Expression where the cursor is located was flagged to be invalid. If so, this helps to determine how to handle the calculation of the new position within the query.

For instance: "SELECT e FROM Employee e AS" has a bad expression wrapping the identifier "AS", which is parsed as a result variable. In this case, the position would actually be 2 within the bad expression. If the bad expression was something more complex than just a single word, then that expression should not be included in the position.

correction

protected int correction

This is used to correct the length of an Expression

invalidExpression

protected Expression invalidExpression

The Expression containing the invalid fragment.

positionWithinInvalidExpression

protected int positionWithinInvalidExpression

The position of the cursor within the invalid expression.

queryPosition

public QueryPosition queryPosition

This QueryPosition has the position of each Expression within the valid fragment of the JPQL query.

virtualSpace

public boolean virtualSpace

Indicates whether a virtual space should be added to the stack or not.

Constructor Detail