Module org.eclipse.persistence.jpa.jpql
Package org.eclipse.persistence.jpa.jpql.parser

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
Since:
2.3
Version:
2.5

  • Constructor Details

    • BetweenExpression

      public 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 Details

    • accept

      public void accept(ExpressionVisitor visitor)
      Description copied from interface: Expression
      Visits this Expression by the given visitor.
      Parameters:
      visitor - The ExpressionVisitor to visit this object

    • acceptChildren

      public void acceptChildren(ExpressionVisitor visitor)
      Description copied from interface: Expression
      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(Collection<Expression> children)
      Description copied from class: AbstractExpression
      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(List<Expression> children)
      Description copied from class: AbstractExpression
      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

    • findQueryBNF

      public JPQLQueryBNF findQueryBNF(Expression expression)
      Description copied from interface: Expression
      Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
      Specified by:
      findQueryBNF in interface Expression
      Overrides:
      findQueryBNF in class AbstractExpression
      Parameters:
      expression - The Expression that is a descendant of this one
      Returns:
      The JPQLQueryBNF that was used to parse the given expression

    • getActualAndIdentifier

      public 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 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 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 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 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 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()
      Description copied from interface: Expression
      Returns the BNF of this Expression.
      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

    • hasBetween

      protected boolean hasBetween()
      Determines whether the identifier BETWEEN was part of the query.
      Returns:
      true if the identifier BETWEEN 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 the 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

      protected boolean isParsingComplete(WordParser wordParser, String word, Expression expression)
      Description copied from class: AbstractExpression
      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)
      Description copied from class: AbstractExpression
      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

      protected void toParsedText(StringBuilder writer, boolean actual)
      Description copied from class: AbstractExpression
      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