org.apache.lucene.search

Class DisjunctionScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.DisjunctionScorer

Direct Known Subclasses:

DisjunctionMaxScorer, DisjunctionSumScorer, SynonymQuery.SynonymScorer

abstract class DisjunctionScorer
extends Scorer

Base class for Scorers that score disjunctions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DisjunctionScorer.TwoPhase

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

Scorer.ChildScorer

Field Summary

Fields

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

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

weight

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DisjunctionScorer(Weight weight, java.util.List<Scorer> subScorers, boolean needsScores)

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
(package private) DisiWrapper	getSubMatches()
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
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

getWeight

Methods inherited from class java.lang.Object

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

Field Detail

needsScores

private final boolean needsScores

subScorers

private final DisiPriorityQueue subScorers

approximation

private final DisjunctionDISIApproximation approximation

twoPhase

private final DisjunctionScorer.TwoPhase twoPhase

Constructor Detail

DisjunctionScorer

protected DisjunctionScorer(Weight weight,
                            java.util.List<Scorer> subScorers,
                            boolean needsScores)

Method Detail

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

getSubMatches

DisiWrapper getSubMatches()
                   throws java.io.IOException

Throws:

java.io.IOException

freq

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

score

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

score

protected abstract float score(DisiWrapper topList)
                        throws java.io.IOException

Compute the score for the given linked list of scorers.

Throws:

java.io.IOException

getChildren

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

Description copied from class: Scorer

Returns child sub-scorers

Overrides:

getChildren in class Scorer