public class OrderByItemStateObject extends AbstractStateObject
ORDER BY item must be one of the following:
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
ORDER BY 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 ]OrderByItem| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ORDERING_PROPERTY
Notifies the ordering property has changed.
|
static java.lang.String |
STATE_OBJECT_PROPERTY
Notifies the ordering property has changed.
|
| Constructor and Description |
|---|
OrderByItemStateObject(OrderByClauseStateObject parent)
Creates a new
OrderByItemStateObject. |
OrderByItemStateObject(OrderByClauseStateObject parent,
OrderByItem.Ordering ordering)
Creates a new
OrderByItemStateObject. |
OrderByItemStateObject(OrderByClauseStateObject parent,
StateObject stateObject,
OrderByItem.Ordering ordering)
Creates a new
OrderByItemStateObject. |
OrderByItemStateObject(OrderByClauseStateObject parent,
java.lang.String jpqlFragment,
OrderByItem.Ordering ordering)
Creates a new
OrderByItemStateObject. |
| Modifier and Type | Method and Description |
|---|---|
void |
accept(StateObjectVisitor visitor)
Visits this
StateObject by the given visitor. |
protected void |
addChildren(java.util.List<StateObject> children)
Adds the children of this
StateObject to the given list. |
OrderByItem |
getExpression()
Returns the actual parsed object if this
StateObject representation of the JPQL query
was created by parsing an existing JPQL query. |
OrderByItem.Ordering |
getOrdering()
Returns the enum constant representing the ordering type.
|
OrderByClauseStateObject |
getParent()
Returns the parent of this
StateObject. |
StateObject |
getStateObject()
Returns the
StateObject representing the value used for ordering. |
boolean |
hasStateObject()
Determines whether the
StateObject representing the value used for ordering has been
defined. |
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.
|
boolean |
isEquivalent(StateObject stateObject)
Determines whether the given
StateObject is equivalent to this one, i.e. the
information of both StateObject is the same. |
void |
parse(java.lang.String jpqlFragment)
Parses the given JPQL fragment, which represents either a state-field pathe expression or a
result variable, and creates the
StateObject. |
void |
removeOrdering()
Removes the ordering if it's specified, otherwise do nothing.
|
void |
setExpression(OrderByItem expression)
Keeps a reference of the
parsed object object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects. |
void |
setOrdering(OrderByItem.Ordering ordering)
Sets the enum constant representing the ordering type.
|
void |
setStateObject(StateObject stateObject)
Sets the
StateObject representing the value used for ordering. |
protected void |
toTextInternal(java.lang.Appendable writer)
Prints out a string representation of this
StateObject, which should not be used to
define a true string representation of a JPQL query but should be used for
debugging purposes. |
acceptUnknownVisitor, acceptUnknownVisitor, addProblems, addPropertyChangeListener, areEquivalent, buildProblem, buildProblem, buildStateObject, buildStateObjects, checkParent, children, decorate, equals, findIdentificationVariable, firePropertyChanged, getChangeSupport, getDeclaration, getDecorator, getGrammar, getManagedTypeProvider, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, initialize, isDecorated, parent, parent, parent, removePropertyChangeListener, setExpression, setParent, toString, toString, toStringInternal, toStringItems, toTextpublic static final java.lang.String ORDERING_PROPERTY
public static final java.lang.String STATE_OBJECT_PROPERTY
public OrderByItemStateObject(OrderByClauseStateObject parent)
OrderByItemStateObject.parent - The parent of this state object, which cannot be nulljava.lang.NullPointerException - The given parent cannot be nullpublic OrderByItemStateObject(OrderByClauseStateObject parent, OrderByItem.Ordering ordering)
OrderByItemStateObject.parent - The parent of this state object, which cannot be nulljava.lang.NullPointerException - The given parent cannot be nullpublic OrderByItemStateObject(OrderByClauseStateObject parent, StateObject stateObject, OrderByItem.Ordering ordering)
OrderByItemStateObject.parent - The parent of this state object, which cannot be nullstateObject - The StateObject of the itemordering - One of the possible OrderByItem.Ordering choicejava.lang.NullPointerException - The given parent cannot be nullpublic OrderByItemStateObject(OrderByClauseStateObject parent, java.lang.String jpqlFragment, OrderByItem.Ordering ordering)
OrderByItemStateObject.parent - The parent of this state object, which cannot be nulljpqlFragment - The JPQL fragment representing the ordering itemordering - One of the possible OrderByItem.Ordering choicejava.lang.NullPointerException - The given parent cannot be nullpublic void accept(StateObjectVisitor visitor)
StateObject by the given visitor.visitor - The visitor to visit this objectprotected void addChildren(java.util.List<StateObject> children)
StateObject to the given list.addChildren in class AbstractStateObjectchildren - The list used to store the childrenpublic OrderByItem getExpression()
StateObject representation of the JPQL query
was created by parsing an existing JPQL query.getExpression in interface StateObjectgetExpression in class AbstractStateObjectStateObject
or null when the JPQL query is manually created (i.e. not from a string)public OrderByItem.Ordering getOrdering()
OrderByItem.Ordering.DEFAULT is returnedpublic OrderByClauseStateObject getParent()
StateObject.getParent in interface StateObjectgetParent in class AbstractStateObjectStateObject, which is null only when
this is the root of the hierarchypublic StateObject getStateObject()
StateObject representing the value used for ordering.StateObject representing the value used for orderingpublic boolean hasStateObject()
StateObject representing the value used for ordering has been
defined.true if the ordering value is defined; 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 otherwisepublic boolean isEquivalent(StateObject stateObject)
StateObject is equivalent to this one, i.e. the
information of both StateObject is the same.isEquivalent in interface StateObjectisEquivalent in class AbstractStateObjectstateObject - The StateObject to compare its content to this onetrue if both object are equivalent; false otherwisepublic void parse(java.lang.String jpqlFragment)
StateObject.jpqlFragment - The portion of the query representing a state-field path expression or
result variablepublic void removeOrdering()
public void setExpression(OrderByItem expression)
parsed object object, which should only be
done when this object is instantiated during the conversion of a parsed JPQL query into
StateObjects.expression - The parsed object representing an order by itempublic void setOrdering(OrderByItem.Ordering ordering)
ordering - The constant representing the ordering, in the case the ordering was not
parsed, then OrderByItem.Ordering.DEFAULT should be usedpublic void setStateObject(StateObject stateObject)
StateObject representing the value used for ordering.stateObject - The StateObject representing the value used for orderingprotected void toTextInternal(java.lang.Appendable writer)
throws java.io.IOException
StateObject, which should not be used to
define a true string representation of a JPQL query but should be used for
debugging purposes.toTextInternal in class AbstractStateObjectwriter - The writer used to print out the string representationjava.io.IOException - This should never happens, it is only required because Appendable
is used instead of any concrete class