org.eclipse.persistence.jpa.internal.jpql.parser

Class SelectStatement

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSelectStatement

org.eclipse.persistence.jpa.internal.jpql.parser.SelectStatement

All Implemented Interfaces:

Expression

public final class SelectStatement
extends AbstractSelectStatement

A select statement must always have a SELECT and a FROM clause.

BNF: select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]

Since:

2.3

Version:

2.3

Author:

Pascal Filion

See Also:

SelectClause

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.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.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
FromClause	addFromClause() Manually adds the FROM clause to this SELECT statement.
Expression	getOrderByClause() Returns the Expression representing the ORDER BY clause.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
SelectClause	getSelectClause() Returns the AbstractSelectClause representing the SELECT clause.
boolean	hasOrderByClause() Determines whether the ORDER BY clause is defined.
boolean	hasSpaceBeforeOrderBy() Determines whether a whitespace was parsed before the ORDER BY clause.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractSelectStatement

addSelectClause, getFromClause, getGroupByClause, getHavingClause, getWhereClause, hasFromClause, hasGroupByClause, hasHavingClause, hasSpaceAfterFrom, hasSpaceAfterGroupBy, hasSpaceAfterSelect, hasSpaceAfterWhere, hasWhereClause

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() or Expression.getChildren() is called.

This does not traverse the Expression sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Specified by:

acceptChildren in interface Expression

Overrides:

acceptChildren in class AbstractSelectStatement

Parameters:

visitor - The visitor to visit the children of this object.

addFromClause

public FromClause addFromClause()

Manually adds the FROM clause to this SELECT statement.

Overrides:

addFromClause in class AbstractSelectStatement

Returns:

The new FROM clause

getOrderByClause

public Expression getOrderByClause()

Returns the Expression representing the ORDER BY clause.

Returns:

The expression representing the ORDER BY clause

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

getSelectClause

public SelectClause getSelectClause()

Returns the AbstractSelectClause representing the SELECT clause.

Overrides:

getSelectClause in class AbstractSelectStatement

Returns:

The expression representing the SELECT clause

hasOrderByClause

public boolean hasOrderByClause()

Determines whether the ORDER BY clause is defined.

Returns:

true if the query that got parsed had the ORDER BY clause

hasSpaceBeforeOrderBy

public boolean hasSpaceBeforeOrderBy()

Determines whether a whitespace was parsed before the ORDER BY clause. In some cases, the space could be owned by a child of the previous clause.

Returns:

true if there was a whitespace before the ORDER BY; false otherwise