Class ConnectByClause
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.ConnectByClause
- All Implemented Interfaces:
Expression
The CONNECT BY clause allows selecting rows in a hierarchical order using the hierarchical
query clause. CONNECT BY specifies the relationship between parent rows and child rows of
the hierarchy.
BNF:
connectby_clause ::= CONNECT BY { single_valued_object_path_expression | collection_valued_path_expression }
- Since:
- 2.5
- Version:
- 2.5
-
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, CEILING, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DATE, DATETIME, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXP, EXTRACT, FALSE, FETCH, FIRST, FLOOR, 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, LN, LOCAL, 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, POWER, QUOTE, REGEXP, ROUND, SCN, SELECT, SET, SIGN, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIME, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ExpressionVisitor visitor) Visits thisExpression
by the givenvisitor
.void
acceptChildren
(ExpressionVisitor visitor) Visits the children of thisExpression
.protected void
addChildrenTo
(Collection<Expression> children) Adds the children of thisAbstractExpression
to the given collection.protected void
addOrderedChildrenTo
(List<Expression> children) Adds the children of thisAbstractExpression
to the given list.findQueryBNF
(Expression expression) Retrieves theJPQLQueryBNF
that represents the fragment of thisExpression
that was used when parsing the givenExpression
.Returns the actual CONNECT BY identifier found in the string representation of the JPQL query, which has the actual case that was used.Returns theExpression
representing the relationship expression.Returns the BNF of thisExpression
.boolean
Determines whether the relationship expression was parsed.boolean
Determines whether a whitespace was found after CONNECT BY.protected void
parse
(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the givenWordParser
.protected void
toParsedText
(StringBuilder writer, boolean actual) Generates a string representation of thisExpression
, including its children, if it has any.Methods inherited from class org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, handleCollection, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
Constructor Details
-
ConnectByClause
Creates a newConnectByClause
.- Parameters:
parent
- The parent of this expression
-
-
Method Details
-
accept
Description copied from interface:Expression
Visits thisExpression
by the givenvisitor
.- Parameters:
visitor
- TheExpressionVisitor
to visit this object
-
acceptChildren
Description copied from interface:Expression
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.
-
addChildrenTo
Description copied from class:AbstractExpression
Adds the children of thisAbstractExpression
to the given collection.- Overrides:
addChildrenTo
in classAbstractExpression
- Parameters:
children
- The collection used to store the children
-
addOrderedChildrenTo
Description copied from class:AbstractExpression
Adds the children of thisAbstractExpression
to the given list.- Overrides:
addOrderedChildrenTo
in classAbstractExpression
- Parameters:
children
- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
Description copied from interface: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
-
getActualIdentifier
Returns the actual CONNECT BY identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The CONNECT BY identifier that was actually parsed, or an empty string if it was not parsed
-
getExpression
Returns theExpression
representing the relationship expression.- Returns:
- The expression representing the relationship expression
-
getQueryBNF
Description copied from interface:Expression
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
hasExpression
public boolean hasExpression()Determines whether the relationship expression was parsed.- Returns:
true
if the relationship expression was parsed;false
if it was not parsed
-
hasSpaceAfterConnectBy
public boolean hasSpaceAfterConnectBy()Determines whether a whitespace was found after CONNECT BY.- Returns:
true
if there was a whitespace after CONNECT BY;false
otherwise
-
parse
Description copied from class:AbstractExpression
Parses the query by starting at the current position, which is part of the givenWordParser
.- Specified by:
parse
in classAbstractExpression
- Parameters:
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 queries
-
toParsedText
Description copied from class:AbstractExpression
Generates a string representation of thisExpression
, including its children, if it has any.- Specified by:
toParsedText
in classAbstractExpression
- Parameters:
writer
- The buffer used to append thisExpression
'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
-