|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.search.Scorer
public abstract class Scorer
Expert: Common scoring functionality for different types of queries.
A Scorer
either iterates over documents matching a query,
or provides an explanation of the score for a query for a given document.
Document scores are computed using a given Similarity
implementation.
Constructor Summary | |
---|---|
protected |
Scorer(Similarity similarity)
Constructs a Scorer. |
Method Summary | |
---|---|
abstract int |
doc()
Returns the current document number matching the query. |
abstract Explanation |
explain(int doc)
Returns an explanation of the score for a document. |
Similarity |
getSimilarity()
Returns the Similarity implementation used by this scorer. |
abstract boolean |
next()
Advances to the next document matching the query. |
abstract float |
score()
Returns the score of the current document matching the query. |
void |
score(HitCollector hc)
Scores and collects all matching documents. |
protected boolean |
score(HitCollector hc,
int max)
Expert: Collects matching documents in a range. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Scorer(Similarity similarity)
similarity
- The Similarity
implementation used by this scorer.Method Detail |
---|
public Similarity getSimilarity()
public void score(HitCollector hc) throws java.io.IOException
hc
- The collector to which all matching documents are passed through
HitCollector.collect(int, float)
.
explain(int)
method should not be used.
java.io.IOException
protected boolean score(HitCollector hc, int max) throws java.io.IOException
next()
must be called once before this method is called
for the first time.
hc
- The collector to which all matching documents are passed through
HitCollector.collect(int, float)
.max
- Do not score documents past this.
java.io.IOException
public abstract boolean next() throws java.io.IOException
explain(int)
method should not be used.
java.io.IOException
public abstract int doc()
next()
is called the first time.
public abstract float score() throws java.io.IOException
next()
or skipTo(int)
is called the first time.
java.io.IOException
public abstract boolean skipTo(int target) throws java.io.IOException
explain(int)
method should not be used.
target
- The target document number.
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.
java.io.IOException
public abstract Explanation explain(int doc) throws java.io.IOException
next()
, skipTo(int)
and
score(HitCollector)
methods should not be used.
doc
- The document number for the explanation.
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |