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

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

All Implemented Interfaces:

Expression

Direct Known Subclasses:

HavingClause, WhereClause

public abstract class AbstractConditionalClause

extends AbstractExpression

Conditional expressions are composed of other conditional expressions, comparison operations, logical operations, path expressions that evaluate to boolean values, boolean literals, and boolean input parameters. Arithmetic expressions can be used in comparison expressions. Arithmetic expressions are composed of other arithmetic expressions, arithmetic operations, path expressions that evaluate to numeric values, numeric literals, and numeric input parameters. Arithmetic operations use numeric promotion. Standard bracketing () for ordering expression evaluation is supported.

BNF: expression ::= identifier conditional_expression

Since:

2.3

Version:

2.3

Author:

Pascal Filion

See Also:

HavingClause, WhereClause

Field Summary

private AbstractExpression	conditionalExpression The expression representing the composition of the conditional expressions.
private boolean	hasSpace Determines whether a whitespace was parsed after the identifier.

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

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

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	getConditionalExpression() Returns the expression representing the composition of the conditional expressions.
java.lang.String	getIdentifier() Returns the JPQL identifier of this expression.
boolean	hasConditionalExpression() Determines whether the conditional expression was parsed.
boolean	hasSpaceAfterIdentifier() Determines whether a whitespace was parsed after the identifier or not.
(package private) 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.
(package private) Expression	parse(java.lang.CharSequence expression, boolean tolerant) Parses the given expression has a WHERE clause.
(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) boolean	shouldSkipLiteral(AbstractExpression expression) When parsing an invalid or incomplete query, it is possible two literals would be parsed but in some cases, a CollectionExpression should not be created and the parsing should actually stop here.
(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, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseSingleExpression, populatePosition, queryBNF, readdLeadingSpaces, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, 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

conditionalExpression

private AbstractExpression conditionalExpression

The expression representing the composition of the conditional expressions.

hasSpace

private boolean hasSpace

Determines whether a whitespace was parsed after the identifier.

Constructor Detail

AbstractConditionalClause

AbstractConditionalClause(AbstractExpression parent,
                          java.lang.String identifier)

Creates a new AbstractConditionalClause.

Parameters:

parent - The parent of this expression

identifier - The identifier of this conditional clause

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

getConditionalExpression

public final Expression getConditionalExpression()

Returns the expression representing the composition of the conditional expressions.

Returns:

The actual conditional expression

getIdentifier

public final java.lang.String getIdentifier()

Returns the JPQL identifier of this expression.

Returns:

The JPQL identifier

hasConditionalExpression

public final boolean hasConditionalExpression()

Determines whether the conditional expression was parsed.

Returns:

true if there is a conditional expression; false otherwise

hasSpaceAfterIdentifier

public final boolean hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier or not.

Returns:

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

isParsingComplete

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:

isParsingComplete in class AbstractExpression

Parameters:

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

word - The word that was retrieved from the given text, which is the first word in the text

expression - The Expression that has already been parsed

Returns:

true if the text no longer can't be parsed by the current expression; false if more can be parsed

parse

final Expression parse(java.lang.CharSequence expression,
                       boolean tolerant)

Parses the given expression has a WHERE clause.

Parameters:

conditionalExpression - The expression representing a condition expression

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

Returns:

The Expression representing the given text

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

shouldSkipLiteral

boolean shouldSkipLiteral(AbstractExpression expression)

When parsing an invalid or incomplete query, it is possible two literals would be parsed but in some cases, a CollectionExpression should not be created and the parsing should actually stop here. Example: BETWEEN 10 20, when parsing 20, it should not be parsed as part of the lower bound expression.

Overrides:

shouldSkipLiteral in class AbstractExpression

Returns:

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