JavaTM 2 Platform
Standard Ed. 6

javax.naming.ldap
類別 SortKey

java.lang.Object
  繼承者 javax.naming.ldap.SortKey

public class SortKey
extends Object

排序鍵及其關聯的排序參數。此類別實作在 RFC 2891 中定義的、LDAPv3 控制元件用來在伺服器端排序搜尋結果的排序鍵。

從以下版本開始:
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,則使用為排序鍵屬性定義的排序比對規則。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only