org.eclipse.persistence.jpa.jpql.parser

Class CompoundExpression

java.lang.Object

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

org.eclipse.persistence.jpa.jpql.parser.CompoundExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

ArithmeticExpression, ComparisonExpression, LogicalExpression

public abstract class CompoundExpression
extends AbstractExpression

A compound expression has a left and right expressions combined by an identifier.

BNF: expression ::= left_expression identifier right_expression

Since:

2.3

Version:

2.4.2

Author:

Pascal Filion

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, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CAST, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, COLUMN, CONCAT, 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, 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, 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_FIRST, NULLS_LAST, OBJECT, OF, ON, OPERATOR, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, REGEXP, SELECT, SET, SIZE, SOME, SQL, SQRT, SUBSTRING, SUM, TABLE, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNION, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE

Method Summary

Modifier and Type	Method and Description
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
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	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 JPQL identifier of this expression.
Expression	getLeftExpression() Returns the Expression that represents the first expression, which is before the identifier.
Expression	getRightExpression() Returns the Expression that represents the second expression, which is after the identifier.
boolean	hasLeftExpression() Determines whether the first expression of the query was parsed.
boolean	hasRightExpression() Determines whether the second expression of the query was parsed.
boolean	hasSpaceAfterIdentifier() Determines whether a whitespace was parsed after the identifier.
abstract java.lang.String	leftExpressionBNF() Returns the unique identifier of the JPQLQueryBNF for the right expression.
abstract java.lang.String	rightExpressionBNF() Returns the unique identifier of the JPQLQueryBNF used to determine how to parse the right expression.

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

children, getGrammar, getIdentifierVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, isAncestor, orderedChildren, populatePosition, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.persistence.jpa.jpql.parser.Expression

accept, getQueryBNF

Method Detail

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() is called.

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

Parameters:

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

findQueryBNF

public JPQLQueryBNF findQueryBNF(Expression expression)

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Specified by:

findQueryBNF in interface Expression

Overrides:

findQueryBNF in class AbstractExpression

Parameters:

expression - The Expression that is a descendant of this one

Returns:

The JPQLQueryBNF that was used to parse the given expression

getActualIdentifier

public final 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 JPQL identifier that was actually parsed

getIdentifier

public java.lang.String getIdentifier()

Returns the JPQL identifier of this expression.

Returns:

The JPQL identifier

getLeftExpression

public final Expression getLeftExpression()

Returns the Expression that represents the first expression, which is before the identifier.

Returns:

The expression that was parsed representing the first expression

getRightExpression

public final Expression getRightExpression()

Returns the Expression that represents the second expression, which is after the identifier.

Returns:

The expression that was parsed representing the second expression

hasLeftExpression

public final boolean hasLeftExpression()

Determines whether the first expression of the query was parsed.

Returns:

true if the first expression was parsed; false if it was not parsed

hasRightExpression

public final boolean hasRightExpression()

Determines whether the second expression of the query was parsed.

Returns:

true if the second expression was parsed; false if it was not parsed

hasSpaceAfterIdentifier

public final boolean hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier.

Returns:

true if there was a whitespace after the identifier; false otherwise

leftExpressionBNF

public abstract java.lang.String leftExpressionBNF()

Returns the unique identifier of the JPQLQueryBNF for the right expression.

Returns:

The ID of the BNF used when parsing the expression after the identifier

rightExpressionBNF

public abstract java.lang.String rightExpressionBNF()

Returns the unique identifier of the JPQLQueryBNF used to determine how to parse the right expression.

Returns:

The ID of the BNF used when parsing the expression after the identifier