Module org.apache.lucene.join

Package org.apache.lucene.search.join

Class ToParentBlockJoinQuery.BlockJoinScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

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

Enclosing class:

ToParentBlockJoinQuery

static class ToParentBlockJoinQuery.BlockJoinScorer
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 final DocIdSetIterator	childApproximation
private final Scorer	childScorer
private final TwoPhaseIterator	childTwoPhase
private final ToParentBlockJoinQuery.ParentApproximation	parentApproximation
private final BitSet	parentBits
private final ToParentBlockJoinQuery.ParentTwoPhase	parentTwoPhase
private float	score
private final ScoreMode	scoreMode

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

weight

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	docID()	Returns the doc ID that is currently being scored.
Explanation	explain(LeafReaderContext context, Weight childWeight, ScoreMode scoreMode)
private String	formatScoreExplanation(int matches, int start, int end, ScoreMode scoreMode)
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.
DocIdSetIterator	iterator()	Return a DocIdSetIterator over matching documents.
float	score()	Returns the score of the current document matching the query.
void	setMinCompetitiveScore(float minScore)	Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the given minScore.
private void	setScoreAndFreq()
TwoPhaseIterator	twoPhaseIterator()	Optional method: Return a TwoPhaseIterator view of this Scorer.

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

advanceShallow, getWeight

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

smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

childScorer

private final Scorer childScorer

parentBits

private final BitSet parentBits

scoreMode

private final ScoreMode scoreMode

childApproximation

private final DocIdSetIterator childApproximation

childTwoPhase

private final TwoPhaseIterator childTwoPhase

parentApproximation

private final ToParentBlockJoinQuery.ParentApproximation parentApproximation

parentTwoPhase

private final ToParentBlockJoinQuery.ParentTwoPhase parentTwoPhase

score

private float score

Constructor Details

BlockJoinScorer

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

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

twoPhaseIterator

public TwoPhaseIterator twoPhaseIterator()

Description copied from class: Scorer

Optional method: Return a TwoPhaseIterator view of this Scorer. A return value of null indicates that two-phase iteration is not supported.

Note that the returned TwoPhaseIterator's approximation must advance synchronously with the Scorer.iterator(): advancing the approximation must advance the iterator and vice-versa.

Implementing this method is typically useful on Scorers that have a high per-document overhead in order to confirm matches.

The default implementation returns null.

Overrides:

twoPhaseIterator in class Scorer

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

setMinCompetitiveScore

public void setMinCompetitiveScore(float minScore)
                            throws IOException

Description copied from class: Scorable

Optional method: Tell the scorer that its iterator may safely ignore all documents whose score is less than the given minScore. This is a no-op by default.

This method may only be called from collectors that use ScoreMode.TOP_SCORES, and successive calls may only set increasing values of minScore.

Overrides:

setMinCompetitiveScore in class Scorable

Throws:

IOException

setScoreAndFreq

private void setScoreAndFreq()
                      throws IOException

Throws:

IOException

explain

public Explanation explain(LeafReaderContext context,
 Weight childWeight,
 ScoreMode scoreMode)
                    throws IOException

Throws:

IOException

formatScoreExplanation

private String formatScoreExplanation(int matches,
 int start,
 int end,
 ScoreMode scoreMode)