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，则使用为排序键属性定义的排序匹配规则。