org.apache.lucene.search

Class TwoPhaseDocIdSetIterator

java.lang.Object

org.apache.lucene.search.TwoPhaseDocIdSetIterator

public abstract class TwoPhaseDocIdSetIterator
extends Object

An approximation of a DocIdSetIterator. When the approximation()'s DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) return, matches() needs to be checked in order to know whether the returned doc ID actually matches.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
TwoPhaseDocIdSetIterator()

Method Summary

Methods

Modifier and Type	Method and Description
abstract DocIdSetIterator	approximation() Return an approximation.
static DocIdSetIterator	asDocIdSetIterator(TwoPhaseDocIdSetIterator twoPhaseIterator) Return a DocIdSetIterator view of the provided TwoPhaseDocIdSetIterator.
abstract boolean	matches() Return whether the current doc ID that the iterator is on matches.

Methods inherited from class java.lang.Object

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

Constructor Detail

TwoPhaseDocIdSetIterator

public TwoPhaseDocIdSetIterator()

Method Detail

asDocIdSetIterator

public static DocIdSetIterator asDocIdSetIterator(TwoPhaseDocIdSetIterator twoPhaseIterator)

Return a DocIdSetIterator view of the provided TwoPhaseDocIdSetIterator.

approximation

public abstract DocIdSetIterator approximation()

Return an approximation. The returned DocIdSetIterator is a superset of the matching documents, and each match needs to be confirmed with matches() in order to know whether it matches or not.

matches

public abstract boolean matches()
                         throws IOException

Return whether the current doc ID that the iterator is on matches. This method should only be called when the iterator is positionned -- ie. not when DocIdSetIterator.docID() is -1 or DocIdSetIterator.NO_MORE_DOCS -- and at most once.

Throws:

IOException