Class AbstractSelectStatement
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement
-
- All Implemented Interfaces:
Expression
- Direct Known Subclasses:
SelectStatement
,SimpleSelectStatement
public abstract class AbstractSelectStatement extends AbstractExpression
A query is an operation that retrieves data from one or more tables or views. In this reference, a top-levelSELECT
statement is called a query, and a query nested within another SQL statement is called a subquery.- Since:
- 2.3
- Version:
- 2.5
- Author:
- Pascal Filion
- See Also:
SelectStatement
,SimpleSelectStatement
-
-
Field Summary
-
Fields inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
-
Fields inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
ABS, ALL, AND, ANY, AS, AS_OF, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, FROM, FUNC, FUNCTION, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, INTERSECT, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, LAST, LEADING, LEFT, LEFT_JOIN, LEFT_JOIN_FETCH, LEFT_OUTER_JOIN, LEFT_OUTER_JOIN_FETCH, LENGTH, LIKE, LOCATE, LOWER, LOWER_THAN, LOWER_THAN_OR_EQUAL, MAX, MEMBER, MEMBER_OF, MIN, MINUS, MOD, MULTIPLICATION, NAMED_PARAMETER, NEW, NOT, NOT_BETWEEN, NOT_EQUAL, NOT_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, NULLS, NULLS_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, ORDER_SIBLINGS_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
.JPQLQueryBNF
findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.Expression
getFromClause()
Returns theExpression
representing the FROM clause.Expression
getGroupByClause()
Returns theExpression
representing the GROUP BY clause.Expression
getHavingClause()
Returns theExpression
representing the HAVING clause.Expression
getSelectClause()
Returns theAbstractSelectClause
representing the SELECT clause.Expression
getWhereClause()
Returns theExpression
representing the WHERE clause.boolean
hasFromClause()
Determines whether the FROM clause was parsed or not.boolean
hasGroupByClause()
Determines whether the GROUP BY clause was parsed or not.boolean
hasHavingClause()
Determines whether the HAVING clause was parsed or not.boolean
hasSelectClause()
Determines whether the SELECT clause was parsed or not.boolean
hasSpaceAfterFrom()
Determines whether a whitespace was found after the FROM clause.boolean
hasSpaceAfterGroupBy()
Determines whether a whitespace was found after the GROUP BY clause.boolean
hasSpaceAfterSelect()
Determines whether a whitespace was found after the SELECT clause.boolean
hasSpaceAfterWhere()
Determines whether a whitespace was found after the WHERE clause.boolean
hasWhereClause()
Determines whether the WHERE clause is defined.-
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression
accept, getQueryBNF
-
-
-
-
Method Detail
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression
. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()
is called.This does not traverse the
Expression
sub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.- Parameters:
visitor
- Thevisitor
to visit the children of this object.
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.- Specified by:
findQueryBNF
in interfaceExpression
- Overrides:
findQueryBNF
in classAbstractExpression
- Parameters:
expression
- TheExpression
that is a descendant of this one- Returns:
- The
JPQLQueryBNF
that was used to parse the given expression
-
getFromClause
public final Expression getFromClause()
Returns theExpression
representing the FROM clause.- Returns:
- The expression representing the FROM clause
-
getGroupByClause
public final Expression getGroupByClause()
Returns theExpression
representing the GROUP BY clause.- Returns:
- The expression representing the GROUP BY clause
-
getHavingClause
public final Expression getHavingClause()
Returns theExpression
representing the HAVING clause.- Returns:
- The expression representing the HAVING clause
-
getSelectClause
public final Expression getSelectClause()
Returns theAbstractSelectClause
representing the SELECT clause.- Returns:
- The expression representing the SELECT clause
-
getWhereClause
public final Expression getWhereClause()
Returns theExpression
representing the WHERE clause.- Returns:
- The expression representing the WHERE clause
-
hasFromClause
public final boolean hasFromClause()
Determines whether the FROM clause was parsed or not.- Returns:
true
if the query that got parsed had the FROM clause
-
hasGroupByClause
public final boolean hasGroupByClause()
Determines whether the GROUP BY clause was parsed or not.- Returns:
true
if the query that got parsed had the GROUP BY clause
-
hasHavingClause
public final boolean hasHavingClause()
Determines whether the HAVING clause was parsed or not.- Returns:
true
if the query that got parsed had the HAVING clause
-
hasSelectClause
public final boolean hasSelectClause()
Determines whether the SELECT clause was parsed or not.- Returns:
true
if the query that got parsed had the HAVING clause- Since:
- 2.5
-
hasSpaceAfterFrom
public final boolean hasSpaceAfterFrom()
Determines whether a whitespace was found after the FROM clause. In some cases, the space is owned by a child of the FROM clause.- Returns:
true
if there was a whitespace after the FROM clause and owned by this expression;false
otherwise
-
hasSpaceAfterGroupBy
public final boolean hasSpaceAfterGroupBy()
Determines whether a whitespace was found after the GROUP BY clause. In some cases, the space is owned by a child of the GROUP BY clause.- Returns:
true
if there was a whitespace after the GROUP BY clause and owned by this expression;false
otherwise
-
hasSpaceAfterSelect
public final boolean hasSpaceAfterSelect()
Determines whether a whitespace was found after the SELECT clause. In some cases, the space is owned by a child of the SELECT clause.- Returns:
true
if there was a whitespace after the SELECT clause and owned by this expression;false
otherwise
-
hasSpaceAfterWhere
public final boolean hasSpaceAfterWhere()
Determines whether a whitespace was found after the WHERE clause. In some cases, the space is owned by a child of the WHERE clause.- Returns:
true
if there was a whitespace after the WHERE clause and owned by this expression;false
otherwise
-
hasWhereClause
public final boolean hasWhereClause()
Determines whether the WHERE clause is defined.- Returns:
true
if the query that got parsed had the WHERE clause
-
-