public class SearchIndex extends XMLRequest implements 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(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) |
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, showQuarantineNotification
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public SearchIndex(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 Iterator<SearchIndex.Result> iterator()
iterator
in interface Iterable<SearchIndex.Result>
public int getTotalHits()
public int size()
Copyright © 2021. All rights reserved.