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

Class AbstractOrderByClause

java.lang.Object
org.eclipse.persistence.jpa.jpql.parser.AbstractExpression
org.eclipse.persistence.jpa.jpql.parser.AbstractOrderByClause
All Implemented Interfaces:
Expression
Direct Known Subclasses:
OrderByClause, OrderSiblingsByClause
public abstract class AbstractOrderByClause extends AbstractExpression
An ordering clause allows the objects or values that are returned by the query to be ordered.
BNF: orderby_clause ::= <identifier> orderby_item {, orderby_item}*
Since:
2.5
Version:
2.5

  • Constructor Details

    • AbstractOrderByClause

      protected AbstractOrderByClause(AbstractExpression parent, String identifier)
      Creates a new AbstractOrderByClause.
      Parameters:
      parent - The parent of this expression
      identifier - The JPQL identifier representing an ordering 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 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

    • buildCollectionExpression

      public final CollectionExpression buildCollectionExpression()
      Creates a new CollectionExpression that will wrap the single order by item.
      Returns:
      The single order by item represented by a temporary collection

    • findQueryBNF

      public final 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 actual identifier that was actually parsed

    • getOrderByItems

      public final Expression getOrderByItems()
      Returns the Expression representing the list of items to order.
      Returns:
      The expression representing the list of items to order

    • hasOrderByItems

      public final boolean hasOrderByItems()
      Determines whether the list of items to order was parsed.
      Returns:
      true the list of items to order was parsed; false otherwise

    • hasSpaceAfterIdentifier

      public final boolean hasSpaceAfterIdentifier()
      Determines whether a whitespace was parsed after the identifier.
      Returns:
      true if a whitespace was parsed after the identifier; false otherwise

    • 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