|
EclipseLink 2.5.0, build 'v20120919-fd7dc27' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractRangeExpression
org.eclipse.persistence.jpa.jpql.parser.BetweenExpression
public final class BetweenExpression
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.
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
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 |
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 . |
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. |
protected java.lang.String |
boundExpressionQueryBNFId()
Returns the unique identifier of the BNF |
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. |
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. |
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this Expression . |
boolean |
hasExpression()
Determines whether the expression before the identifier was parsed. |
boolean |
hasNot()
Determines whether the identifier NOT was part of the query. |
protected void |
parse(WordParser wordParser,
boolean tolerant)
Parses the query by starting at the current position, which is part of the given WordParser . |
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.AbstractRangeExpression |
---|
getActualAndIdentifier, getActualBetweenIdentifier, getLowerBoundExpression, getUpperBoundExpression, hasAnd, hasBetween, hasLowerBoundExpression, hasSpaceAfterAnd, hasSpaceAfterBetween, hasSpaceAfterLowerBound, hasUpperBoundExpression, isParsingComplete, parseRange, toParsedRangeText |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BetweenExpression(AbstractExpression parent, AbstractExpression expression)
BetweenExpression
.
parent
- The parent of this expressionexpression
- The Expression
that is tested to be inclusive in a range of valuesMethod Detail |
---|
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.
visitor
- The ExpressionVisitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
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.
acceptChildren
in interface Expression
acceptChildren
in class AbstractRangeExpression
visitor
- The visitor
to visit the children of this object.protected void addChildrenTo(java.util.Collection<Expression> children)
AbstractExpression
to the given collection.
addChildrenTo
in class AbstractRangeExpression
children
- The collection used to store the childrenprotected void addOrderedChildrenTo(java.util.List<Expression> children)
AbstractExpression
to the given list.
addOrderedChildrenTo
in class AbstractRangeExpression
children
- The list used to store the string representation of this AbstractExpression
protected java.lang.String boundExpressionQueryBNFId()
boundExpressionQueryBNFId
in class AbstractRangeExpression
public java.lang.String getActualNotIdentifier()
public Expression getExpression()
Expression
representing the expression to be tested for a range of values.
public java.lang.String getIdentifier()
public JPQLQueryBNF getQueryBNF()
Expression
.
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasExpression()
true
if the query has the expression before BETWEEN;
false
otherwisepublic boolean hasNot()
true
if the identifier NOT was parsed; false
otherwiseprotected void parse(WordParser wordParser, boolean tolerant)
WordParser
.
parse
in class AbstractRangeExpression
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 queriesprotected void toParsedText(java.lang.StringBuilder writer, boolean actual)
Expression
, including its children,
if it has any.
toParsedText
in class AbstractRangeExpression
writer
- The buffer used to append this Expression
'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
|
EclipseLink 2.5.0, build 'v20120919-fd7dc27' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |