public class SearchIndex extends XMLRequest implements java.lang.Iterable<SearchIndex.Result>
Modifier and Type | Class and Description |
---|---|
static class |
SearchIndex.Result
This class represents one result of a index based search.
|
Constructor and Description |
---|
SearchIndex(java.lang.String luceneQueryString)
Creates a new
SearchIndex request. |
Modifier and Type | Method and Description |
---|---|
int |
getTotalHits()
Returns the total number of hits.
|
void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
java.util.Iterator<SearchIndex.Result> |
iterator() |
void |
setMaxResults(int maxResults)
Sets count of max results.
|
int |
size()
Returns the number of results that are returned using the iterator() method.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public SearchIndex(java.lang.String luceneQueryString)
SearchIndex
request.
The parameter luceneQueryString
is an Apache Lucene Query string.
The syntax is described here: http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
Available fields are:
luceneQueryString
- the search is of type Stringpublic void setMaxResults(int maxResults)
maxResults
- Maximum number of returned resultspublic void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
public java.util.Iterator<SearchIndex.Result> iterator()
iterator
in interface java.lang.Iterable<SearchIndex.Result>
public int getTotalHits()
public int size()