com.netscape.jndi.ldap.controls
Class LdapSortKey

java.lang.Object
  |
  +--netscape.ldap.LDAPSortKey
        |
        +--com.netscape.jndi.ldap.controls.LdapSortKey

All Implemented Interfaces:

java.io.Serializable

public class LdapSortKey

extends netscape.ldap.LDAPSortKey

Represents sorting instructions for a particular attribute.

See Also:

Serialized Form

Field Summary

Fields inherited from class netscape.ldap.LDAPSortKey

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 to sort by.
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.

Methods inherited from class netscape.ldap.LDAPSortKey

toString

Methods inherited from class java.lang.Object

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

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 to sort by. 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 to sort by. 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 to sort by. 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 to sort by.

Overrides:

getKey in class netscape.ldap.LDAPSortKey

Returns:

A single attribute to sort by.

getReverse

public boolean getReverse()

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

Overrides:

getReverse in class netscape.ldap.LDAPSortKey

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.

Overrides:

getMatchRule in class netscape.ldap.LDAPSortKey

Returns:

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