org.apache.lucene.index

Class DocValuesIterator

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocValuesIterator

Direct Known Subclasses:

BinaryDocValues, DocValuesFieldUpdates.Iterator, NumericDocValues, ReadersAndUpdates.MergedDocValues, SortedNumericDocValues, SortedSetDocValues

abstract class DocValuesIterator
extends DocIdSetIterator

Field Summary

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
DocValuesIterator()

Method Summary

Modifier and Type	Method and Description
abstract boolean	advanceExact(int target) Advance the iterator to exactly target and return whether target has a value.

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

advance, all, cost, docID, empty, nextDoc, range, slowAdvance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocValuesIterator

DocValuesIterator()

Method Detail

advanceExact

public abstract boolean advanceExact(int target)
                              throws java.io.IOException

Advance the iterator to exactly target and return whether target has a value. target must be greater than or equal to the current doc ID and must be a valid doc ID, ie. ≥ 0 and < maxDoc. After this method returns, DocIdSetIterator.docID() retuns target.

Throws:

java.io.IOException