|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.apelon.dts.client.term.TermSearchOptions
public class TermSearchOptions
The term search options pass information to be used in a search, other
than the actual search pattern. This includes the search limit, the namespace
to search in, and optionally the TermAttributeSetDescriptor
used to
specify the attributes returned with the search result terms.
Copyright: Copyright (c) 2003
Company: Apelon, Inc.
Field Summary | |
---|---|
static int |
ALL_NAMESPACES
Indicates that all namespaces are to be searched. |
static int |
DEFAULT_LIMIT
Indicates MAXIMUM_LIMIT limit
on the number of matches returned as default. |
static int |
MAXIMUM_LIMIT
Indicates maximum number of matches that can be returned. |
Constructor Summary | |
---|---|
TermSearchOptions()
The default constructor. |
|
TermSearchOptions(int searchLimit,
int namespaceId)
Convenience constructor for setting the most popular options. |
|
TermSearchOptions(int searchLimit,
int namespaceId,
TermAttributeSetDescriptor asd)
Convenience constructor for setting all options at once. |
Method Summary | |
---|---|
TermAttributeSetDescriptor |
getAttributeSetDescriptor()
Gets the TermAttributeSetDescriptor to be used to set the amount
of information retrieved with the terms returned by a search. |
int |
getLimit()
Gets the maximum number of DTS search results that should be returned from a search. |
int |
getNamespaceId()
Gets the ID of the namespace to search in. |
void |
setAttributeSetDescriptor(TermAttributeSetDescriptor asd)
Sets the TermAttributeSetDescriptor to be used to set the amount
of information retrieved with the terms returned by a search. |
void |
setLimit(int limit)
Sets the maximum number of DTS search results that should be returned from a search. |
void |
setNamespaceId(int namespaceId)
Sets the ID of the namespace to search in. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ALL_NAMESPACES
public static final int MAXIMUM_LIMIT
Integer.MAX_VALUE
,
Constant Field Valuespublic static final int DEFAULT_LIMIT
MAXIMUM_LIMIT
limit
on the number of matches returned as default.
Constructor Detail |
---|
public TermSearchOptions()
public TermSearchOptions(int searchLimit, int namespaceId, TermAttributeSetDescriptor asd)
searchLimit
- limit on search resultsnamespaceId
- Namespace
ID to search inasd
- the TermAttributeSetDescriptor
describing the desired attributes to be
retrieved with the search result termspublic TermSearchOptions(int searchLimit, int namespaceId)
searchLimit
- limit on search resultsnamespaceId
- Namespace
ID to search inMethod Detail |
---|
public void setLimit(int limit)
limit
- the search limitpublic int getLimit()
public void setNamespaceId(int namespaceId)
ALL_NAMESPACES
to
search all namespaces.
namespaceId
- Namespace
ID to search inpublic int getNamespaceId()
ALL_NAMESPACES
indicates all namespaces are to be searched.
ALL_NAMESPACES
.public void setAttributeSetDescriptor(TermAttributeSetDescriptor asd)
TermAttributeSetDescriptor
to be used to set the amount
of information retrieved with the terms returned by a search.
asd
- the TermAttributeSetDescriptor describing the
desired attributes to be retrievedpublic TermAttributeSetDescriptor getAttributeSetDescriptor()
TermAttributeSetDescriptor
to be used to set the amount
of information retrieved with the terms returned by a search.
TermAttributeSetDescriptor
to be used to be used
in retrieving the search result terms.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |