|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.content.expression.SortCriteria
public class 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
Deprecated The ascending or descending order. |
String |
propertyName
Deprecated The property name to sort on. |
String |
propertySet
Deprecated The property set name. |
Constructor Summary | |
---|---|
SortCriteria(String propertyName)
Deprecated Constructor. |
|
SortCriteria(String propertyName,
boolean isAscending)
Deprecated Constructor. |
|
SortCriteria(String propertySet,
String propertyName,
boolean isAscending)
Deprecated Constructor. |
Method Summary | |
---|---|
Object |
clone()
Deprecated Clone this object. |
int |
compareTo(Object obj)
Deprecated Compare this object to another object. |
boolean |
equals(Object o)
Deprecated Determine if this object is equal to another object. |
static SortCriteria[] |
getSortCriteria(String sortBy)
Deprecated Parse the given sort string and return an array of SortCriteria. |
int |
hashCode()
Deprecated Override the hashCode because we overrid equals(). |
String |
toString()
Deprecated Convert to a string. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public String propertySet
public String propertyName
public boolean isAscending
Constructor Detail |
---|
public SortCriteria(String propertySet, String propertyName, boolean isAscending)
public SortCriteria(String propertyName, boolean isAscending)
public SortCriteria(String propertyName)
Method Detail |
---|
public Object clone()
clone
in class Object
public int compareTo(Object obj)
compareTo
in interface Comparable
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public static SortCriteria[] getSortCriteria(String sortBy) throws IllegalArgumentException
sortBy
- the sort string (e.g. "identifier ASC, creationDate
DESC").
IllegalArgumentException
- thrown on an invalid sortBy string.public String toString()
toString
in class Object
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |