| |
|
| java.lang.Object javax.naming.ldap.SortKey
SortKey | public class SortKey (Code) | | 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.
since: 1.5 See Also: SortControl author: Vincent Ryan |
Constructor Summary | |
public | SortKey(String attrID) Creates the default sort key for an attribute. | public | SortKey(String attrID, boolean ascendingOrder, String matchingRuleID) Creates a sort key for an attribute. |
Method Summary | |
public String | getAttributeID() Retrieves the attribute ID of the sort key. | public String | getMatchingRuleID() Retrieves the matching rule ID used to order the attribute values.
The possibly null matching rule ID. | public boolean | isAscending() Determines the sort order. |
SortKey | public SortKey(String attrID)(Code) | | 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 sortkey. |
SortKey | public SortKey(String attrID, boolean ascendingOrder, String matchingRuleID)(Code) | | 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 asa sort key. Parameters: ascendingOrder - If true then entries are arranged in ascendingorder. Otherwise there are arranged indescending order. Parameters: matchingRuleID - The possibly null ID of the matching rule touse to order the attribute values. If notspecified then the ordering matching ruledefined for the sort key attribute is used. |
getAttributeID | public String getAttributeID()(Code) | | Retrieves the attribute ID of the sort key.
The non-null Attribute ID of the sort key. |
getMatchingRuleID | public String getMatchingRuleID()(Code) | | Retrieves the matching rule ID used to order the attribute values.
The possibly null matching rule ID. If null then theordering matching rule defined for the sort key attributeis used. |
isAscending | public boolean isAscending()(Code) | | Determines the sort order.
true if the sort order is ascending, false if descending. |
|
|
|