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

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

Modifier	Constructor and Description
protected	CompoundExpression(AbstractExpression parent, java.lang.String identifier) Creates a new CompoundExpression.

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
protected void	addChildrenTo(java.util.Collection<Expression> children) Adds the children of this AbstractExpression to the given collection.
protected void	addOrderedChildrenTo(java.util.List<Expression> children) Adds the children of this AbstractExpression to the given list.
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.
abstract java.lang.String	getLeftExpressionQueryBNFId() Returns the unique identifier of the JPQLQueryBNF for the left expression.
Expression	getRightExpression() Returns the Expression that represents the second expression, which is after the identifier.
abstract java.lang.String	getRightExpressionQueryBNFId() Returns the unique identifier of the JPQLQueryBNF for the right expression.
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.
protected void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
protected abstract java.lang.String	parseIdentifier(WordParser wordParser) Parses the identifier of this expression.
protected void	setLeftExpression(AbstractExpression leftExpression) Sets the given Expression to be the first expression of this compound one.
protected void	setRightExpression(AbstractExpression rightExpression) Sets the given Expression to be the second expression of this compound one.
protected void	toParsedText(java.lang.StringBuilder writer, boolean actual) Generates a string representation of this Expression, 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, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

accept, getQueryBNF

Constructor Detail

CompoundExpression

protected CompoundExpression(AbstractExpression parent,
                  java.lang.String identifier)

Creates a new CompoundExpression.

Parameters:

parent - The parent of this expression

identifier - The identifier of this expression

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.

addChildrenTo

protected final void addChildrenTo(java.util.Collection<Expression> children)

Adds the children of this AbstractExpression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

protected final void addOrderedChildrenTo(java.util.List<Expression> children)

Adds the children of this AbstractExpression to the given list.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

children - The list used to store the string representation of this AbstractExpression

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

getLeftExpressionQueryBNFId

public abstract java.lang.String getLeftExpressionQueryBNFId()

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

Returns:

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

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

getRightExpressionQueryBNFId

public abstract java.lang.String getRightExpressionQueryBNFId()

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

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

parse

protected final void parse(WordParser wordParser,
         boolean tolerant)

Parses the query by starting at the current position, which is part of the given WordParser.

Specified by:

parse in class AbstractExpression

Parameters:

wordParser - The text to parse based on the current position of the cursor

tolerant - Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

parseIdentifier

protected abstract java.lang.String parseIdentifier(WordParser wordParser)

Parses the identifier of this expression.

Parameters:

text - The text to parse, which starts with the identifier

Returns:

The identifier for this expression

setLeftExpression

protected final void setLeftExpression(AbstractExpression leftExpression)

Sets the given Expression to be the first expression of this compound one.

Parameters:

leftExpression - The expression that was parsed before the identifier

setRightExpression

protected final void setRightExpression(AbstractExpression rightExpression)

Sets the given Expression to be the second expression of this compound one.

Parameters:

rightExpression - The expression that was parsed after the identifier

toParsedText

protected final void toParsedText(java.lang.StringBuilder writer,
                boolean actual)

Generates a string representation of this Expression, including its children, if it has any.

Specified by:

toParsedText in class AbstractExpression

Parameters:

writer - The buffer used to append this Expression's string representation

actual - 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