Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class ToChildBlockJoinQuery.ToChildBlockJoinScorer

java.lang.Object

org.apache.lucene.search.Scorable

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.Scorable

Scorable.ChildScorable

Field Summary

Fields

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

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

weight

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	docID()	Returns the doc ID that is currently being scored.
Collection<Scorable.ChildScorable>	getChildren()	Returns child sub-scorers positioned on the current document
float	getMaxScore(int upTo)	Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.
(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

advanceShallow, getWeight, twoPhaseIterator

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

setMinCompetitiveScore, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

parentScorer

private final Scorer parentScorer

parentIt

private final DocIdSetIterator parentIt

parentBits

private final BitSet parentBits

doScores

private final boolean doScores

parentScore

private float parentScore

childDoc

private int childDoc

parentDoc

private int parentDoc

Constructor Details

ToChildBlockJoinScorer

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

Method Details

getChildren

public Collection<Scorable.ChildScorable> getChildren()

Description copied from class: Scorable

Returns child sub-scorers positioned on the current document

Overrides:

getChildren in class Scorable

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: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

score

public float score()
            throws IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

Throws:

IOException

getMaxScore

public float getMaxScore(int upTo)
                  throws IOException

Description copied from class: Scorer

Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.

Specified by:

getMaxScore in class Scorer

Throws:

IOException

getParentDoc

int getParentDoc()