Module org.apache.lucene.sandbox

Package org.apache.lucene.sandbox.search

Class CoveringScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.sandbox.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.Scorable

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
private final DocIdSetIterator	approximation
(package private) final long	cost
(package private) int	doc
(package private) int	freq
(package private) boolean	matches
(package private) final int	maxDoc
(package private) long	minMatch
(package private) final LongValues	minMatchValues
(package private) final int	numScorers
(package private) final DisiPriorityQueue	subScorers
(package private) DisiWrapper	topList
private final TwoPhaseIterator	twoPhase

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

weight

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private void	advanceAll(int target)
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
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.
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

advanceShallow, 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

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 Details

CoveringScorer

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

Method Details

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

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 IOException

Throws:

IOException

setTopListAndFreq

private void setTopListAndFreq()

setTopListAndFreqIfNecessary

private void setTopListAndFreqIfNecessary()
                                   throws IOException

Throws:

IOException

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

docID

public int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable