Class UnionClause
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.UnionClause
-
- All Implemented Interfaces:
Expression
public final class UnionClause extends AbstractExpression
The UNION clause allows the results of two queries to be combined.BNF:union_clause ::= { UNION | INTERSECT | EXCEPT } [ALL] subquery- Version:
- 2.5
- Author:
- James Sutherland
- Since:
- 2.4
-
-
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, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, CONNECT_BY, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXCEPT, EXISTS, EXTRACT, FALSE, FETCH, FIRST, 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, 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, QUOTE, REGEXP, SCN, SELECT, SET, SIZE, SOME, SQL, SQRT, START_WITH, SUBSTRING, SUM, TABLE, THEN, TIMESTAMP, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
-
-
Constructor Summary
Constructors Constructor Description UnionClause(AbstractExpression parent, java.lang.String identifier)Creates a newUnionClause.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.java.lang.StringgetActualAll()Returns the actualALLfound in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualIdentifier()Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetIdentifier()Returns the union identifier.ExpressiongetQuery()Returns theExpressionrepresenting the unioned query.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.booleanhasAll()Determines whetherALLwas parsed.booleanhasQuery()Determines whether the query was parsed.booleanhasSpaceAfterAll()Determines whether a whitespace was parsed afterALL.booleanhasSpaceAfterIdentifier()Determines whether a whitespace was parsed after the identifier.booleanisExcept()Determines whether thisUnionClauseuses theEXCEPTidentifier.booleanisIntersect()Determines whether thisUnionClauseuses theINTERSECTidentifier.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.booleanisUnion()Determines whether thisUnionClauseuses theUNIONidentifier.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected java.lang.StringparseIdentifier()Parses the JPQL identifier identifier the type of union.protected voidtoParsedText(java.lang.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, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
UnionClause
public UnionClause(AbstractExpression parent, java.lang.String identifier)
Creates a newUnionClause.- Parameters:
parent- The parent of this expressionidentifier- EitherUNION,INTERSECTorEXCEPT
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
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
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getActualAll
public java.lang.String getActualAll()
Returns the actualALLfound in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The
ALLidentifier that was actually parsed
-
getActualIdentifier
public 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.- Returns:
- The identifier that was actually parsed
-
getIdentifier
public java.lang.String getIdentifier()
Returns the union identifier.- Returns:
- Either "UNION", "INTERSECT", "EXCEPT"
-
getQuery
public Expression getQuery()
Returns theExpressionrepresenting the unioned query.- Returns:
- The
Expressionrepresenting the subquery
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
hasAll
public boolean hasAll()
Determines whetherALLwas parsed.- Returns:
trueifALLwas parsed;falseotherwise
-
hasQuery
public boolean hasQuery()
Determines whether the query was parsed.- Returns:
truethe query was parsed;falseotherwise
-
hasSpaceAfterAll
public boolean hasSpaceAfterAll()
Determines whether a whitespace was parsed afterALL.- Returns:
trueif a whitespace was parsed afterALL;falseotherwise
-
hasSpaceAfterIdentifier
public boolean hasSpaceAfterIdentifier()
Determines whether a whitespace was parsed after the identifier.- Returns:
trueif a whitespace was parsed after the identifier;falseotherwise
-
isExcept
public boolean isExcept()
Determines whether thisUnionClauseuses theEXCEPTidentifier.- Returns:
trueif the identifier isEXCEPT;falseotherwise
-
isIntersect
public boolean isIntersect()
Determines whether thisUnionClauseuses theINTERSECTidentifier.- Returns:
trueif the identifier isINTERSECT;falseotherwise
-
isParsingComplete
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. The text is never empty.- Overrides:
isParsingCompletein classAbstractExpression- Parameters:
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- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
isUnion
public boolean isUnion()
Determines whether thisUnionClauseuses theUNIONidentifier.- Returns:
trueif the identifier isUNION;falseotherwise
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein 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
-
parseIdentifier
protected java.lang.String parseIdentifier()
Parses the JPQL identifier identifier the type of union.
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin 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
-
-