Package org.apache.lucene.facet.search
Interface ScoredDocIDsIterator
-
public interface ScoredDocIDsIterator
Iterator over document IDs and their scores. Eachnext()
retrieves the next docID and its score which can be later be retrieved bygetDocID()
andgetScore()
. NOTE: you must callnext()
beforegetDocID()
and/orgetScore()
, or otherwise the returned values are unexpected.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description static float
DEFAULT_SCORE
Default score used in case scoring is disabled.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getDocID()
Returns the ID of the current document.float
getScore()
Returns the score of the current document.boolean
next()
Iterate to the next document/score pair.
-
-
-
Field Detail
-
DEFAULT_SCORE
static final float DEFAULT_SCORE
Default score used in case scoring is disabled.- See Also:
- Constant Field Values
-
-