EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference

org.eclipse.persistence.jpa.jpql.parser
Class QueryPosition

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.parser.QueryPosition

public final class QueryPosition
extends java.lang.Object

This object contains the cursor position within the parsed tree and within each of the Expression from the root to the deepest leaf.

Version:
2.4
Author:
Pascal Filion
Since:
2.3

Method Summary
 Expression getExpression()
          Returns the child Expression where the position of the cursor is.
 int getPosition()
          Returns the position of the cursor in the query.
 int getPosition(Expression expression)
          Returns the position of the cursor within the given Expression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getExpression

public Expression getExpression()
Returns the child Expression where the position of the cursor is.

Returns:
The deepest Expression child that was retrieving by traversing the parsed tree up to the position of the cursor.

getPosition

public int getPosition()
Returns the position of the cursor in the query.

Returns:
The position of the cursor in the query

getPosition

public int getPosition(Expression expression)
Returns the position of the cursor within the given Expression

Parameters:
expression - The Expression for which the position of the cursor is requested
Returns:
Either the position of the cursor within the given Expression or -1 if the cursor is not within it

EclipseLink 2.4.1, build 'v20121003-ad44345' API Reference