org.apache.lucene.search

Class CoveringScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.CoveringScorer

final class CoveringScorer
extends Scorer

A Scorer whose number of matches is per-document.

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 DocIdSetIterator	approximation
(package private) long	cost
(package private) int	doc
(package private) int	freq
(package private) boolean	matches
(package private) int	maxDoc
(package private) long	minMatch
(package private) LongValues	minMatchValues
(package private) int	numScorers
(package private) DisiPriorityQueue	subScorers
(package private) DisiWrapper	topList
private TwoPhaseIterator	twoPhase

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

weight

Constructor Summary

Constructors

Constructor and Description
CoveringScorer(Weight weight, java.util.Collection<Scorer> scorers, LongValues minMatchValues, int maxDoc)

Method Summary

Modifier and Type	Method and Description
private void	advanceAll(int target)
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 positioned on the current document Note that this method should not be called on Scorers passed to LeafCollector.setScorer(Scorer), as these may be synthetic Scorers produced by BulkScorer which will throw an Exception.
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
float	score() Returns the score of the current document matching the query.
private void	setTopListAndFreq()
private void	setTopListAndFreqIfNecessary()
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

numScorers

final int numScorers

maxDoc

final int maxDoc

minMatchValues

final LongValues minMatchValues

matches

boolean matches

doc

int doc

topList

DisiWrapper topList

freq

int freq

minMatch

long minMatch

subScorers

final DisiPriorityQueue subScorers

cost

final long cost

approximation

private final DocIdSetIterator approximation

twoPhase

private final TwoPhaseIterator twoPhase

Constructor Detail

CoveringScorer

CoveringScorer(Weight weight,
               java.util.Collection<Scorer> scorers,
               LongValues minMatchValues,
               int maxDoc)

Method Detail

getChildren

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

Description copied from class: Scorer

Returns child sub-scorers positioned on the current document Note that this method should not be called on Scorers passed to LeafCollector.setScorer(Scorer), as these may be synthetic Scorers produced by BulkScorer which will throw an Exception.

Overrides:

getChildren in class Scorer

Throws:

java.io.IOException

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

advanceAll

private void advanceAll(int target)
                 throws java.io.IOException

Throws:

java.io.IOException

setTopListAndFreq

private void setTopListAndFreq()

setTopListAndFreqIfNecessary

private void setTopListAndFreqIfNecessary()
                                   throws java.io.IOException

Throws:

java.io.IOException

freq

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

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