public final class OrderByItem extends AbstractExpression
state_field_path_expression
that evaluates to an orderable
state field of an entity or embeddable class abstract schema type designated in the SELECT clause
by one of the following:
state_field_path_expression
that evaluates to the same
state field of the same entity or embeddable abstract schema type as a state_field_path_expression
in the SELECT clause
result_variable
that refers to an orderable item in the SELECT
clause for which the same result_variable
has been specified. This may be
the result of an aggregate_expression, a scalar_expression
, or a state_field_path_expression
in the SELECT clause.
The keyword ASC specifies that ascending ordering be used for the associated orderby_item; the keyword DESC specifies that descending ordering be used. Ascending ordering is the default.
JPA 1.0:
orderby_item ::= state_field_path_expression [ ASC | DESC ]
JPA 2.0
orderby_item ::= state_field_path_expression | result_variable [ ASC | DESC ]
Modifier and Type | Class and Description |
---|---|
static class |
OrderByItem.Ordering
This enumeration lists all the possible choices for ordering an item.
|
COMMA, DOT, DOUBLE_QUOTE, LEFT_CURLY_BRACKET, LEFT_PARENTHESIS, NOT_DEFINED, RIGHT_CURLY_BRACKET, RIGHT_PARENTHESIS, SINGLE_QUOTE, SPACE, UNDERSCORE
ABS, ALL, AND, ANY, AS, ASC, AVG, BETWEEN, BIT_LENGTH, BOTH, CASE, CHAR_LENGTH, CHARACTER_LENGTH, CLASS, COALESCE, CONCAT, COUNT, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, DELETE, DELETE_FROM, DESC, DIFFERENT, DISTINCT, DIVISION, ELSE, EMPTY, END, ENTRY, EQUAL, ESCAPE, EXISTS, FALSE, FETCH, FROM, FUNC, GREATER_THAN, GREATER_THAN_OR_EQUAL, GROUP_BY, HAVING, IN, INDEX, INNER, INNER_JOIN, INNER_JOIN_FETCH, IS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JOIN, JOIN_FETCH, KEY, 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_EXISTS, NOT_IN, NOT_LIKE, NOT_MEMBER, NOT_MEMBER_OF, NULL, NULLIF, OBJECT, OF, OR, ORDER_BY, OUTER, PLUS, POSITION, POSITIONAL_PARAMETER, QUOTE, SELECT, SET, SIZE, SOME, SQRT, SUBSTRING, SUM, THEN, TRAILING, TREAT, TRIM, TRUE, TYPE, UNKNOWN, UPDATE, UPPER, VALUE, WHEN, WHERE
Modifier and Type | Method and Description |
---|---|
void |
accept(ExpressionVisitor visitor)
Visits this
Expression by the given visitor . |
void |
acceptChildren(ExpressionVisitor visitor)
Visits the children of this
Expression . |
Expression |
getExpression()
Returns the
Expression that represents the order by expression. |
OrderByItem.Ordering |
getOrdering()
Returns the enum constant representing the ordering type.
|
JPQLQueryBNF |
getQueryBNF()
Returns the BNF of this
Expression . |
boolean |
hasExpression()
Determines whether the order by expression was parsed.
|
boolean |
hasSpaceAfterExpression()
Determines whether a whitespace was parsed after the order by expression.
|
boolean |
isAscending()
Determines whether the ordering was specified as being ascendant.
|
boolean |
isDefault()
Determines whether the ordering was not specified.
|
boolean |
isDescending()
Determines whether the ordering was specified as being descendant.
|
children, findQueryBNF, getChildren, getParent, getRoot, identifierRole, identifiers, identifierVersion, isAncestor, isIdentifier, isVirtual, orderedChildren, queryBNF, toActualText, toParsedText, toString
public void accept(ExpressionVisitor visitor)
Expression
by the given visitor
.visitor
- The visitor
to visit this objectpublic void acceptChildren(ExpressionVisitor visitor)
Expression
. This method can be used to optimize traversing
the children since a new list is not created every time Expression.children()
or Expression.getChildren()
is called.
This does not traverse the Expression
sub-hierarchy, use an subclass of
AbstractTraverseChildrenVisitor
in order to traverse the entire sub-hierarchy.
visitor
- The visitor
to visit the children of this object.public Expression getExpression()
Expression
that represents the order by expression.public OrderByItem.Ordering getOrdering()
OrderByItem.Ordering.DEFAULT
is returnedpublic JPQLQueryBNF getQueryBNF()
Expression
.getQueryBNF
in class AbstractExpression
JPQLQueryBNF
, which represents the grammar of this Expression
public boolean hasExpression()
true
if the order by expression was parsed; false
otherwisepublic boolean hasSpaceAfterExpression()
true
if there was a whitespace after the order by expression;
false
otherwisepublic boolean isAscending()
true
if ASC was parsed; false
otherwisepublic boolean isDefault()
true
if no ordering was parsed; false
otherwisepublic boolean isDescending()
true
if DESC was parsed; false
otherwiseEclipseLink 2.3.2, "build v20111125-r10461" API Reference