モジュール java.naming
パッケージ javax.naming.ldap

クラスSortKey

java.lang.Object
javax.naming.ldap.SortKey
public class SortKey
extends Object
ソート・キーと関連ソート・パラメータです。 このクラスは、LDAPv3コントロールが検索結果をサーバー側でソートするために使用するソート・キーを実装します。この定義は、RFC 2891に記載されています。
導入されたバージョン:
1.5
関連項目:
SortControl

  • コンストラクタのサマリー

    コンストラクタ 
    コンストラクタ 説明
    SortKey​(String attrID)
    属性のデフォルトのソート・キーを作成します。
    SortKey​(String attrID, boolean ascendingOrder, String matchingRuleID)
    属性のソート・キーを作成します。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    String getAttributeID()
    ソート・キーの属性IDを取得します。
    String getMatchingRuleID()
    属性値の順序付けに使用するマッチング規則のIDを取得します。
    boolean isAscending()
    ソート順序を特定します。

    クラス java.lang.Objectで宣言されたメソッド

    clone、equals、finalize、getClass、hashCode、notify、notifyAll、toString、wait、wait、wait

  • コンストラクタの詳細

    • SortKey

      public SortKey​(String attrID)
      属性のデフォルトのソート・キーを作成します。 エントリは、属性ごとに定義された順序付けマッチング規則により、昇順にソートされます。
      パラメータ:
      attrID - ソート・キーとして使用される属性のnull以外のID。

    • SortKey

      public SortKey​(String attrID, boolean ascendingOrder, String matchingRuleID)
      属性のソート・キーを作成します。 エントリは、属性ごとに指定されたソート順序でソートされます。
      パラメータ:
      attrID - ソート・キーとして使用される属性のnull以外のID。
      ascendingOrder - trueの場合、エントリは昇順にソートされる。 そうでない場合、降順にソートされる。
      matchingRuleID - 属性値の順序付けに使用するマッチング規則のIDで、nullの可能性もある。 未指定の場合、ソート・キー属性用に定義された順序付けマッチング規則が使用される。

  • メソッドの詳細

    • getAttributeID

      public String getAttributeID()
      ソート・キーの属性IDを取得します。
      戻り値:
      ソート・キーのnull以外の属性ID。

    • isAscending

      public boolean isAscending()
      ソート順序を特定します。
      戻り値:
      ソート順序が昇順の場合はtrue、降順の場合はfalse。

    • getMatchingRuleID

      public String getMatchingRuleID()
      属性値の順序付けに使用するマッチング規則のIDを取得します。
      戻り値:
      マッチング規則ID。nullの可能性もある。 nullの場合、ソート・キー属性用に定義された順序付けマッチング規則が使用される。