|
© 2002 BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.p13n.content.expression.SortCriteria
A class which handles the sortBy part of a Search.
This object represents a single sort criteria, which is a property name and an ascending/descending flag. The class provides a utility method to parse a sortBy string into an array of SortCriteria.
This supports standard SQL-style sort by clauses of the form:
<propname>[ASC|DESC], ...
where ASC|DESC is optional, defaulting to ASC; also, if propname contains a
".", it assumed to be <properyset>.<propname>. Additionally,
if the property name contains non-identifier characters
(e.g. whitespace, double quotes, dashes, etc.), you can use the
toProperty('propname')
or
toProperty('propertyset', 'propname')
Examples of valid sortBy clauses:
Field Summary | |
boolean |
isAscending
The ascending or descending order. |
java.lang.String |
propertyName
The property name to sort on. |
java.lang.String |
propertySet
The property set name. |
Constructor Summary | |
SortCriteria(java.lang.String propertyName)
Constructor. |
|
SortCriteria(java.lang.String propertyName,
boolean isAscending)
Constructor. |
|
SortCriteria(java.lang.String propertySet,
java.lang.String propertyName,
boolean isAscending)
Constructor. |
Method Summary | |
java.lang.Object |
clone()
Clone this object. |
int |
compareTo(java.lang.Object obj)
Compare this object to another object. |
boolean |
equals(java.lang.Object o)
Determine if this object is equal to another object. |
static SortCriteria[] |
getSortCriteria(java.lang.String sortBy)
Parse the given sort string and return an array of SortCriteria. |
int |
hashCode()
Override the hashCode because we overrid equals(). |
java.lang.String |
toString()
Convert to a string. |
Methods inherited from class java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public java.lang.String propertySet
public java.lang.String propertyName
public boolean isAscending
Constructor Detail |
public SortCriteria(java.lang.String propertySet, java.lang.String propertyName, boolean isAscending)
public SortCriteria(java.lang.String propertyName, boolean isAscending)
public SortCriteria(java.lang.String propertyName)
Method Detail |
public java.lang.Object clone()
public int compareTo(java.lang.Object obj)
public boolean equals(java.lang.Object o)
public int hashCode()
public static SortCriteria[] getSortCriteria(java.lang.String sortBy) throws java.lang.IllegalArgumentException
sortBy
- the sort string (e.g. "identifier ASC, creationDate
DESC").public java.lang.String toString()
|
© 2002 BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |