|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides an API for accessing the documents matching a search query in an efficient manner. It allows for retrieval of a 'page' of results & associated metadata such as the total number of results & the search duration.
Document
Method Summary | |
void |
close()
Releases any resources associated with this result set. |
long |
getCount()
Returns the total number of results in the set |
Iterator |
getDocuments(long offset,
long count)
Gets an iterator for the page of results between offset and offset+count |
String |
getEngine()
Return the query engine used to generate the result set |
long |
getQueryTime()
Return the elapsed time for generating this result set from the original query specification. |
Method Detail |
public Iterator getDocuments(long offset, long count)
offset
and offset+count
offset
- the first hit, starting from 0count
- the maximum number of results to return
java.lang.IllegalOperationException
- if close has been calledpublic void close()
public long getCount()
public long getQueryTime()
public String getEngine()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |