org.eclipse.persistence.jpa.internal.jpql.parser

Class CaseExpression

java.lang.Object

org.eclipse.persistence.jpa.internal.jpql.parser.StringExpression

org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

org.eclipse.persistence.jpa.internal.jpql.parser.CaseExpression

All Implemented Interfaces:

Expression

public final class CaseExpression
extends AbstractExpression

BNF: general_case_expression ::= CASE when_clause {when_clause}* ELSE scalar_expression END or

BNF: simple_case_expression ::= CASE case_operand simple_when_clause {simple_when_clause}* ELSE scalar_expression END

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

Fields inherited from class org.eclipse.persistence.jpa.internal.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.internal.jpql.parser.Expression

ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
Expression	getCaseOperand() Returns the Expression that represents the CASE operand.
AbstractExpression	getElseExpression() Returns the Expression that represents the ELSE operand.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
AbstractExpression	getWhenClauses() Returns the Expression that represents the WHEN clauses.
boolean	hasCaseOperand() Determines whether the CASE operand was parsed.
boolean	hasElse() Determines whether the identifier ELSE was parsed.
boolean	hasElseExpression() Determines whether the ELSE expression was parsed.
boolean	hasEnd() Determines whether the identifier END was parsed.
boolean	hasSpaceAfterCase() Determines whether a whitespace was parsed after CASE.
boolean	hasSpaceAfterCaseOperand() Determines whether a whitespace was parsed after the case operand.
boolean	hasSpaceAfterElse() Determines whether a whitespace was parsed after ELSE.
boolean	hasSpaceAfterElseExpression() Determines whether a whitespace was parsed after the else expression.
boolean	hasSpaceAfterWhenClauses() Determines whether a whitespace was parsed after the WHEN clause.
boolean	hasWhenClauses() Determines whether the WHEN clauses were parsed.

Methods inherited from class org.eclipse.persistence.jpa.internal.jpql.parser.AbstractExpression

children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

accept

public void accept(ExpressionVisitor visitor)

Visits this Expression by the given visitor.

Parameters:

visitor - The visitor to visit this object

acceptChildren

public void acceptChildren(ExpressionVisitor visitor)

Visits the children of this Expression. This method can be used to optimize traversing the children since a new list is not created every time Expression.children() or Expression.getChildren() is called.

This does not traverse the Expression sub-hierarchy, use an subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters:

visitor - The visitor to visit the children of this object.

getCaseOperand

public Expression getCaseOperand()

Returns the Expression that represents the CASE operand.

Returns:

The expression that was parsed representing the CASE operand

getElseExpression

public AbstractExpression getElseExpression()

Returns the Expression that represents the ELSE operand.

Returns:

The expression that was parsed representing the ELSE operand

getQueryBNF

public JPQLQueryBNF getQueryBNF()

Returns the BNF of this Expression.

Specified by:

getQueryBNF in class AbstractExpression

Returns:

The JPQLQueryBNF, which represents the grammar of this Expression

getWhenClauses

public AbstractExpression getWhenClauses()

Returns the Expression 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 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