|
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 |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement
org.eclipse.persistence.jpa.jpql.parser.SelectStatement
public final class SelectStatement
A select statement must always have a SELECT and a FROM clause.
JPA:
select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]
EclipseLink 2.4:
select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause] {union_clause}*
SelectClause
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 |
Constructor Summary | |
---|---|
SelectStatement(AbstractExpression parent)
Creates a new SelectStatement . |
Method Summary | |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this Expression . |
protected void |
addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection. |
protected void |
addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list. |
protected FromClause |
buildFromClause()
Creates the expression representing the from clause of this select statement. |
protected SelectClause |
buildSelectClause()
Creates the expression representing the select clause of this select statement. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression . |
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. |
Expression |
getUnionClauses()
Returns the Expression representing the UNION clauses. |
boolean |
hasOrderByClause()
Determines whether the ORDER BY clause is defined. |
boolean |
hasSpaceBeforeOrderBy()
Determines whether a whitespace was parsed before the ORDER BY clause. |
boolean |
hasSpaceBeforeUnion()
Determines whether a whitespace was parsed before the UNION clause. |
boolean |
hasUnionClauses()
Determines whether at least one UNION clause was defined. |
protected boolean |
isParsingComplete(WordParser wordParser,
java.lang.String word,
Expression expression)
Determines whether the parsing is complete based on what is left in the given text. |
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser . |
protected void |
toParsedText(java.lang.StringBuilder writer,
boolean actual)
Generates a string representation of this Expression , including its children,
if it has any. |
Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractSelectStatement |
---|
addSelectClause, getFromClause, getGroupByClause, getHavingClause, getWhereClause, hasFromClause, hasGroupByClause, hasHavingClause, hasSpaceAfterFrom, hasSpaceAfterGroupBy, hasSpaceAfterSelect, hasSpaceAfterWhere, hasWhereClause, shouldManageSpaceAfterClause |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SelectStatement(AbstractExpression parent)
SelectStatement
.
parent
- The parent of this expressionMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.
visitor
- The ExpressionVisitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression
. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children()
is called.
This does not traverse the Expression
sub-hierarchy, use a subclass of
AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
acceptChildren
in interface Expression
acceptChildren
in class AbstractSelectStatement
visitor
- The visitor
to visit the children of this object.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression
to the given collection.
addChildrenTo
in class AbstractSelectStatement
children
- The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.
addOrderedChildrenTo
in class AbstractSelectStatement
children
- The list used to store the string representation of this AbstractExpression
protected FromClause buildFromClause()
buildFromClause
in class AbstractSelectStatement
null
can't be returnedprotected SelectClause buildSelectClause()
buildSelectClause
in class AbstractSelectStatement
null
can't be returnedpublic JPQLQueryBNF findQueryBNF(Expression expression)
JPQLQueryBNF
that represents the fragment of this Expression
that was used when parsing the given Expression
.
findQueryBNF
in interface Expression
findQueryBNF
in class AbstractSelectStatement
expression
- The Expression
that is a descendant of this one
JPQLQueryBNF
that was used to parse the given expressionpublic Expression getOrderByClause()
Expression
representing the ORDER BY clause.
public JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
public SelectClause getSelectClause()
AbstractSelectClause
representing the SELECT clause.
getSelectClause
in class AbstractSelectStatement
public Expression getUnionClauses()
Expression
representing the UNION clauses.
Expression
representing the UNION clausespublic boolean hasOrderByClause()
true
if the query that got parsed had the ORDER BY clausepublic boolean hasSpaceBeforeOrderBy()
true
if there was a whitespace before the ORDER BY; false
otherwisepublic boolean hasSpaceBeforeUnion()
true
if there was a whitespace before the UNION;
false
otherwisepublic boolean hasUnionClauses()
true
if the query that got parsed had the UNION clausesprotected boolean isParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)
isParsingComplete
in class AbstractExpression
wordParser
- The text to parse based on the current position of the cursorword
- The word that was retrieved from the given text, which is the first word in the textexpression
- The Expression
that has already been parsed
true
if the text no longer can't be parsed by the current expression;
false
if more can be parsedprotected void parse(WordParser wordParser, boolean tolerant)
WordParser
.
parse
in class AbstractSelectStatement
wordParser
- The text to parse based on the current position of the cursortolerant
- Determines whether the parsing system should be tolerant, meaning if it should
try to parse invalid or incomplete queriesprotected void toParsedText(java.lang.StringBuilder writer, boolean actual)
Expression
, including its children,
if it has any.
toParsedText
in class AbstractSelectStatement
writer
- The buffer used to append this Expression
's string representationactual
- Determines whether the string representation should represent what was parsed,
i.e. include any "virtual" whitespace (such as ending whitespace) and the actual case of the
JPQL identifiers
|
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 |