Top Description Fields Constructors Methods
org.eclipse.persistence.jpa.jpql.parser

public abstract Class AbstractOrderByClause

extends AbstractExpression
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.jpa.jpql.parser.OrderByClause, org.eclipse.persistence.jpa.jpql.parser.OrderSiblingsByClause
Imports
java.util.ArrayList, .Collection, .List, org.eclipse.persistence.jpa.jpql.WordParser
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}*
Author
Pascal Filion
Since
2.5
Version
2.5

Field Summary

Modifier and TypeField and Description
private boolean
hasSpaceAfterIdentifier

Determines whether a whitespace was parsed after the JPQL identifier.

private String
identifier

The actual identifier found in the string representation of the JPQL query.

private AbstractExpression
orderByItems

The order by items.

Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
COMMADOTDOUBLE_QUOTELEFT_CURLY_BRACKETLEFT_PARENTHESISNOT_DEFINEDRIGHT_CURLY_BRACKETRIGHT_PARENTHESISSINGLE_QUOTESPACEUNDERSCORE

Constructor Summary

AccessConstructor and Description
protected
AbstractOrderByClause(AbstractExpression
The parent of this expression
parent, String
The JPQL identifier representing an ordering clause
identifier)

Creates a new AbstractOrderByClause.

Method Summary

Modifier and TypeMethod and Description
public void
acceptChildren(ExpressionVisitor
The visitor to visit the children of this object.
visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Visits the children of this Expression.
protected void
addChildrenTo(Collection<Expression>
The collection used to store the children
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.
protected void
addOrderedChildrenTo(List<Expression>
The list used to store the string representation of this AbstractExpression
children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.
public final CollectionExpression

Returns:

The single order by item represented by a temporary collection
buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single order by item.

public final JPQLQueryBNF
findQueryBNF(Expression
The Expression that is a descendant of this one
expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.
public final String

Returns:

The actual identifier that was actually parsed
getActualIdentifier()

Returns the actual identifier found in the string representation of the JPQL query, which has the actual case that was used.

public final Expression

Returns:

The expression representing the list of items to order
getOrderByItems()

Returns the Expression representing the list of items to order.

public final boolean

Returns:

true the list of items to order was parsed; false otherwise
hasOrderByItems()

Determines whether the list of items to order was parsed.

public final boolean

Returns:

true if a whitespace was parsed after the identifier; false otherwise
hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier.

protected void
parse(WordParser
The text to parse based on the current position of the cursor
wordParser, boolean
Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries
tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.
protected void
toParsedText(StringBuilder
The buffer used to append this Expression's string representation
writer, boolean
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
actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.
Inherited from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression:
acceptUnknownVisitoracceptUnknownVisitorbuildExpressionFromFallingBackbuildNullExpressionbuildStringExpressionbuildStringExpressionbuildUnknownExpressioncalculatePositionchildrenfindFallBackExpressionFactorygetExpressionFactorygetExpressionRegistrygetGrammargetIdentifierVersiongetJPAVersiongetLengthgetOffsetgetParentgetQueryBNFgetRootgetTexthandleAggregatehandleCollectionisAncestorisIdentifierisNullisParsingCompleteisTolerantisUnknownisVirtualorderedChildrenparseparseUsingExpressionFactorypopulatePositionrebuildActualTextrebuildParsedTextsetParentsetTextshouldParseWithFactoryFirstshouldSkipLiteraltoActualTexttoParsedTexttoString

Field Detail

hasSpaceAfterIdentifierback to summary
private boolean hasSpaceAfterIdentifier

Determines whether a whitespace was parsed after the JPQL identifier.

identifierback to summary
private String identifier

The actual identifier found in the string representation of the JPQL query.

orderByItemsback to summary
private AbstractExpression orderByItems

The order by items.

Constructor Detail

AbstractOrderByClauseback to summary
protected AbstractOrderByClause(AbstractExpression parent, String identifier)

Creates a new AbstractOrderByClause.

Parameters
parent:AbstractExpression

The parent of this expression

identifier:String

The JPQL identifier representing an ordering clause

Method Detail

acceptChildrenback to summary
public void acceptChildren(ExpressionVisitor visitor)

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.acceptChildren.

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

The visitor to visit the children of this object.

Annotations
@Override
addChildrenToback to summary
protected void addChildrenTo(Collection<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addChildrenTo.

Adds the children of this AbstractExpression to the given collection.

Parameters
children:Collection<Expression>

The collection used to store the children

Annotations
@Override
addOrderedChildrenToback to summary
protected void addOrderedChildrenTo(List<Expression> children)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.addOrderedChildrenTo.

Adds the children of this AbstractExpression to the given list.

Parameters
children:List<Expression>

The list used to store the string representation of this AbstractExpression

Annotations
@Override
buildCollectionExpressionback to summary
public final CollectionExpression buildCollectionExpression()

Creates a new CollectionExpression that will wrap the single order by item.

Returns:CollectionExpression

The single order by item represented by a temporary collection

findQueryBNFback to summary
public final JPQLQueryBNF findQueryBNF(Expression expression)

Overrides org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.findQueryBNF.

Implements org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Doc from org.eclipse.persistence.jpa.jpql.parser.Expression.findQueryBNF.

Retrieves the JPQLQueryBNF that represents the fragment of this Expression that was used when parsing the given Expression.

Parameters
expression:Expression

The Expression that is a descendant of this one

Returns:JPQLQueryBNF

The JPQLQueryBNF that was used to parse the given expression

Annotations
@Override
getActualIdentifierback to summary
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:String

The actual identifier that was actually parsed

getOrderByItemsback to summary
public final Expression getOrderByItems()

Returns the Expression representing the list of items to order.

Returns:Expression

The expression representing the list of items to order

hasOrderByItemsback to summary
public final boolean hasOrderByItems()

Determines whether the list of items to order was parsed.

Returns:boolean

true the list of items to order was parsed; false otherwise

hasSpaceAfterIdentifierback to summary
public final boolean hasSpaceAfterIdentifier()

Determines whether a whitespace was parsed after the identifier.

Returns:boolean

true if a whitespace was parsed after the identifier; false otherwise

parseback to summary
protected void parse(WordParser wordParser, boolean tolerant)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.parse.

Parses the query by starting at the current position, which is part of the given WordParser.

Parameters
wordParser:WordParser

The text to parse based on the current position of the cursor

tolerant:boolean

Determines whether the parsing system should be tolerant, meaning if it should try to parse invalid or incomplete queries

Annotations
@Override
toParsedTextback to summary
protected void toParsedText(StringBuilder writer, boolean actual)

Implements abstract org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Doc from org.eclipse.persistence.jpa.jpql.parser.AbstractExpression.toParsedText.

Generates a string representation of this Expression, including its children, if it has any.

Parameters
writer:StringBuilder

The buffer used to append this Expression's string representation

actual:boolean

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

Annotations
@Override