Module org.apache.lucene.core

Package org.apache.lucene.search

Class DisjunctionScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.search.DisjunctionScorer

Direct Known Subclasses:

DisjunctionMaxScorer, DisjunctionSumScorer

abstract class DisjunctionScorer
extends Scorer

Base class for Scorers that score disjunctions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	DisjunctionScorer.TwoPhase

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

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
private final DocIdSetIterator	approximation
private final boolean	needsScores
private final DisiPriorityQueue	subScorers
private final DisjunctionScorer.TwoPhase	twoPhase

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

weight

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DisjunctionScorer(Weight weight, List<Scorer> subScorers, ScoreMode scoreMode)

Method Summary

Modifier and Type	Method	Description
final int	docID()	Returns the doc ID that is currently being scored.
final Collection<Scorable.ChildScorable>	getChildren()	Returns child sub-scorers positioned on the current document
(package private) DisiWrapper	getSubMatches()
DocIdSetIterator	iterator()	Return a DocIdSetIterator over matching documents.
final float	score()	Returns the score of the current document matching the query.
protected abstract float	score(DisiWrapper topList)	Compute the score for the given linked list of scorers.
TwoPhaseIterator	twoPhaseIterator()	Optional method: Return a TwoPhaseIterator view of this Scorer.

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

advanceShallow, getMaxScore, getWeight

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

needsScores

private final boolean needsScores

subScorers

private final DisiPriorityQueue subScorers

approximation

private final DocIdSetIterator approximation

twoPhase

private final DisjunctionScorer.TwoPhase twoPhase

Constructor Details

DisjunctionScorer

protected DisjunctionScorer(Weight weight,
 List<Scorer> subScorers,
 ScoreMode scoreMode)
                     throws IOException

Throws:

IOException

Method Details

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 final int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

getSubMatches

DisiWrapper getSubMatches()
                   throws IOException

Throws:

IOException

score

public final 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

score

protected abstract float score(DisiWrapper topList)
                        throws IOException

Compute the score for the given linked list of scorers.

Throws:

IOException

getChildren

public final Collection<Scorable.ChildScorable> getChildren()
                                                     throws IOException

Description copied from class: Scorable

Returns child sub-scorers positioned on the current document

Overrides:

getChildren in class Scorable

Throws:

IOException