NetworkSearchResult Leave feedback
On this page
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Iterable
public abstract class NetworkSearchResult implements Iterable<NetworkFoundDocument>
Represents a search result matching a search query.
| Constructor | Description |
|---|---|
| NetworkSearchResult() |
| Method | Description |
|---|---|
| getDocumentCount() | Gets the number of documents found. |
| getOccurrenceCount() | Gets the total number of occurrences found. |
| getTruncated() | Gets a value indicating that the result is truncated. |
| getWarnings() | Gets a warnings describing the result. |
| getStartTime() | Gets the start time of the search. |
| getEndTime() | Gets the end time of the search. |
| getSearchDuration() | Gets the search duration in seconds. |
| getFoundDocument(int index) | Gets the found document by index. |
| iterator() | Returns an iterator that iterates through the collection of the documents found. |
| getNextChunkSearchToken() | Gets a chunk search token for searching the next chunk. |
| getNodeIndex() | Gets the index of the node from which the result was received. |
public NetworkSearchResult()
public abstract int getDocumentCount()
Gets the number of documents found.
Returns: int - The number of documents found.
public abstract int getOccurrenceCount()
Gets the total number of occurrences found.
Returns: int - The total number of occurrences found.
public abstract boolean getTruncated()
Gets a value indicating that the result is truncated.
Returns: boolean - A value indicating that the result is truncated.
public abstract String getWarnings()
Gets a warnings describing the result.
Returns: java.lang.String - A warnings describing the result.
public abstract Date getStartTime()
Gets the start time of the search.
Returns: java.util.Date - The start time of the search.
public abstract Date getEndTime()
Gets the end time of the search.
Returns: java.util.Date - The end time of the search.
public abstract double getSearchDuration()
Gets the search duration in seconds.
Returns: double - The search duration in seconds.
public abstract NetworkFoundDocument getFoundDocument(int index)
Gets the found document by index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The index of a found document. |
Returns: NetworkFoundDocument - The found document.
public abstract Iterator<NetworkFoundDocument> iterator()
Returns an iterator that iterates through the collection of the documents found.
Returns: java.util.Iterator<com.groupdocs.search.scaling.results.NetworkFoundDocument> - An iterator that can be used to iterate through the collection of the found documents.
public abstract NetworkSearchToken getNextChunkSearchToken()
Gets a chunk search token for searching the next chunk.
Returns: NetworkSearchToken - A chunk search token for searching the next chunk.
public abstract int getNodeIndex()
Gets the index of the node from which the result was received.
Returns: int - The index of the node from which the result was received.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.