Module org.apache.lucene.core

Package org.apache.lucene.search

Class ConjunctionDISI.ConjunctionTwoPhaseIterator

java.lang.Object

org.apache.lucene.search.TwoPhaseIterator

org.apache.lucene.search.ConjunctionDISI.ConjunctionTwoPhaseIterator

Enclosing class:

ConjunctionDISI

private static final class ConjunctionDISI.ConjunctionTwoPhaseIterator
extends TwoPhaseIterator

TwoPhaseIterator implementing a conjunction.

Field Summary

Fields

Modifier and Type	Field	Description
private final float	matchCost
private final TwoPhaseIterator[]	twoPhaseIterators

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

approximation

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ConjunctionTwoPhaseIterator(DocIdSetIterator approximation, List<? extends TwoPhaseIterator> twoPhaseIterators)

Method Summary

Modifier and Type	Method	Description
float	matchCost()	An estimate of the expected cost to determine that a single document TwoPhaseIterator.matches().
boolean	matches()	Return whether the current doc ID that TwoPhaseIterator.approximation() is on matches.

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

approximation, asDocIdSetIterator, unwrap

Methods inherited from class java.lang.Object

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

Field Details

twoPhaseIterators

private final TwoPhaseIterator[] twoPhaseIterators

matchCost

private final float matchCost

Constructor Details

ConjunctionTwoPhaseIterator

private ConjunctionTwoPhaseIterator(DocIdSetIterator approximation,
 List<? extends TwoPhaseIterator> twoPhaseIterators)

Method Details

matches

public boolean matches()
                throws IOException

Description copied from class: TwoPhaseIterator

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

Specified by:

matches in class TwoPhaseIterator

Throws:

IOException

matchCost

public float matchCost()

Description copied from class: TwoPhaseIterator

An estimate of the expected cost to determine that a single document TwoPhaseIterator.matches(). This can be called before iterating the documents of TwoPhaseIterator.approximation(). Returns an expected cost in number of simple operations like addition, multiplication, comparing two numbers and indexing an array. The returned value must be positive.

Specified by:

matchCost in class TwoPhaseIterator