public abstract class Scorer extends DocIdSetIterator
A Scorer
either iterates over documents matching a
query in increasing order of doc Id, or provides an explanation of
the score for a query for a given document.
Document scores are computed using a given Similarity
implementation.
Modifier | Constructor and Description |
---|---|
protected |
Scorer(Similarity similarity)
Constructs a Scorer.
|
Modifier and Type | Method and Description |
---|---|
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 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.
|
doc, next, skipTo
protected Scorer(Similarity similarity)
similarity
- The Similarity
implementation used by this scorer.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
DocIdSetIterator.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 float score() throws java.io.IOException
DocIdSetIterator.next()
or DocIdSetIterator.skipTo(int)
is called the first time.java.io.IOException
public abstract Explanation explain(int doc) throws java.io.IOException
DocIdSetIterator.next()
, DocIdSetIterator.skipTo(int)
and
score(HitCollector)
methods should not be used.doc
- The document number for the explanation.java.io.IOException
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.