org.apache.geode.cache.lucene

Interface PageableLuceneQueryResults<K,V>

Type Parameters:

K - The type of the key

V - The type of the value

All Superinterfaces:

java.util.Iterator<java.util.List<LuceneResultStruct<K,V>>>

@Experimental
public interface PageableLuceneQueryResults<K,V>
extends java.util.Iterator<java.util.List<LuceneResultStruct<K,V>>>

Defines the interface for a container of lucene query result collected from function execution.

Method Summary

Modifier and Type	Method and Description
float	getMaxScore() Returns the maximum score value encountered.
boolean	hasNext() True if there another page of results.
java.util.List<LuceneResultStruct<K,V>>	next() Get the next page of results.
int	size()

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Detail

size

int size()

Returns:

total number of hits for this query

getMaxScore

float getMaxScore()

Returns the maximum score value encountered. Note that in case scores are not tracked, this returns Float.NaN.

next

java.util.List<LuceneResultStruct<K,V>> next()

Get the next page of results.

Specified by:

next in interface java.util.Iterator<java.util.List<LuceneResultStruct<K,V>>>

Returns:

a page of results, or null if there are no more pages

hasNext

boolean hasNext()

True if there another page of results.

Specified by:

hasNext in interface java.util.Iterator<java.util.List<LuceneResultStruct<K,V>>>