javax.naming.ldap

Класс SortKey

java.lang. Объект

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) Создает ключ сортировки для атрибута.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
Строка	getAttributeID() Получает ID атрибута ключа сортировки.
Строка	getMatchingRuleID() Получает соответствующий ID правила, используемый, чтобы упорядочить значения атрибута.
boolean	isAscending() Определяет порядок сортировки.

Методы java.lang унаследованный от класса. Объект

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

Деталь конструктора

SortKey

public SortKey(String attrID)

Создает ключ сортировки по умолчанию для атрибута. Записи будут сортированы согласно указанному атрибуту, в порядке возрастания используя правило соответствия упорядочивания, определенное для использования с тем атрибутом.

Параметры:

attrID - Ненулевой ID атрибута, который будет использоваться в качестве ключа сортировки.

SortKey

public SortKey(String attrID,
       boolean ascendingOrder,
       String matchingRuleID)

Создает ключ сортировки для атрибута. Записи будут сортированы согласно указанному атрибуту в указанном порядке сортировки и использовании указанного правила соответствия, если предоставлено.

Параметры:

attrID - Ненулевой ID атрибута, который будет использоваться в качестве ключа сортировки.

ascendingOrder - Если истина тогда записи располагается в порядке возрастания. Иначе там располагаются в порядке убывания.

matchingRuleID - Возможно нулевой ID соответствующего правила использовать, чтобы упорядочить значения атрибута. Если не определенный тогда правило соответствия упорядочивания, определенное для атрибута ключа сортировки, используется.

Деталь метода

getAttributeID

public String getAttributeID()

Получает ID атрибута ключа сортировки.

Возвраты:

ID ненеопределенного атрибута ключа сортировки.

isAscending

public boolean isAscending()

Определяет порядок сортировки.

Возвраты:

истина, если порядок сортировки возрастает, ложь, убывая.

getMatchingRuleID

public String getMatchingRuleID()

Получает соответствующий ID правила, используемый, чтобы упорядочить значения атрибута.

Возвраты:

Возможно нуль, соответствующий ID правила. Если нуль тогда правило соответствия упорядочивания, определенное для атрибута ключа сортировки, используется.