org.apache.lucene.search

Class BM25FQuery.BM25FScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.search.BM25FQuery.BM25FScorer

Enclosing class:

BM25FQuery

private static class BM25FQuery.BM25FScorer
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 and Description
private DocIdSetIterator	iterator
private DisiPriorityQueue	queue
private MultiNormsLeafSimScorer	simScorer

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

weight

Constructor Summary

Constructors

Constructor and Description
BM25FScorer(Weight weight, DisiPriorityQueue queue, DocIdSetIterator iterator, MultiNormsLeafSimScorer simScorer)

Method Summary

Modifier and Type	Method and Description
int	docID() Returns the doc ID that is currently being scored.
(package private) float	freq()
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.

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

advanceShallow, getWeight, twoPhaseIterator

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

getChildren, setMinCompetitiveScore

Methods inherited from class java.lang.Object

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

Field Detail

queue

private final DisiPriorityQueue queue

iterator

private final DocIdSetIterator iterator

simScorer

private final MultiNormsLeafSimScorer simScorer

Constructor Detail

BM25FScorer

BM25FScorer(Weight weight,
            DisiPriorityQueue queue,
            DocIdSetIterator iterator,
            MultiNormsLeafSimScorer simScorer)

Method Detail

docID

public int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

freq

float freq()
    throws java.io.IOException

Throws:

java.io.IOException

score

public float score()
            throws java.io.IOException

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable

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

getMaxScore

public float getMaxScore(int upTo)
                  throws java.io.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:

java.io.IOException