|
EclipseLink 2.5.0, build 'v20130507-3faac2b' 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.HierarchicalQueryClause
public final class HierarchicalQueryClause
If a table contains hierarchical data, then rows can be selected in a hierarchical order using the hierarchical query clause.
START WITH specifies the root row(s) of the hierarchy.
CONNECT BY specifies the relationship between parent rows and child rows of
the hierarchy.
hierarchical_query_clause ::= [start_with_clause] connectby_clause [order_siblings_by_clause]
StartWithClause,
ConnectByClause,
OrderSiblingsByClause| 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 | |
|---|---|
HierarchicalQueryClause(AbstractExpression parent)
Creates a new HierarchicalQueryClause. |
|
| 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. |
JPQLQueryBNF |
findQueryBNF(Expression expression)
Retrieves the JPQLQueryBNF that represents the fragment of this Expression
that was used when parsing the given Expression. |
Expression |
getConnectByClause()
Returns the Expression representing the CONNECT BY clause. |
Expression |
getOrderSiblingsByClause()
Returns the Expression representing the ORDER SIBLINGS BY clause. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this Expression. |
Expression |
getStartWithClause()
Returns the Expression representing the START WITH clause. |
boolean |
hasConnectByClause()
Determines whether the CONNECT BY clause is defined. |
boolean |
hasOrderSiblingsByClause()
Determines whether the ORDER SIBLINGS BY clause is defined. |
boolean |
hasSpaceAfterConnectByClause()
Determines whether a whitespace was found after the CONNECT BY clause. |
boolean |
hasSpaceAfterStartWithClause()
Determines whether a whitespace was found after the START WITH clause. |
boolean |
hasStartWithClause()
Determines whether the START WITH 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 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 |
| Constructor Detail |
|---|
public HierarchicalQueryClause(AbstractExpression parent)
HierarchicalQueryClause.
parent - The parent of this expression| Method 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.
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 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 Expression getConnectByClause()
Expression representing the CONNECT BY clause.
public Expression getOrderSiblingsByClause()
Expression representing the ORDER SIBLINGS BY clause.
public JPQLQueryBNF getQueryBNF()
Expression.
JPQLQueryBNF, which represents the grammar of this Expressionpublic Expression getStartWithClause()
Expression representing the START WITH clause.
public boolean hasConnectByClause()
true if the query that got parsed had the CONNECT BY clausepublic boolean hasOrderSiblingsByClause()
true if the query that got parsed had the ORDER SIBLINGS BY clausepublic boolean hasSpaceAfterConnectByClause()
CONNECT BY clause. In
some cases, the space is owned by a child of the hierarchical query clause.
true if there was a whitespace after the CONNECT BY
clause and owned by this expression; false otherwisepublic boolean hasSpaceAfterStartWithClause()
START WITH clause. In
some cases, the space is owned by a child of the hierarchical query clause.
true if there was a whitespace after the START WITH
clause and owned by this expression; false otherwisepublic boolean hasStartWithClause()
true if the query that got parsed had the START WITH 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 queries
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.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||