Class CaseExpression
java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.CaseExpression
- All Implemented Interfaces:
Expression
BNF:
or
general_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression END
BNF:
simple_case_expression ::= CASE case_operand simple_when_clause {simple_when_clause}* ELSE scalar_expression END
- Since:
- 2.3
- 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 CASE identifier found in the string representation of the JPQL query, which has the actual case that was used.Returns the actual ELSE identifier found in the string representation of the JPQL query, which has the actual case that was used.Returns the actual END identifier found in the string representation of the JPQL query, which has the actual case that was used.Returns theExpression
that represents the CASE operand.Returns theExpression
that represents the ELSE operand.Returns the BNF of thisExpression
.Returns theExpression
that represents the WHEN clauses.boolean
Determines whether the CASE operand was parsed.boolean
hasElse()
Determines whether the identifier ELSE was parsed.boolean
Determines whether the ELSE expression was parsed.boolean
hasEnd()
Determines whether the identifier END was parsed.boolean
Determines whether a whitespace was parsed after CASE.boolean
Determines whether a whitespace was parsed after the case operand.boolean
Determines whether a whitespace was parsed after ELSE.boolean
Determines whether a whitespace was parsed after the else expression.boolean
Determines whether a whitespace was parsed after the WHEN clause.boolean
Determines whether the WHEN clauses were parsed.protected boolean
isParsingComplete
(WordParser wordParser, String word, Expression expression) Determines whether the parsing is complete based on what is left in the given text.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, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
Constructor Details
-
CaseExpression
Creates a newCaseExpression
.- 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
-
getActualCaseIdentifier
Returns the actual CASE identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The CASE identifier that was actually parsed
-
getActualElseIdentifier
Returns the actual ELSE identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The ELSE identifier that was actually parsed, or an empty string if it was not parsed
-
getActualEndIdentifier
Returns the actual END identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The END identifier that was actually parsed, or an empty string if it was not parsed
-
getCaseOperand
Returns theExpression
that represents the CASE operand.- Returns:
- The expression that was parsed representing the CASE operand
-
getElseExpression
Returns theExpression
that represents the ELSE operand.- Returns:
- The expression that was parsed representing the ELSE operand
-
getQueryBNF
Description copied from interface:Expression
Returns the BNF of thisExpression
.- Returns:
- The
JPQLQueryBNF
, which represents the grammar of thisExpression
-
getWhenClauses
Returns theExpression
that represents the WHEN clauses.- Returns:
- The expression that was parsed representing the WHEN clauses
-
hasCaseOperand
public boolean hasCaseOperand()Determines whether the CASE operand was parsed.- Returns:
true
if the CASE operand was parsed;false
otherwise
-
hasElse
public boolean hasElse()Determines whether the identifier ELSE was parsed.- Returns:
true
if the identifier ELSE was parsed;false
otherwise
-
hasElseExpression
public boolean hasElseExpression()Determines whether the ELSE expression was parsed.- Returns:
true
if the ELSE expression was parsed;false
otherwise
-
hasEnd
public boolean hasEnd()Determines whether the identifier END was parsed.- Returns:
true
if the identifier END was parsed;false
otherwise
-
hasSpaceAfterCase
public boolean hasSpaceAfterCase()Determines whether a whitespace was parsed after CASE.- Returns:
true
if there was a whitespace after CASE;false
otherwise
-
hasSpaceAfterCaseOperand
public boolean hasSpaceAfterCaseOperand()Determines whether a whitespace was parsed after the case operand.- Returns:
true
if there was a whitespace after the case operand;false
otherwise
-
hasSpaceAfterElse
public boolean hasSpaceAfterElse()Determines whether a whitespace was parsed after ELSE.- Returns:
true
if there was a whitespace after ELSE;false
otherwise
-
hasSpaceAfterElseExpression
public boolean hasSpaceAfterElseExpression()Determines whether a whitespace was parsed after the else expression.- Returns:
true
if there was a whitespace after the else expression;false
otherwise
-
hasSpaceAfterWhenClauses
public boolean hasSpaceAfterWhenClauses()Determines whether a whitespace was parsed after the WHEN clause.- Returns:
true
if there was a whitespace after the WHEN clause;false
otherwise
-
hasWhenClauses
public boolean hasWhenClauses()Determines whether the WHEN clauses were parsed.- Returns:
true
if the WHEN clauses were parsed;false
otherwise
-
isParsingComplete
Description copied from class:AbstractExpression
Determines whether the parsing is complete based on what is left in the given text. The text is never empty.- Overrides:
isParsingComplete
in 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
- TheExpression
that has already been parsed- Returns:
true
if the text no longer can't be parsed by the current expression;false
if more can be parsed
-
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
-