Class BetweenExpression
- java.lang.Object
-
- org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
-
- org.eclipse.persistence.jpa.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- 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 Constructor Description BetweenExpression(AbstractExpression parent, AbstractExpression expression)Creates a newBetweenExpression.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(ExpressionVisitor visitor)Visits thisExpressionby the givenvisitor.voidacceptChildren(ExpressionVisitor visitor)Visits the children of thisExpression.protected voidaddChildrenTo(java.util.Collection<Expression> children)Adds the children of thisAbstractExpressionto the given collection.protected voidaddOrderedChildrenTo(java.util.List<Expression> children)Adds the children of thisAbstractExpressionto the given list.JPQLQueryBNFfindQueryBNF(Expression expression)Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.java.lang.StringgetActualAndIdentifier()Returns the actual AND identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualBetweenIdentifier()Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetActualNotIdentifier()Returns the actual NOT identifier found in the string representation of the JPQL query, which has the actual case that was used.java.lang.StringgetBoundExpressionQueryBNFId()Returns the unique identifier of the BNF for the lower and upper bound expressions.ExpressiongetExpression()Returns theExpressionrepresenting the expression to be tested for a range of values.java.lang.StringgetIdentifier()Returns the identifier for this expression that may include NOT if it was parsed.ExpressiongetLowerBoundExpression()Returns theExpressionrepresenting the lower bound expression.JPQLQueryBNFgetQueryBNF()Returns the BNF of thisExpression.ExpressiongetUpperBoundExpression()Returns theExpressionrepresenting the upper bound expression.booleanhasAnd()Determines whether the identifier AND was part of the query.protected booleanhasBetween()Determines whether the identifier BETWEEN was part of the query.booleanhasExpression()Determines whether the expression before the identifier was parsed.booleanhasLowerBoundExpression()Determines whether the lower bound expression was parsed.booleanhasNot()Determines whether the identifier NOT was part of the query.booleanhasSpaceAfterAnd()Determines whether a whitespace was found after AND.booleanhasSpaceAfterBetween()Determines whether a whitespace was found after BETWEEN.booleanhasSpaceAfterLowerBound()Determines whether a whitespace was found after the lower bound expression.booleanhasUpperBoundExpression()Determines whether the upper bound expression was parsed.protected booleanisParsingComplete(WordParser wordParser, java.lang.String word, Expression expression)Determines whether the parsing is complete based on what is left in the given text.protected voidparse(WordParser wordParser, boolean tolerant)Parses the query by starting at the current position, which is part of the givenWordParser.protected voidtoParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, 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, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parseUsingExpressionFactory, populatePosition, rebuildActualText, rebuildParsedText, setParent, setText, shouldParseWithFactoryFirst, shouldSkipLiteral, toActualText, toParsedText, toString
-
-
-
-
Constructor Detail
-
BetweenExpression
public BetweenExpression(AbstractExpression parent, AbstractExpression expression)
Creates a newBetweenExpression.- Parameters:
parent- The parent of this expressionexpression- TheExpressionthat is tested to be inclusive in a range of values
-
-
Method Detail
-
accept
public void accept(ExpressionVisitor visitor)
Visits thisExpressionby the givenvisitor.- Parameters:
visitor- TheExpressionVisitorto visit this object
-
acceptChildren
public void acceptChildren(ExpressionVisitor visitor)
Visits the children of thisExpression. This method can be used to optimize traversing the children since a new list is not created every timeExpression.children()is called.This does not traverse the
Expressionsub-hierarchy, use a subclass ofAbstractTraverseChildrenVisitorin order to traverse the entire sub-hierarchy.- Parameters:
visitor- Thevisitorto visit the children of this object.
-
addChildrenTo
protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of thisAbstractExpressionto the given collection.- Overrides:
addChildrenToin classAbstractExpression- Parameters:
children- The collection used to store the children
-
addOrderedChildrenTo
protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of thisAbstractExpressionto the given list.- Overrides:
addOrderedChildrenToin classAbstractExpression- Parameters:
children- The list used to store the string representation of thisAbstractExpression
-
findQueryBNF
public JPQLQueryBNF findQueryBNF(Expression expression)
Retrieves theJPQLQueryBNFthat represents the fragment of thisExpressionthat was used when parsing the givenExpression.- Specified by:
findQueryBNFin interfaceExpression- Overrides:
findQueryBNFin classAbstractExpression- Parameters:
expression- TheExpressionthat is a descendant of this one- Returns:
- The
JPQLQueryBNFthat was used to parse the given expression
-
getActualAndIdentifier
public java.lang.String getActualAndIdentifier()
Returns the actual AND identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The AND identifier that was actually parsed, or an empty string if it was not parsed
-
getActualBetweenIdentifier
public java.lang.String getActualBetweenIdentifier()
Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The identifier that was actually parsed
-
getActualNotIdentifier
public java.lang.String getActualNotIdentifier()
Returns the actual NOT identifier found in the string representation of the JPQL query, which has the actual case that was used.- Returns:
- The NOT identifier that was actually parsed, or an empty string if it was not parsed
-
getBoundExpressionQueryBNFId
public java.lang.String getBoundExpressionQueryBNFId()
Returns the unique identifier of the BNF for the lower and upper bound expressions.- Returns:
- The unique identifier of the JPQL query BNF for the lower and upper bound expressions
-
getExpression
public Expression getExpression()
Returns theExpressionrepresenting 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 theExpressionrepresenting the lower bound expression.- Returns:
- The expression that was parsed representing the lower bound expression
-
getQueryBNF
public JPQLQueryBNF getQueryBNF()
Returns the BNF of thisExpression.- Returns:
- The
JPQLQueryBNF, which represents the grammar of thisExpression
-
getUpperBoundExpression
public Expression getUpperBoundExpression()
Returns theExpressionrepresenting 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:
trueif the identifier AND was parsed;falseotherwise
-
hasBetween
protected boolean hasBetween()
Determines whether the identifier BETWEEN was part of the query.- Returns:
trueif the identifier BETWEEN was parsed;falseotherwise
-
hasExpression
public boolean hasExpression()
Determines whether the expression before the identifier was parsed.- Returns:
trueif the query has the expression before BETWEEN;falseotherwise
-
hasLowerBoundExpression
public boolean hasLowerBoundExpression()
Determines whether the lower bound expression was parsed.- Returns:
trueif the query has the lower bound expression;falseotherwise
-
hasNot
public boolean hasNot()
Determines whether the identifier NOT was part of the query.- Returns:
trueif the identifier NOT was parsed;falseotherwise
-
hasSpaceAfterAnd
public boolean hasSpaceAfterAnd()
Determines whether a whitespace was found after AND.- Returns:
trueif there was a whitespace after AND;falseotherwise
-
hasSpaceAfterBetween
public boolean hasSpaceAfterBetween()
Determines whether a whitespace was found after BETWEEN.- Returns:
trueif there was a whitespace after the BETWEEN;falseotherwise
-
hasSpaceAfterLowerBound
public boolean hasSpaceAfterLowerBound()
Determines whether a whitespace was found after the lower bound expression.- Returns:
trueif there was a whitespace after the lower bound expression;falseotherwise
-
hasUpperBoundExpression
public boolean hasUpperBoundExpression()
Determines whether the upper bound expression was parsed.- Returns:
trueif the query has the upper bound expression;falseotherwise
-
isParsingComplete
protected 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:
isParsingCompletein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursorword- The word that was retrieved from the given text, which is the first word in the textexpression- TheExpressionthat has already been parsed- Returns:
trueif the text no longer can't be parsed by the current expression;falseif more can be parsed
-
parse
protected void parse(WordParser wordParser, boolean tolerant)
Parses the query by starting at the current position, which is part of the givenWordParser.- Specified by:
parsein classAbstractExpression- Parameters:
wordParser- The text to parse based on the current position of the cursortolerant- Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
-
toParsedText
protected void toParsedText(java.lang.StringBuilder writer, boolean actual)Generates a string representation of thisExpression, including its children, if it has any.- Specified by:
toParsedTextin classAbstractExpression- Parameters:
writer- The buffer used to append thisExpression's string representationactual- 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
-
-