org.apache.solr.search

Interface DocIterator

All Superinterfaces:

java.util.Iterator<java.lang.Integer>

public interface DocIterator
extends java.util.Iterator<java.lang.Integer>

Simple Iterator of document Ids which may include score information.

The order of the documents is determined by the context in which the DocIterator instance was retrieved.

Version:

$Id: DocIterator.java 555343 2007-07-11 17:46:25Z hossman $

Method Summary

Modifier and Type	Method and Description
int	nextDoc() Returns the next document id if hasNext()==true This method is equivalent to next(), but avoids the creation of an Integer Object.
float	score() Returns the score for the document just returned by nextDoc()

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Detail

nextDoc

int nextDoc()

Returns the next document id if hasNext()==true This method is equivalent to next(), but avoids the creation of an Integer Object.

See Also:

Iterator.next()

score

float score()

Returns the score for the document just returned by nextDoc()

The value returned may be meaningless depending on the context in which the DocIterator instance was retrieved.