Spec-Zone .ru
спецификации, руководства, описания, API
|
|
Spec-Zone .ru
спецификации, руководства, описания, API
|
public class SearchControls extends Object implements Serializable
Экземпляр SearchControls не синхронизируется против параллельного многопоточного доступа. Многократные потоки, пытающиеся получить доступ и изменить единственный экземпляр SearchControls, должны заблокировать объект.
| Модификатор и Тип | Поле и Описание |
|---|---|
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 в миллисекундах.
|
public static final int OBJECT_SCOPE
NamingEnumeration, который следует из поиска () использующий OBJECT_SCOPE, будет содержать элемент единицы или нули. Перечисление содержит один элемент, если именованный объект удовлетворяет поисковый фильтр, определенный в поиске (). Элемент будет иметь как его имя пустая строка, потому что имена элементов в NamingEnumeration относительно целевого контекста - в этом случае, целевой контекст является именованным объектом. Это содержит нулевой элемент, если именованный объект не удовлетворяет поисковый фильтр, определенный в поиске ().
Значением этой константы является 0.
public static final int ONELEVEL_SCOPE
NamingEnumeration, который следует из поиска () использующий ONELEVEL_SCOPE, содержит элементы с объектами в именованном контексте, которые удовлетворяют поисковый фильтр, определенный в поиске (). Имена элементов в NamingEnumeration являются атомарными именами относительно именованного контекста.
Значением этой константы является 1.
public static final int SUBTREE_SCOPE
Если именованным объектом не является DirContext, поиск только объект. Если именованным объектом является DirContext, ищите, поддерево базировалось в именованном объекте, включая именованный объект непосредственно.
Поиск не будет пересекать системные границы именования.
NamingEnumeration, который следует из поиска () использующий SUBTREE_SCOPE, содержит элементы объектов от поддерева (включая именованный контекст), которые удовлетворяют поисковый фильтр, определенный в поиске (). Имена элементов в NamingEnumeration или относительно именованного контекста, или строка URL. Если именованный контекст удовлетворяет поисковый фильтр, он включается в перечисление с пустой строкой как ее имя.
Значением этой константы является 2.
public 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 - Идентификаторы атрибутов, чтобы возвратиться наряду с записью. Если ноль, возвратите все атрибуты. Если пустой возврат никакие атрибуты.public int getSearchScope()
Один из OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.
setSearchScope(int)public int getTimeLimit()
Если значение 0, это означает ожидать неопределенно.
setTimeLimit(int)public boolean getDerefLinkFlag()
setDerefLinkFlag(boolean)public boolean getReturningObjFlag()
setReturningObjFlag(boolean)public long getCountLimit()
0 указывает, что все записи будут возвращены.
setCountLimit(long)public String[] getReturningAttributes()
Значение нуля указывает, что все атрибуты будут возвращены. Пустой массив указывает, что никакие атрибуты не должны быть возвращены.
setReturningAttributes(java.lang.String[])public void setSearchScope(int scope)
scope - Поисковый контекст этого SearchControls.getSearchScope()public void setTimeLimit(int ms)
Если значение 0, это означает ожидать неопределенно.
ms - Ограничение по времени этих SearchControls в миллисекундах.getTimeLimit()public void setDerefLinkFlag(boolean on)
on - если истинные ссылки будут разыменованы; если ложь, не сопровождаемая.getDerefLinkFlag()public void setReturningObjFlag(boolean on)
Если отключено, только имя и класс объекта возвращаются. Если включено, объект будет возвращен.
on - если это правда, объекты будут возвращены; если ложь, объекты не будут возвращены.getReturningObjFlag()public void setCountLimit(long limit)
0 не указывает ни на какой предел: все записи будут возвращены.
limit - Максимальное количество записей, которые будут возвращены.getCountLimit()public void setReturningAttributes(String[] attrs)
нуль указывает, что все атрибуты будут возвращены. Пустой массив указывает, что никакие атрибуты не возвращаются.
attrs - Массив идентификаторов атрибута, идентифицирующих атрибуты, которые будут возвращены. Может быть нуль.getReturningAttributes()
Для дальнейшей ссылки API и документации разработчика, см. . Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.