Class CaseExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.jpql.parser.CaseExpression
-
- All Implemented Interfaces:
Expression
public final class CaseExpression extends AbstractExpression
BNF:orgeneral_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression ENDBNF:simple_case_expression ::= CASE case_operand simple_when_clause {simple_when_clause}* ELSE scalar_expression END- Version:
- 2.5
- Author:
- Pascal Filion
- Since:
- 2.3
-
-
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 CaseExpression(AbstractExpression parent)Creates a newCaseExpression.
-
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.StringgetActualCaseIdentifier()Returns the actual CASE identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualElseIdentifier()Returns the actual ELSE identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualEndIdentifier()Returns the actual END identifier found in the string representation of the JPQL query, which has the actual case that was used.ExpressiongetCaseOperand()Returns theExpressionthat represents the CASE operand.AbstractExpressiongetElseExpression()Returns theExpressionthat represents the ELSE operand.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.AbstractExpressiongetWhenClauses()Returns theExpressionthat represents the WHEN clauses.booleanhasCaseOperand()Determines whether the CASE operand was parsed.booleanhasElse()Determines whether the identifier ELSE was parsed.booleanhasElseExpression()Determines whether the ELSE expression was parsed.booleanhasEnd()Determines whether the identifier END was parsed.booleanhasSpaceAfterCase()Determines whether a whitespace was parsed after CASE.booleanhasSpaceAfterCaseOperand()Determines whether a whitespace was parsed after the case operand.booleanhasSpaceAfterElse()Determines whether a whitespace was parsed after ELSE.booleanhasSpaceAfterElseExpression()Determines whether a whitespace was parsed after the else expression.booleanhasSpaceAfterWhenClauses()Determines whether a whitespace was parsed after the WHEN clause.booleanhasWhenClauses()Determines whether the WHEN clauses were parsed.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.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.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
-
CaseExpression
public CaseExpression(AbstractExpression parent)
Creates a newCaseExpression.- Parameters:
parent- The parent of this expression
-
-
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
-
getActualCaseIdentifier
public java.lang.String 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
public java.lang.String 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
public java.lang.String 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
public Expression getCaseOperand()
Returns theExpressionthat represents the CASE operand.- Returns:
- The expression that was parsed representing the CASE operand
-
getElseExpression
public AbstractExpression getElseExpression()
Returns theExpressionthat represents the ELSE operand.- Returns:
- The expression that was parsed representing the ELSE operand
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
getWhenClauses
public AbstractExpression getWhenClauses()
Returns theExpressionthat 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:
trueif the CASE operand was parsed;falseotherwise
-
hasElse
public boolean hasElse()
Determines whether the identifier ELSE was parsed.- Returns:
trueif the identifier ELSE was parsed;falseotherwise
-
hasElseExpression
public boolean hasElseExpression()
Determines whether the ELSE expression was parsed.- Returns:
trueif the ELSE expression was parsed;falseotherwise
-
hasEnd
public boolean hasEnd()
Determines whether the identifier END was parsed.- Returns:
trueif the identifier END was parsed;falseotherwise
-
hasSpaceAfterCase
public boolean hasSpaceAfterCase()
Determines whether a whitespace was parsed after CASE.- Returns:
trueif there was a whitespace after CASE;falseotherwise
-
hasSpaceAfterCaseOperand
public boolean hasSpaceAfterCaseOperand()
Determines whether a whitespace was parsed after the case operand.- Returns:
trueif there was a whitespace after the case operand;falseotherwise
-
hasSpaceAfterElse
public boolean hasSpaceAfterElse()
Determines whether a whitespace was parsed after ELSE.- Returns:
trueif there was a whitespace after ELSE;falseotherwise
-
hasSpaceAfterElseExpression
public boolean hasSpaceAfterElseExpression()
Determines whether a whitespace was parsed after the else expression.- Returns:
trueif there was a whitespace after the else expression;falseotherwise
-
hasSpaceAfterWhenClauses
public boolean hasSpaceAfterWhenClauses()
Determines whether a whitespace was parsed after the WHEN clause.- Returns:
trueif there was a whitespace after the WHEN clause;falseotherwise
-
hasWhenClauses
public boolean hasWhenClauses()
Determines whether the WHEN clauses were parsed.- Returns:
trueif the WHEN clauses were parsed;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
-
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
-
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
-
-