org.apache.lucene.search.join

Class ToParentBlockJoinQuery.BlockJoinScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.join.ToParentBlockJoinQuery.ChildrenMatchesScorer

org.apache.lucene.search.join.ToParentBlockJoinQuery.BlockJoinScorer

Enclosing class:

ToParentBlockJoinQuery

static class ToParentBlockJoinQuery.BlockJoinScorer
extends ToParentBlockJoinQuery.ChildrenMatchesScorer

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	childDocUpto
private Scorer	childScorer
private int	nextChildDoc
private BitSet	parentBits
private int	parentDoc
private int	parentFreq
private float	parentScore
private int[]	pendingChildDocs
private float[]	pendingChildScores
private int	prevParentDoc
private ScoreMode	scoreMode

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

weight

Constructor Summary

Constructors

Constructor and Description
BlockJoinScorer(Weight weight, Scorer childScorer, BitSet parentBits, int firstChildDoc, ScoreMode scoreMode)

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
Explanation	explain(LeafReaderContext context, Weight childWeight)
int	freq() Returns the freq of this Scorer on the current document
int	getChildCount() reports matched children
java.util.Collection<Scorer.ChildScorer>	getChildren() Returns child sub-scorers
(package private) int	getParentDoc()
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
float	score() Returns the score of the current document matching the query.
int[]	swapChildDocs(int[] other) reports matched children
(package private) float[]	swapChildScores(float[] other)
void	trackPendingChildHits() Instructs this scorer to keep track of the child docIds and score ids for retrieval purposes.

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

childScorer

private final Scorer childScorer

parentBits

private final BitSet parentBits

scoreMode

private final ScoreMode scoreMode

parentDoc

private int parentDoc

prevParentDoc

private int prevParentDoc

parentScore

private float parentScore

parentFreq

private int parentFreq

nextChildDoc

private int nextChildDoc

pendingChildDocs

private int[] pendingChildDocs

pendingChildScores

private float[] pendingChildScores

childDocUpto

private int childDocUpto

Constructor Detail

BlockJoinScorer

public BlockJoinScorer(Weight weight,
                       Scorer childScorer,
                       BitSet parentBits,
                       int firstChildDoc,
                       ScoreMode scoreMode)

Method Detail

getChildren

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

Description copied from class: Scorer

Returns child sub-scorers

Overrides:

getChildren in class Scorer

getChildCount

public int getChildCount()

Description copied from class: ToParentBlockJoinQuery.ChildrenMatchesScorer

reports matched children

Specified by:

getChildCount in class ToParentBlockJoinQuery.ChildrenMatchesScorer

Returns:

number of recorded matched children docs

getParentDoc

int getParentDoc()

swapChildDocs

public int[] swapChildDocs(int[] other)

Description copied from class: ToParentBlockJoinQuery.ChildrenMatchesScorer

reports matched children

Specified by:

swapChildDocs in class ToParentBlockJoinQuery.ChildrenMatchesScorer

Parameters:

other - array for recording matching children docs of next parent, it might be null (that's slower) or the same array which was returned from the previous call

Returns:

array with ToParentBlockJoinQuery.ChildrenMatchesScorer.getChildCount() matched children docnums

swapChildScores

float[] swapChildScores(float[] other)

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

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()

Description copied from class: Scorer

Returns the freq of this Scorer on the current document

Specified by:

freq in class Scorer

explain

public Explanation explain(LeafReaderContext context,
                           Weight childWeight)
                    throws java.io.IOException

Throws:

java.io.IOException

trackPendingChildHits

public void trackPendingChildHits()

Instructs this scorer to keep track of the child docIds and score ids for retrieval purposes.

Specified by:

trackPendingChildHits in class ToParentBlockJoinQuery.ChildrenMatchesScorer