netscape.ldap
Class LDAPSortKey

java.lang.Object
  |
  +--netscape.ldap.LDAPSortKey

public class LDAPSortKey

extends java.lang.Object

implements java.io.Serializable

Represents sorting instructions for a particular attribute.

See Also:

Serialized Form

Field Summary

static int

REVERSE

Constructor Summary

LDAPSortKey(java.lang.String keyDescription)
Constructs a new LDAPSortKey object that will sort based on the specified instructions.

LDAPSortKey(java.lang.String key, boolean reverse)
Constructs a new LDAPSortKey object that will sort based on the specified attribute and sort order.

LDAPSortKey(java.lang.String key, boolean reverse, java.lang.String matchRule)
Constructs a new LDAPSortKey object that will sort based on the specified attribute, sort order, and matching rule.

Method Summary

java.lang.String	getKey() Returns the attribute by which to sort.
java.lang.String	getMatchRule() Returns the object ID (OID) of the matching rule used for sorting.
boolean	getReverse() Returns true if sorting is to be done in descending order.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REVERSE

public static final int REVERSE

Constructor Detail

LDAPSortKey

public LDAPSortKey(java.lang.String keyDescription)

Constructs a new LDAPSortKey object that will sort based on the specified instructions.

Parameters:

keyDescription - a single attribute specification by which to sort If preceded by a hyphen ("-"), the attribute is sorted in reverse order. You can also specify the object ID (OID) of a matching rule after a colon (":"). For example:

• "cn" (sort by the cn attribute)

• "-cn" (sort by the cn attribute in reverse order)

• "-cn:1.2.3.4" (sort by the cn attribute in reverse order and use the matching rule identified by the OID 1.2.3.4)

See Also:

LDAPSortControl, LDAPVirtualListControl

LDAPSortKey

public LDAPSortKey(java.lang.String key,
                   boolean reverse)

Constructs a new LDAPSortKey object that will sort based on the specified attribute and sort order.

Parameters:

key - a single attribute by which to sort. For example:

• "cn" (sort by the cn attribute)
• "givenname" (sort by the givenname attribute)

reverse - if true, the sorting is done in descending order

See Also:

LDAPSortControl, LDAPVirtualListControl

LDAPSortKey

public LDAPSortKey(java.lang.String key,
                   boolean reverse,
                   java.lang.String matchRule)

Constructs a new LDAPSortKey object that will sort based on the specified attribute, sort order, and matching rule.

Parameters:

key - a single attribute by which to sort. For example:

• "cn" (sort by the cn attribute)
• "givenname" (sort by the givenname attribute)

reverse - if true, the sorting is done in descending order

matchRule - object ID (OID) of the matching rule for the attribute (for example, 1.2.3.4)

See Also:

LDAPSortControl, LDAPVirtualListControl

Method Detail

getKey

public java.lang.String getKey()

Returns the attribute by which to sort.

Returns:

a single attribute by which to sort.

getReverse

public boolean getReverse()

Returns true if sorting is to be done in descending order.

Returns:

true if sorting is to be done in descending order.

getMatchRule

public java.lang.String getMatchRule()

Returns the object ID (OID) of the matching rule used for sorting. If no matching rule is specified, null is returned.

Returns:

the object ID (OID) of the matching rule, or null if the sorting instructions specify no matching rule.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object