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 and Description
private DocIdSetIterator	childApproximation
private TwoPhaseIterator	childTwoPhase
private ToParentBlockJoinQuery.ParentApproximation	parentApproximation

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

approximation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 Detail

parentApproximation

private final ToParentBlockJoinQuery.ParentApproximation parentApproximation

childApproximation

private final DocIdSetIterator childApproximation

childTwoPhase

private final TwoPhaseIterator childTwoPhase

Constructor Detail

ParentTwoPhase

ParentTwoPhase(ToParentBlockJoinQuery.ParentApproximation parentApproximation,
               TwoPhaseIterator childTwoPhase)

Method Detail

matches

public boolean matches()
                throws java.io.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:

java.io.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