File	Doc	Category	Size	Date	Package
Scorer.java	API Doc	Apache Lucene 2.1.0	4268	Wed Feb 14 10:46:40 GMT 2007	org.apache.lucene.search

Scorer

• java.lang.Object

Fields Summary
private Similarity	similarity

Constructors Summary
protected Scorer(Similarity similarity) Constructs a Scorer. param similarity The Similarity implementation used by this scorer. this.similarity = similarity;

Methods Summary
public abstract int	doc() Returns the current document number matching the query. Initially invalid, until {@link #next()} is called the first time.
public abstract org.apache.lucene.search.Explanation	explain(int doc) Returns an explanation of the score for a document. When this method is used, the {@link #next()}, {@link #skipTo(int)} and {@link #score(HitCollector)} methods should not be used. param doc The document number for the explanation.
public org.apache.lucene.search.Similarity	getSimilarity() Returns the Similarity implementation used by this scorer. return this.similarity;
public abstract boolean	next() Advances to the next document matching the query. return true iff there is another document matching the query. When this method is used the {@link #explain(int)} method should not be used.
public void	score(org.apache.lucene.search.HitCollector hc) Scores and collects all matching documents. param hc The collector to which all matching documents are passed through {@link HitCollector#collect(int, float)}. When this method is used the {@link #explain(int)} method should not be used. while (next()) { hc.collect(doc(), score()); }
protected boolean	score(org.apache.lucene.search.HitCollector hc, int max) Expert: Collects matching documents in a range. Hook for optimization. Note that {@link #next()} must be called once before this method is called for the first time. param hc The collector to which all matching documents are passed through {@link HitCollector#collect(int, float)}. param max Do not score documents past this. return true if more matching documents may remain. while (doc() < max) { hc.collect(doc(), score()); if (!next()) return false; } return true;
public abstract float	score() Returns the score of the current document matching the query. Initially invalid, until {@link #next()} or {@link #skipTo(int)} is called the first time.
public abstract boolean	skipTo(int target) Skips to the first match beyond the current whose document number is greater than or equal to a given target. When this method is used the {@link #explain(int)} method should not be used. param target The target document number. return true iff there is such a match. Behaves as if written: boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; } Most implementations are considerably more efficient than that.