EclipseLink 2.5.0, build 'v20120919-fd7dc27' API Reference

org.eclipse.persistence.jpa.jpql.parser
Class AbstractRangeExpression

java.lang.Object
  extended by org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
      extended by org.eclipse.persistence.jpa.jpql.parser.AbstractRangeExpression
All Implemented Interfaces:
Expression
Direct Known Subclasses:
BetweenExpression

public abstract class AbstractRangeExpression
extends AbstractExpression

This AbstractRangeExpression parses an expression that represents a range.

BNF: range_expression ::= BETWEEN expression AND expression

Version:
2.5
Author:
Pascal Filion
Since:
2.5

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
protected AbstractRangeExpression(AbstractExpression parent, java.lang.String identifier)
          Creates a new AbstractRangeExpression.
 
Method Summary
 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 abstract  java.lang.String boundExpressionQueryBNFId()
          Returns the unique identifier of the BNF
 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.
 java.lang.String getActualBetweenIdentifier()
          Returns the actual found in the string representation of the JPQL query, which has the actual case that was used.
 Expression getLowerBoundExpression()
          Returns the Expression representing the lower bound expression.
 Expression getUpperBoundExpression()
          Returns the Expression representing the upper bound expression.
 boolean hasAnd()
          Determines whether the identifier AND was part of the query.
protected  boolean hasBetween()
          Determines whether the identifier BETWEEN was part of the query.
 boolean hasLowerBoundExpression()
          Determines whether the lower bound expression was parsed.
 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.
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.
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 parseRange(WordParser wordParser, boolean tolerant)
          Parses the portion of the JPQL query that represents the range .
protected  void toParsedRangeText(java.lang.StringBuilder writer, boolean actual)
          Generates a string representation of this the portion that represents the range.
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.AbstractExpression
acceptUnknownVisitor, acceptUnknownVisitor, buildExpressionFromFallingBack, buildNullExpression, buildStringExpression, buildStringExpression, buildUnknownExpression, calculatePosition, children, findFallBackExpressionFactory, findQueryBNF, getExpressionFactory, getExpressionRegistry, getGrammar, getIdentifierVersion, getJPAVersion, getLength, getOffset, getParent, getQueryBNF, getRoot, getText, handleAggregate, isAncestor, isIdentifier, isNull, isTolerant, isUnknown, isVirtual, orderedChildren, parse, parse, parseSingleExpression, populatePosition, 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.jpql.parser.Expression
accept, getQueryBNF
 

Constructor Detail

AbstractRangeExpression

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

Parameters:
parent - The parent of this expression
identifier - The JPQL identifier for 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() is called.

This does not traverse the Expression sub-hierarchy, use a subclass of AbstractTraverseChildrenVisitor in order to traverse the entire sub-hierarchy.

Parameters:
visitor - The visitor to visit the children of this object.

addChildrenTo

protected void addChildrenTo(java.util.Collection<Expression> children)
Adds the children of this AbstractExpression to the given collection.

Overrides:
addChildrenTo in class AbstractExpression
Parameters:
children - The collection used to store the children

addOrderedChildrenTo

protected void addOrderedChildrenTo(java.util.List<Expression> children)
Adds the children of this AbstractExpression to the given list.

Overrides:
addOrderedChildrenTo in class AbstractExpression
Parameters:
children - The list used to store the string representation of this AbstractExpression

boundExpressionQueryBNFId

protected abstract java.lang.String boundExpressionQueryBNFId()
Returns the unique identifier of the BNF


getActualAndIdentifier

public final 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 final java.lang.String getActualBetweenIdentifier()
Returns the actual found in the string representation of the JPQL query, which has the actual case that was used.

Returns:
The identifier that was actually parsed

getLowerBoundExpression

public final Expression getLowerBoundExpression()
Returns the Expression representing the lower bound expression.

Returns:
The expression that was parsed representing the lower bound 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 final boolean hasAnd()
Determines whether the identifier AND was part of the query.

Returns:
true if the identifier AND was parsed; false otherwise

hasBetween

protected boolean hasBetween()
Determines whether the identifier BETWEEN was part of the query.

Returns:
true if the identifier BETWEEN was parsed; false otherwise

hasLowerBoundExpression

public final boolean hasLowerBoundExpression()
Determines whether the lower bound expression was parsed.

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

hasSpaceAfterAnd

public final boolean hasSpaceAfterAnd()
Determines whether a whitespace was found after AND.

Returns:
true if there was a whitespace after AND; false otherwise

hasSpaceAfterBetween

public final boolean hasSpaceAfterBetween()
Determines whether a whitespace was found after BETWEEN.

Returns:
true if there was a whitespace after the BETWEEN; false otherwise

hasSpaceAfterLowerBound

public final 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 final boolean hasUpperBoundExpression()
Determines whether the upper bound expression was parsed.

Returns:
true if the query has the upper bound expression; false otherwise

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:
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

protected 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

parseRange

protected void parseRange(WordParser wordParser,
                          boolean tolerant)
Parses the portion of the JPQL query that represents the range .

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

toParsedRangeText

protected void toParsedRangeText(java.lang.StringBuilder writer,
                                 boolean actual)
Generates a string representation of this the portion that represents the range.

Parameters:
writer - The buffer used to append this Expression's string representation
actual - 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

toParsedText

protected void toParsedText(java.lang.StringBuilder writer,
                            boolean actual)
Generates a string representation of this Expression, including its children, if it has any.

Specified by:
toParsedText in class AbstractExpression
Parameters:
writer - The buffer used to append this Expression's string representation
actual - 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