|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.cayenne.query.Ordering
public class Ordering
Defines object sorting criteria, used either for in-memory sorting of object lists or as a specification for building ORDER BY clause of a SelectQuery query. Note that in case of in-memory sorting, Ordering can be used with any JavaBeans, not just DataObjects.
Field Summary | |
---|---|
protected boolean |
nullSortedFirst
|
protected boolean |
pathExceptionSuppressed
|
protected SortOrder |
sortOrder
|
protected Expression |
sortSpec
|
protected java.lang.String |
sortSpecString
|
Constructor Summary | |
---|---|
Ordering()
|
|
Ordering(java.lang.String sortPathSpec,
SortOrder sortOrder)
|
Method Summary | |
---|---|
int |
compare(java.lang.Object o1,
java.lang.Object o2)
Comparable interface implementation. |
void |
encodeAsXML(XMLEncoder encoder)
Encodes itself as a query ordering. |
SortOrder |
getSortOrder()
Returns sort order for this ordering |
Expression |
getSortSpec()
Returns the expression defining a ordering Java Bean property. |
java.lang.String |
getSortSpecString()
Returns sortSpec string representation. |
boolean |
isAscending()
Returns true if sorting is done in ascending order. |
boolean |
isCaseInsensitive()
Returns true if the sorting is case insensitive |
boolean |
isCaseSensitive()
Returns true if the sorting is case sensitive. |
boolean |
isDescending()
Returns true if the sorting is done in descending order. |
boolean |
isNullSortedFirst()
Get sort order for nulls. |
boolean |
isPathExceptionSuppressed()
Is a path with a null in the middle is ignored. |
void |
orderList(java.util.List<?> objects)
Orders the given list of objects according to the ordering that this object specifies. |
static void |
orderList(java.util.List<?> objects,
java.util.List<Ordering> orderings)
Orders a given list of objects, using a List of Orderings applied according the default iteration order of the Orderings list. |
void |
setAscending()
If the sort order is DESCENDING or DESCENDING_INSENSITIVE, sets the sort order to ASCENDING or ASCENDING_INSENSITIVE, respectively. |
void |
setCaseInsensitive()
If the sort order is ASCENDING or DESCENDING, sets the sort order to ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, respectively. |
void |
setCaseSensitive()
If the sort order is ASCENDING_INSENSITIVE or DESCENDING_INSENSITIVE, sets the sort order to ASCENDING or DESCENDING, respectively. |
void |
setDescending()
If the sort order is ASCENDING or ASCENDING_INSENSITIVE, sets the sort order to DESCENDING or DESCENDING_INSENSITIVE, respectively. |
void |
setNullSortedFirst(boolean nullSortedFirst)
Sets sort order for whether nulls are at the top or bottom of the resulting list. |
void |
setPathExceptionSupressed(boolean pathExceptionSuppressed)
Sets whether a path with a null in the middle is ignored. |
void |
setSortOrder(SortOrder order)
Sets the sort order for this ordering. |
void |
setSortSpec(Expression sortSpec)
Sets the expression defining a ordering Java Bean property. |
void |
setSortSpecString(java.lang.String sortSpecString)
Sets sortSpec to be an expression represented by string argument. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Comparator |
---|
equals |
Field Detail |
---|
protected java.lang.String sortSpecString
protected transient Expression sortSpec
protected SortOrder sortOrder
protected boolean pathExceptionSuppressed
protected boolean nullSortedFirst
Constructor Detail |
---|
public Ordering()
public Ordering(java.lang.String sortPathSpec, SortOrder sortOrder)
Method Detail |
---|
public static void orderList(java.util.List<?> objects, java.util.List<Ordering> orderings)
public void setSortSpecString(java.lang.String sortSpecString)
public void setNullSortedFirst(boolean nullSortedFirst)
nullSortedFirst
- true sorts nulls to the top of the list, false sorts nulls
to the bottompublic boolean isNullSortedFirst()
public void setPathExceptionSupressed(boolean pathExceptionSuppressed)
painting
on artist.name
would by default throw an
exception if the artist was null. If set to true, then this is treated just like a
null value. Default is false.
pathExceptionSuppressed
- true to suppress exceptions and sort as nullpublic boolean isPathExceptionSuppressed()
public java.lang.String getSortSpecString()
public void setSortOrder(SortOrder order)
public boolean isAscending()
public boolean isDescending()
public void setAscending()
public void setDescending()
public boolean isCaseInsensitive()
public boolean isCaseSensitive()
public void setCaseInsensitive()
public void setCaseSensitive()
public Expression getSortSpec()
public void setSortSpec(Expression sortSpec)
public void orderList(java.util.List<?> objects)
objects
- a List of objects to be sortedpublic int compare(java.lang.Object o1, java.lang.Object o2)
compare
in interface java.util.Comparator<java.lang.Object>
public void encodeAsXML(XMLEncoder encoder)
encodeAsXML
in interface XMLSerializable
public java.lang.String toString()
toString
in class java.lang.Object
public SortOrder getSortOrder()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |