Class AbstractConditionalClause

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractConditionalClause
All Implemented Interfaces:
Expression
Direct Known Subclasses:
HavingClause, OnClause, StartWithClause, WhereClause

public abstract class AbstractConditionalClause extends AbstractExpression
Conditional expressions are composed of other conditional expressions, comparison operations, logical operations, path expressions that evaluate to boolean values, boolean literals, and boolean input parameters. Arithmetic expressions can be used in comparison expressions. Arithmetic expressions are composed of other arithmetic expressions, arithmetic operations, path expressions that evaluate to numeric values, numeric literals, and numeric input parameters. Arithmetic operations use numeric promotion. Standard bracketing () for ordering expression evaluation is supported.
BNF: expression ::= identifier conditional_expression

Version:
2.5
See Also:
Author:
Pascal Filion
  • Constructor Details

    • AbstractConditionalClause

      protected AbstractConditionalClause(AbstractExpression parent, String identifier)
      Creates a new AbstractConditionalClause.
      Parameters:
      parent - The parent of this expression
      identifier - The identifier of this conditional clause
  • Method Details

    • 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 final 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 final 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
    • buildCollectionExpression

      public CollectionExpression buildCollectionExpression()
      Creates a new CollectionExpression that will wrap the single select item.
      Returns:
      The single select item represented by a temporary collection
    • 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
    • getActualIdentifier

      public final String getActualIdentifier()
      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
    • getConditionalExpression

      public final Expression getConditionalExpression()
      Returns the expression representing the composition of the conditional expressions.
      Returns:
      The actual conditional expression
    • getIdentifier

      public final String getIdentifier()
      Returns the JPQL identifier of this expression.
      Returns:
      The JPQL identifier
    • hasConditionalExpression

      public final boolean hasConditionalExpression()
      Determines whether the conditional expression was parsed.
      Returns:
      true if there is a conditional expression; false otherwise
    • hasSpaceAfterIdentifier

      public final boolean hasSpaceAfterIdentifier()
      Determines whether a whitespace was parsed after the identifier or not.
      Returns:
      true if there was a whitespace after the identifier; 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 final 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
    • shouldSkipLiteral

      protected boolean shouldSkipLiteral(AbstractExpression expression)
      Description copied from class: AbstractExpression
      When parsing an invalid or incomplete query, it is possible two literals would be parsed but in some cases, a CollectionExpression should not be created and the parsing should actually stop here. Example: BETWEEN 10 20, when parsing 20, it should not be parsed as part of the lower bound expression.
      Overrides:
      shouldSkipLiteral in class AbstractExpression
      Parameters:
      expression - The Expression that has just been parsed or null
      Returns:
      true
    • toParsedText

      protected final 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