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

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.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.3

Author:

Pascal Filion

Field Summary

private boolean	hasSpaceAfterIdentifier Determines whether a whitespace is present after the identifier.
private AbstractExpression	leftExpression The left side of the arithmetic expression.
private AbstractExpression	rightExpression The right side of the arithmetic expression.

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

Constructor Summary

CompoundExpression(AbstractExpression parent, java.lang.String identifier)
Creates a new CompoundExpression.

Method Summary

void	acceptChildren(ExpressionVisitor visitor) Visits the children of this Expression.
(package private) void	addChildrenTo(java.util.Collection<Expression> children) Adds the children of this Expression to the given collection.
(package private) void	addOrderedChildrenTo(java.util.List<StringExpression> children) Adds the StringExpressions representing 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.
(package private) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
(package private) abstract java.lang.String	parseIdentifier(WordParser wordParser) Parses the identifier of this expression.
abstract JPQLQueryBNF	rightExpressionBNF() Returns the BNF used to determine how to parse the right expression.
(package private) void	setLeftExpression(AbstractExpression leftExpression) Sets the given Expression to be the first expression of this compound one.
(package private) void	setRightExpression(AbstractExpression rightExpression) Sets the given Expression to be the second expression of this compound one.
(package private) void	toParsedText(java.lang.StringBuilder writer, boolean includeVirtual) Generates a string representation of this Expression.

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

buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, children, expressionFactory, expressionFactoryForIdentifier, findQueryBNF, getChildren, getJPAVersion, getParent, getQueryBNF, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, isParsingComplete, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, 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.internal.jpql.parser.Expression

accept

Field Detail

hasSpaceAfterIdentifier

private boolean hasSpaceAfterIdentifier

Determines whether a whitespace is present after the identifier.

leftExpression

private AbstractExpression leftExpression

The left side of the arithmetic expression.

rightExpression

private AbstractExpression rightExpression

The right side of the arithmetic expression.

Constructor Detail

CompoundExpression

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

addChildrenTo

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

Adds the children of this Expression to the given collection.

Overrides:

addChildrenTo in class AbstractExpression

Parameters:

children - The collection used to store the children

addOrderedChildrenTo

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

Adds the StringExpressions representing this Expression.

Overrides:

addOrderedChildrenTo in class AbstractExpression

Parameters:

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

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

parse

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

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

rightExpressionBNF

public abstract JPQLQueryBNF rightExpressionBNF()

Returns the BNF used to determine how to parse the right expression.

Returns:

The BNF used when parsing the expression after the identifier

setLeftExpression

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

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

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

Generates a string representation of this Expression.

Specified by:

toParsedText in class AbstractExpression

Parameters:

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

includeVirtual - Determines whether to include any characters that are considered virtual, i.e. that was parsed when the query is incomplete and is needed for functionality like content assist