Class Overview
A sort key and its associated sort parameters.
This class implements a sort key which is used by the LDAPv3
Control for server-side sorting of search results as defined in
RFC 2891.
Summary
Public Constructors |
|
SortKey(String attrID)
Creates the default sort key for an attribute.
|
|
SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)
Creates a sort key for an attribute.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait()
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object.
|
final
void
|
wait(long timeout, int nanos)
Causes the current thread to wait until another thread invokes the
notify() method or the
notifyAll() method for this object, or
some other thread interrupts the current thread, or a certain
amount of real time has elapsed.
|
final
void
|
wait(long timeout)
Causes the current thread to wait until either another thread invokes the
notify() method or the
notifyAll() method for this object, or a
specified amount of time has elapsed.
|
|
Public Constructors
public
SortKey
(String attrID)
Creates the default sort key for an attribute. Entries will be sorted
according to the specified attribute in ascending order using the
ordering matching rule defined for use with that attribute.
Parameters
attrID
| The non-null ID of the attribute to be used as a sort
key.
|
public
SortKey
(String attrID, boolean ascendingOrder, String matchingRuleID)
Creates a sort key for an attribute. Entries will be sorted according to
the specified attribute in the specified sort order and using the
specified matching rule, if supplied.
Parameters
attrID
| The non-null ID of the attribute to be used as
a sort key. |
ascendingOrder
| If true then entries are arranged in ascending
order. Otherwise there are arranged in
descending order. |
matchingRuleID
| The possibly null ID of the matching rule to
use to order the attribute values. If not
specified then the ordering matching rule
defined for the sort key attribute is used.
|
Public Methods
public
String
getAttributeID
()
Retrieves the attribute ID of the sort key.
Returns
- The non-null Attribute ID of the sort key.
public
String
getMatchingRuleID
()
Retrieves the matching rule ID used to order the attribute values.
Returns
- The possibly null matching rule ID. If null then the
ordering matching rule defined for the sort key attribute
is used.
public
boolean
isAscending
()
Determines the sort order.
Returns
- true if the sort order is ascending, false if descending.