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 の場合、ソートキー属性用に定義された順序付けマッチング規則が使用される