|
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
public abstract class AbstractSelectStatement
A select statement must always have a SELECT and a FROM
clause. The other clauses are optional.
select_statement ::= select_clause from_clause [where_clause] [groupby_clause] [having_clause] [orderby_clause]
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 |
| Constructor Summary | |
|---|---|
protected |
AbstractSelectStatement(AbstractExpression parent)
Creates a new AbstractSelectStatement. |
| Method Summary | |
|---|---|
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. |
SelectClause |
addSelectClause()
Sets the query statement to be a select clause. |
protected abstract AbstractFromClause |
buildFromClause()
Creates the expression representing the from clause of this select statement. |
protected abstract AbstractSelectClause |
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 |
getFromClause()
Returns the Expression representing the FROM clause. |
Expression |
getGroupByClause()
Returns the Expression representing the GROUP BY clause. |
Expression |
getHavingClause()
Returns the Expression representing the HAVING clause. |
AbstractSelectClause |
getSelectClause()
Returns the AbstractSelectClause representing the SELECT clause. |
Expression |
getWhereClause()
Returns the Expression representing the WHERE clause. |
boolean |
hasFromClause()
Determines whether the FROM clause is defined. |
boolean |
hasGroupByClause()
Determines whether the GROUP BY clause is defined. |
boolean |
hasHavingClause()
Determines whether the HAVING clause is defined. |
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. |
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser. |
protected boolean |
shouldManageSpaceAfterClause()
Determines whether |
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression |
|---|
accept, getQueryBNF |
| Constructor Detail |
|---|
protected AbstractSelectStatement(AbstractExpression parent)
AbstractSelectStatement.
parent - The parent of this expression| Method Detail |
|---|
public 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.
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 AbstractExpressionchildren - The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression to the given list.
addOrderedChildrenTo in class AbstractExpressionchildren - The list used to store the string representation of this AbstractExpressionpublic final SelectClause addSelectClause()
protected abstract AbstractFromClause buildFromClause()
null can't be returnedprotected abstract AbstractSelectClause buildSelectClause()
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 ExpressionfindQueryBNF in class AbstractExpressionexpression - The Expression that is a descendant of this one
JPQLQueryBNF that was used to parse the given expressionpublic final Expression getFromClause()
Expression representing the FROM clause.
public final Expression getGroupByClause()
Expression representing the GROUP BY clause.
public final Expression getHavingClause()
Expression representing the HAVING clause.
public AbstractSelectClause getSelectClause()
AbstractSelectClause representing the SELECT clause.
public final Expression getWhereClause()
Expression representing the WHERE clause.
public final boolean hasFromClause()
true if the query that got parsed had the FROM clausepublic final boolean hasGroupByClause()
true if the query that got parsed had the GROUP BY clausepublic final boolean hasHavingClause()
true if the query that got parsed had the HAVING clausepublic final boolean hasSpaceAfterFrom()
true if there was a whitespace after the FROM clause and owned by
this expression; false otherwisepublic final boolean hasSpaceAfterGroupBy()
true if there was a whitespace after the GROUP BY clause and owned
by this expression; false otherwisepublic final boolean hasSpaceAfterSelect()
true if there was a whitespace after the SELECT clause and owned
by this expression; false otherwisepublic final boolean hasSpaceAfterWhere()
true if there was a whitespace after the WHERE clause and owned by
this expression; false otherwisepublic final boolean hasWhereClause()
true if the query that got parsed had the WHERE clauseprotected void parse(WordParser wordParser, boolean tolerant)
WordParser.
parse in class AbstractExpressionwordParser - 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 boolean shouldManageSpaceAfterClause()
protected void toParsedText(java.lang.StringBuilder writer,
boolean actual)
Expression, including its children,
if it has any.
toParsedText in class AbstractExpressionwriter - 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 | ||||||||