Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class ToParentBlockJoinQuery.ParentTwoPhase

java.lang.Object

org.apache.lucene.search.TwoPhaseIterator

org.apache.lucene.search.join.ToParentBlockJoinQuery.ParentTwoPhase

Enclosing class:

ToParentBlockJoinQuery

private static class ToParentBlockJoinQuery.ParentTwoPhase
extends TwoPhaseIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final DocIdSetIterator	childApproximation
private final TwoPhaseIterator	childTwoPhase
private final ToParentBlockJoinQuery.ParentApproximation	parentApproximation

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

approximation

Constructor Summary

Constructors

Constructor	Description
ParentTwoPhase(ToParentBlockJoinQuery.ParentApproximation parentApproximation, TwoPhaseIterator childTwoPhase)

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

parentApproximation

private final ToParentBlockJoinQuery.ParentApproximation parentApproximation

childApproximation

private final DocIdSetIterator childApproximation

childTwoPhase

private final TwoPhaseIterator childTwoPhase

Constructor Details

ParentTwoPhase

ParentTwoPhase(ToParentBlockJoinQuery.ParentApproximation parentApproximation,
 TwoPhaseIterator childTwoPhase)

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