org.apache.lucene.search

Class TermScorer

java.lang.Object

org.apache.lucene.search.Scorer

org.apache.lucene.search.TermScorer

final class TermScorer
extends Scorer

Expert: A Scorer for documents matching a Term.

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 Similarity.SimScorer	docScorer
private PostingsEnum	postingsEnum

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

weight

Constructor Summary

Constructors

Constructor and Description
TermScorer(Weight weight, PostingsEnum td, Similarity.SimScorer docScorer) Construct a TermScorer.

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
DocIdSetIterator	iterator() Return a DocIdSetIterator over matching documents.
float	score() Returns the score of the current document matching the query.
java.lang.String	toString() Returns a string representation of this TermScorer.

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

getChildren, getWeight, twoPhaseIterator

Methods inherited from class java.lang.Object

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

Field Detail

postingsEnum

private final PostingsEnum postingsEnum

docScorer

private final Similarity.SimScorer docScorer

Constructor Detail

TermScorer

TermScorer(Weight weight,
           PostingsEnum td,
           Similarity.SimScorer docScorer)

Construct a TermScorer.

Parameters:

weight - The weight of the Term in the query.

td - An iterator over the documents matching the Term.

docScorer - The Similarity.SimScorer implementation to be used for score computations.

Method Detail

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

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

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

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

toString

public java.lang.String toString()

Returns a string representation of this TermScorer.

Overrides:

toString in class java.lang.Object