|
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.UnionClause
public final class UnionClause
The UNION clause allows the results of two queries to be combined.
union_clause ::= { UNION | INTERSECT | EXCEPT } [ALL] subquery
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 | |
---|---|
UnionClause(AbstractExpression parent,
java.lang.String identifier)
Creates a new UnionClause . |
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 . |
java.lang.String |
getActualAll()
Returns the actual ALL < found in the string representation of the JPQL
query, which has the actual case that was used. |
java.lang.String |
getActualIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used. |
java.lang.String |
getIdentifier()
Returns the union identifier. |
Expression |
getQuery()
Returns the Expression representing the unioned query. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this Expression . |
boolean |
hasAll()
Determines whether ALL was parsed. |
boolean |
hasQuery()
Determines whether the query was parsed. |
boolean |
hasSpaceAfterAll()
Determines whether a whitespace was parsed after ALL . |
boolean |
hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after the identifier. |
boolean |
isExcept()
Determines whether this UnionClause uses the EXCEPT identifier. |
boolean |
isIntersect()
Determines whether this UnionClause uses the INTERSECT identifier. |
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. |
boolean |
isUnion()
Determines whether this UnionClause uses the UNION identifier. |
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 UnionClause(AbstractExpression parent, java.lang.String identifier)
UnionClause
.
parent
- The parent of this expressionidentifier
- Either UNION
, INTERSECT
or
EXCEPT
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 AbstractExpression
children
- The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.
addOrderedChildrenTo
in class AbstractExpression
children
- The list used to store the string representation of this AbstractExpression
public 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 AbstractExpression
expression
- The Expression
that is a descendant of this one
JPQLQueryBNF
that was used to parse the given expressionpublic java.lang.String getActualAll()
ALL
< found in the string representation of the JPQL
query, which has the actual case that was used.
ALL
identifier that was actually parsedpublic java.lang.String getActualIdentifier()
public java.lang.String getIdentifier()
public Expression getQuery()
Expression
representing the unioned query.
expression
representing the subquerypublic JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasAll()
ALL
was parsed.
true
if ALL
was parsed; false
otherwisepublic boolean hasQuery()
true
the query was parsed; false
otherwisepublic boolean hasSpaceAfterAll()
ALL
.
true
if a whitespace was parsed after ALL
;
false
otherwisepublic boolean hasSpaceAfterIdentifier()
true
if a whitespace was parsed after the identifier; false
otherwisepublic boolean isExcept()
UnionClause
uses the EXCEPT
identifier.
true
if the identifier is EXCEPT
; false
otherwisepublic boolean isIntersect()
UnionClause
uses the INTERSECT
identifier.
true
if the identifier is INTERSECT
; false
otherwiseprotected 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 parsedpublic boolean isUnion()
UnionClause
uses the UNION
identifier.
true
if the identifier is UNION
; false
otherwiseprotected void parse(WordParser wordParser, boolean tolerant)
WordParser
.
parse
in class AbstractExpression
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 AbstractExpression
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 |