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

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

All Implemented Interfaces:

Expression

public final class BetweenExpression

extends AbstractExpression

Used in conditional expression to determine whether the result of an expression falls within an inclusive range of values. Numeric, string and date expression can be evaluated in this way.

BNF: between_expression ::= arithmetic_expression [NOT] BETWEEN arithmetic_expression AND arithmetic_expression |
string_expression [NOT] BETWEEN string_expression AND string_expression |
datetime_expression [NOT] BETWEEN datetime_expression AND datetime_expression

Since:

2.3

Version:

2.3

Author:

Pascal Filion

Field Summary

private AbstractExpression	expression The Expression to be tested for an inclusive range of values.
private boolean	hasAnd Determines whether the identifier AND was parsed.
private boolean	hasNot Determines whether the identifier NOT was parsed.
private boolean	hasSpaceAfterAnd Determines whether a whitespace was found after AND.
private boolean	hasSpaceAfterBetween Determines whether a whitespace was found after BETWEEN.
private boolean	hasSpaceAfterLowerBound Determines whether a whitespace was found after the lower bound expression.
private AbstractExpression	lowerBoundExpression The Expression representing the lower bound expression.
private AbstractExpression	upperBoundExpression The Expression representing the upper bound 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

BetweenExpression(AbstractExpression parent, AbstractExpression expression)
Creates a new BetweenExpression.

Method Summary

void	accept(ExpressionVisitor visitor) Visits this Expression by the given visitor.
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	getExpression() Returns the Expression representing the expression to be tested for a range of values.
java.lang.String	getIdentifier() Returns the identifier for this expression that may include NOT if it was parsed.
Expression	getLowerBoundExpression() Returns the Expression representing the lower bound expression.
JPQLQueryBNF	getQueryBNF() Returns the BNF of this Expression.
Expression	getUpperBoundExpression() Returns the Expression representing the upper bound expression.
boolean	hasAnd() Determines whether the identifier AND was part of the query.
boolean	hasExpression() Determines whether the expression before the identifier was parsed.
boolean	hasLowerBoundExpression() Determines whether the lower bound expression was parsed.
boolean	hasNot() Determines whether the identifier NOT was part of the query.
boolean	hasSpaceAfterAnd() Determines whether a whitespace was found after AND.
boolean	hasSpaceAfterBetween() Determines whether a whitespace was found after BETWEEN.
boolean	hasSpaceAfterLowerBound() Determines whether a whitespace was found after the lower bound expression.
boolean	hasUpperBoundExpression() Determines whether the upper bound expression was parsed.
(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) void	parse(WordParser wordParser, boolean tolerant) Parses the query by starting at the current position, which is part of the given WordParser.
(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, getRoot, getText, handleAggregate, identifierRole, identifiers, identifiers, identifierVersion, isAncestor, isIdentifier, isNull, 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

Field Detail

expression

private AbstractExpression expression

The Expression to be tested for an inclusive range of values.

hasAnd

private boolean hasAnd

Determines whether the identifier AND was parsed.

hasNot

private boolean hasNot

Determines whether the identifier NOT was parsed.

hasSpaceAfterAnd

private boolean hasSpaceAfterAnd

Determines whether a whitespace was found after AND.

hasSpaceAfterBetween

private boolean hasSpaceAfterBetween

Determines whether a whitespace was found after BETWEEN.

hasSpaceAfterLowerBound

private boolean hasSpaceAfterLowerBound

Determines whether a whitespace was found after the lower bound expression.

lowerBoundExpression

private AbstractExpression lowerBoundExpression

The Expression representing the lower bound expression.

upperBoundExpression

private AbstractExpression upperBoundExpression

The Expression representing the upper bound expression.

Constructor Detail

BetweenExpression

BetweenExpression(AbstractExpression parent,
                  AbstractExpression expression)

Creates a new BetweenExpression.

Parameters:

parent - The parent of this expression

expression - The Expression that is tested to be inclusive in a range of values

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.

addChildrenTo

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

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

getExpression

public Expression getExpression()

Returns the Expression representing the expression to be tested for a range of values.

Returns:

The expression that was parsed representing the expression to be tested

getIdentifier

public java.lang.String getIdentifier()

Returns the identifier for this expression that may include NOT if it was parsed.

Returns:

Either BETWEEN or NOT BETWEEN

getLowerBoundExpression

public Expression getLowerBoundExpression()

Returns the Expression representing the lower bound expression.

Returns:

The expression that was parsed representing the lower bound expression

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

getUpperBoundExpression

public Expression getUpperBoundExpression()

Returns the Expression representing the upper bound expression.

Returns:

The expression that was parsed representing the upper bound expression

hasAnd

public boolean hasAnd()

Determines whether the identifier AND was part of the query.

Returns:

true if the identifier AND was parsed; false otherwise

hasExpression

public boolean hasExpression()

Determines whether the expression before the identifier was parsed.

Returns:

true if the query has the expression before BETWEEN; false otherwise

hasLowerBoundExpression

public boolean hasLowerBoundExpression()

Determines whether the lower bound expression was parsed.

Returns:

true if the query has the lower bound expression; false otherwise

hasNot

public boolean hasNot()

Determines whether the identifier NOT was part of the query.

Returns:

true if the identifier NOT was parsed; false otherwise

hasSpaceAfterAnd

public boolean hasSpaceAfterAnd()

Determines whether a whitespace was found after AND.

Returns:

true if there was a whitespace after AND; false otherwise

hasSpaceAfterBetween

public boolean hasSpaceAfterBetween()

Determines whether a whitespace was found after BETWEEN.

Returns:

true if there was a whitespace after BETWEEN; false otherwise

hasSpaceAfterLowerBound

public boolean hasSpaceAfterLowerBound()

Determines whether a whitespace was found after the lower bound expression.

Returns:

true if there was a whitespace after the lower bound expression; false otherwise

hasUpperBoundExpression

public boolean hasUpperBoundExpression()

Determines whether the upper bound expression was parsed.

Returns:

true if the query has the upper bound expression; 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

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

toParsedText

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