Package netscape.ldap

Class LDAPSortKey

java.lang.Object
netscape.ldap.LDAPSortKey
All Implemented Interfaces:
Serializable

public class LDAPSortKey extends Object implements Serializable
Represents sorting instructions for a particular attribute.
Version:
1.0
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    LDAPSortKey(String keyDescription)
    Constructs a new LDAPSortKey object that will sort based on the specified instructions.
    LDAPSortKey(String key, boolean reverse)
    Constructs a new LDAPSortKey object that will sort based on the specified attribute and sort order.
    LDAPSortKey(String key, boolean reverse, String matchRule)
    Constructs a new LDAPSortKey object that will sort based on the specified attribute, sort order, and matching rule.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the attribute by which to sort.
    Returns the object ID (OID) of the matching rule used for sorting.
    boolean
    Returns true if sorting is to be done in descending order.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • LDAPSortKey

      public LDAPSortKey(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:
    • LDAPSortKey

      public LDAPSortKey(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:
    • LDAPSortKey

      public LDAPSortKey(String key, boolean reverse, 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:
  • Method Details

    • getKey

      public 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 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 String toString()
      Overrides:
      toString in class Object