Class SortKey

java.lang.Object
javax.naming.ldap.SortKey
public class SortKey extends Object
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:

  • Constructor Summary

    Constructors
    Constructor
    Description
    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.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeID()
    Retrieves the attribute ID of the sort key.
    String
    getMatchingRuleID()
    Retrieves the matching rule ID used to order the attribute values.
    boolean
    isAscending()
    Determines the sort order.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • SortKey

      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.

    • SortKey

      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.

  • Method Details

    • getAttributeID

      public String getAttributeID()
      Retrieves the attribute ID of the sort key.
      Returns:
      The non-null Attribute ID of the sort key.

    • isAscending

      public boolean isAscending()
      Determines the sort order.
      Returns:
      true if the sort order is ascending, false if descending.

    • getMatchingRuleID

      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.