模块 java.naming

软件包 javax.naming.ldap

Class 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 - 要用作排序键的属性的非空ID。

ascendingOrder - 如果为true，则条目按升序排列。 否则按降序排列。

matchingRuleID - 用于对属性值进行排序的匹配规则的可能为空的ID。 如果未指定，则使用为排序键属性定义的排序匹配规则。

方法详细信息

getAttributeID

public String getAttributeID()

检索排序键的属性ID。

结果

排序键的非null属性ID。

isAscending

public boolean isAscending()

确定排序顺序。

结果

如果排序顺序为升序，则为true;如果降序，则为false。

getMatchingRuleID

public String getMatchingRuleID()

检索用于对属性值进行排序的匹配规则ID。

结果

可能为空的匹配规则ID。 如果为null，则使用为排序键属性定义的排序匹配规则。