compact3

javax.naming.directory

Класс SearchControls

java.lang. Объект

javax.naming.directory. SearchControls

Все Реализованные Интерфейсы:

Сериализуемый

public class SearchControls
extends Object
implements Serializable

Этот class инкапсулирует факторы, которые определяют контекст поиска и что возвращается в результате поиска.

Экземпляр SearchControls не синхронизируется против параллельного многопоточного доступа. Многократные потоки, пытающиеся получить доступ и изменить единственный экземпляр SearchControls, должны заблокировать объект.

С тех пор:

1.3

См. Также:

Сериализированная Форма

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
static int	OBJECT_SCOPE Ищите именованный объект.
static int	ONELEVEL_SCOPE Ищите один уровень именованного контекста.
static int	SUBTREE_SCOPE Ищите все поддерево базировалось в именованном объекте.

Сводка конструктора

Конструкторы

Конструктор и Описание
SearchControls() Создает поиск ограничения, используя значения по умолчанию.
SearchControls(int scope, long countlim, int timelim, String[] attrs, boolean retobj, boolean deref) Создает поиск ограничения, используя параметры.

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

Модификатор и Тип	Метод и Описание
long	getCountLimit() Получает максимальное количество записей, которые будут возвращены в результате поиска.
boolean	getDerefLinkFlag() Определяет, будут ли ссылки разыменованы во время поиска.
Строка[]	getReturningAttributes() Получает атрибуты, которые будут возвращены как часть поиска.
boolean	getReturningObjFlag() Определяет, будут ли объекты возвращены как часть результата.
int	getSearchScope() Получает контекст поиска этих SearchControls.
int	getTimeLimit() Получает ограничение по времени этих SearchControls в миллисекундах.
void	setCountLimit(long limit) Устанавливает максимальное количество записей, которые будут возвращены в результате поиска.
void	setDerefLinkFlag(boolean on) Позволяет/отключает разыменованию ссылки во время поиска.
void	setReturningAttributes(String[] attrs) Определяет атрибуты, которые будут возвращены как часть поиска.
void	setReturningObjFlag(boolean on) Позволяет/отключает возвратить объекты, возвращенные как часть результата.
void	setSearchScope(int scope) Устанавливает контекст поиска в один из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
void	setTimeLimit(int ms) Устанавливает ограничение по времени этих SearchControls в миллисекундах.

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

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

Полевая Деталь

OBJECT_SCOPE

public static final int OBJECT_SCOPE

Ищите именованный объект.

NamingEnumeration, который следует из поиска () использующий OBJECT_SCOPE, будет содержать элемент единицы или нули. Перечисление содержит один элемент, если именованный объект удовлетворяет фильтр поиска, определенный в поиске (). Элемент будет иметь как его имя пустая строка, потому что имена элементов в NamingEnumeration относительно целевого контекста - в этом случае, целевой контекст является именованным объектом. Это содержит нулевой элемент, если именованный объект не удовлетворяет фильтр поиска, определенный в поиске ().

Значением этой константы является 0.

См. Также:

Постоянные Значения полей

ONELEVEL_SCOPE

public static final int ONELEVEL_SCOPE

Ищите один уровень именованного контекста.

NamingEnumeration, который следует из поиска () использующий ONELEVEL_SCOPE, содержит элементы с объектами в именованном контексте, которые удовлетворяют фильтр поиска, определенный в поиске (). Имена элементов в NamingEnumeration являются атомарными именами относительно именованного контекста.

Значением этой константы является 1.

См. Также:

Постоянные Значения полей

SUBTREE_SCOPE

public static final int SUBTREE_SCOPE

Ищите все поддерево базировалось в именованном объекте.

Если именованным объектом не является DirContext, поиск только объект. Если именованным объектом является DirContext, ищите, поддерево базировалось в именованном объекте, включая именованный объект непосредственно.

Поиск не будет пересекать системные границы именования.

NamingEnumeration, который следует из поиска () использующий SUBTREE_SCOPE, содержит элементы объектов от поддерева (включая именованный контекст), которые удовлетворяют фильтр поиска, определенный в поиске (). Имена элементов в NamingEnumeration или относительно именованного контекста, или строка URL. Если именованный контекст удовлетворяет фильтр поиска, он включается в перечисление с пустой строкой как ее имя.

Значением этой константы является 2.

См. Также:

Постоянные Значения полей

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

SearchControls

public SearchControls()

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

Значения по умолчанию:

• ищите один уровень
• никакой максимальный возврат не ограничивает для результатов поиска
• никакое ограничение по времени для поиска
• возвратите все атрибуты, связанные с объектами, которые удовлетворяют фильтр поиска.
• не возвращайтесь названный объект (возвратите только имя и class),
• не разыменовывайте ссылки во время поиска

SearchControls

public SearchControls(int scope,
                      long countlim,
                      int timelim,
                      String[] attrs,
                      boolean retobj,
                      boolean deref)

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

Параметры:

scope - Контекст поиска. Один из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

timelim - Число миллисекунд, чтобы ожидать перед возвратом. Если 0, ожидайте неопределенно.

deref - Если это правда, разыменуйте ссылки во время поиска.

countlim - Максимальное количество записей в возврат. Если 0, возвратите все записи, которые удовлетворяют фильтр.

retobj - Если это правда, возвратите объект, связанный с именем записи; если ложь, не возвращайте объект.

attrs - Идентификаторы атрибутов, чтобы возвратиться наряду с записью. Если ноль, возвратите все атрибуты. Если пустой возврат никакие атрибуты.

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

getSearchScope

public int getSearchScope()

Получает контекст поиска этих SearchControls.

Один из OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Возвраты:

Контекст поиска этого SearchControls.

См. Также:

setSearchScope(int)

getTimeLimit

public int getTimeLimit()

Получает ограничение по времени этих SearchControls в миллисекундах.

Если значение 0, это означает ожидать неопределенно.

Возвраты:

Ограничение по времени этих SearchControls в миллисекундах.

См. Также:

setTimeLimit(int)

getDerefLinkFlag

public boolean getDerefLinkFlag()

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

Возвраты:

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

См. Также:

setDerefLinkFlag(boolean)

getReturningObjFlag

public boolean getReturningObjFlag()

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

Возвраты:

истина, если объекты будут возвращены; ложь иначе.

См. Также:

setReturningObjFlag(boolean)

getCountLimit

public long getCountLimit()

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

0 указывает, что все записи будут возвращены.

Возвраты:

Максимальное количество записей, которые будут возвращены.

См. Также:

setCountLimit(long)

getReturningAttributes

public String[] getReturningAttributes()

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

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

Возвраты:

Массив идентификаторов атрибута, идентифицирующих атрибуты, которые будут возвращены. Может быть нуль.

См. Также:

setReturningAttributes(java.lang.String[])

setSearchScope

public void setSearchScope(int scope)

Устанавливает контекст поиска в один из: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

Параметры:

scope - Контекст поиска этого SearchControls.

См. Также:

getSearchScope()

setTimeLimit

public void setTimeLimit(int ms)

Устанавливает ограничение по времени этих SearchControls в миллисекундах.

Если значение 0, это означает ожидать неопределенно.

Параметры:

ms - Ограничение по времени этих SearchControls в миллисекундах.

См. Также:

getTimeLimit()

setDerefLinkFlag

public void setDerefLinkFlag(boolean on)

Позволяет/отключает разыменованию ссылки во время поиска.

Параметры:

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

См. Также:

getDerefLinkFlag()

setReturningObjFlag

public void setReturningObjFlag(boolean on)

Позволяет/отключает возвратить объекты, возвращенные как часть результата.

Если отключено, только имя и class объекта возвращаются. Если включено, объект будет возвращен.

Параметры:

on - если это правда, объекты будут возвращены; если ложь, объекты не будут возвращены.

См. Также:

getReturningObjFlag()

setCountLimit

public void setCountLimit(long limit)

Устанавливает максимальное количество записей, которые будут возвращены в результате поиска.

0 не указывает ни на какой предел: все записи будут возвращены.

Параметры:

limit - Максимальное количество записей, которые будут возвращены.

См. Также:

getCountLimit()

setReturningAttributes

public void setReturningAttributes(String[] attrs)

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

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

Параметры:

attrs - Массив идентификаторов атрибута, идентифицирующих атрибуты, которые будут возвращены. Может быть нуль.

См. Также:

getReturningAttributes()