org.apache.lucene.search.join

Class ToChildBlockJoinQuery.ToChildBlockJoinScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.join.ToChildBlockJoinQuery.ToChildBlockJoinScorer

Enclosing class:

ToChildBlockJoinQuery

static class ToChildBlockJoinQuery.ToChildBlockJoinScorer
extends Scorer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer

Scorer.ChildScorer

Field Summary

Fields

Modifier and Type	Field and Description
private int	childDoc
private boolean	doScores
private BitSet	parentBits
private int	parentDoc
private int	parentFreq
private DocIdSetIterator	parentIt
private float	parentScore
private Scorer	parentScorer

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

weight

Constructor Summary

Constructors

Constructor and Description
ToChildBlockJoinScorer(Weight weight, Scorer parentScorer, BitSet parentBits, boolean doScores)

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
int	freq() Returns the freq of this Scorer on the current document
java.util.Collection<Scorer.ChildScorer>	getChildren() Returns child sub-scorers positioned on the current document Note that this method should not be called on Scorers passed to LeafCollector.setScorer(Scorer), as these may be synthetic Scorers produced by BulkScorer which will throw an Exception.
(package private) int	getParentDoc()
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
float	score() Returns the score of the current document matching the query.
private void	validateParentDoc() Detect mis-use, where provided parent query in fact sometimes returns child documents.

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

getWeight, twoPhaseIterator

Methods inherited from class java.lang.Object

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

Field Detail

parentScorer

private final Scorer parentScorer

parentIt

private final DocIdSetIterator parentIt

parentBits

private final BitSet parentBits

doScores

private final boolean doScores

parentScore

private float parentScore

parentFreq

private int parentFreq

childDoc

private int childDoc

parentDoc

private int parentDoc

Constructor Detail

ToChildBlockJoinScorer

public ToChildBlockJoinScorer(Weight weight,
                              Scorer parentScorer,
                              BitSet parentBits,
                              boolean doScores)

Method Detail

getChildren

public java.util.Collection<Scorer.ChildScorer> getChildren()

Description copied from class: Scorer

Returns child sub-scorers positioned on the current document Note that this method should not be called on Scorers passed to LeafCollector.setScorer(Scorer), as these may be synthetic Scorers produced by BulkScorer which will throw an Exception.

Overrides:

getChildren in class Scorer

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

Return a DocIdSetIterator over matching documents. The returned iterator will either be positioned on -1 if no documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS if all documents have been scored already, or the last document id that has been scored otherwise. The returned iterator is a view: calling this method several times will return iterators that have the same state.

Specified by:

iterator in class Scorer

validateParentDoc

private void validateParentDoc()

Detect mis-use, where provided parent query in fact sometimes returns child documents.

docID

public int docID()

Description copied from class: Scorer

Returns the doc ID that is currently being scored. This will return -1 if the Scorer.iterator() is not positioned or DocIdSetIterator.NO_MORE_DOCS if it has been entirely consumed.

Specified by:

docID in class Scorer

See Also:

DocIdSetIterator.docID()

score

public float score()
            throws java.io.IOException

Description copied from class: Scorer

Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) is called on the Scorer.iterator() the first time, or when called from within LeafCollector.collect(int).

Specified by:

score in class Scorer

Throws:

java.io.IOException

freq

public int freq()
         throws java.io.IOException

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

Throws:

java.io.IOException

getParentDoc

int getParentDoc()