|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.DocIdSetIterator org.apache.lucene.search.Scorer org.apache.lucene.search.spans.SpanScorer
public class SpanScorer
Public for extension only.
Field Summary | |
---|---|
protected int |
doc
|
protected float |
freq
|
protected boolean |
more
|
protected byte[] |
norms
|
protected Spans |
spans
|
protected float |
value
|
protected Weight |
weight
|
Fields inherited from class org.apache.lucene.search.DocIdSetIterator |
---|
NO_MORE_DOCS |
Constructor Summary | |
---|---|
protected |
SpanScorer(Spans spans,
Weight weight,
Similarity similarity,
byte[] norms)
|
Method Summary | |
---|---|
int |
advance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target. |
int |
docID()
Returns the following: -1 or DocIdSetIterator.NO_MORE_DOCS if DocIdSetIterator.nextDoc() or
DocIdSetIterator.advance(int) were not called yet. |
protected Explanation |
explain(int doc)
This method is no longer an official member of Scorer ,
but it is needed by SpanWeight to build an explanation. |
int |
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior. |
float |
score()
Returns the score of the current document matching the query. |
protected boolean |
setFreqCurrentDoc()
|
Methods inherited from class org.apache.lucene.search.Scorer |
---|
getSimilarity, score, score |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Spans spans
protected Weight weight
protected byte[] norms
protected float value
protected boolean more
protected int doc
protected float freq
Constructor Detail |
---|
protected SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms) throws IOException
IOException
Method Detail |
---|
public int nextDoc() throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the
set.
nextDoc
in class DocIdSetIterator
IOException
public int advance(int target) throws IOException
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
Behaves as if written:
int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }Some implementations are considerably more efficient than that.
NOTE: certain implementations may return a different value (each time) if called several times in a row with the same target.
NOTE: this method may be called with 2147483647 for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
advance
in class DocIdSetIterator
IOException
protected boolean setFreqCurrentDoc() throws IOException
IOException
public int docID()
DocIdSetIterator
DocIdSetIterator.NO_MORE_DOCS
if DocIdSetIterator.nextDoc()
or
DocIdSetIterator.advance(int)
were not called yet.
DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.
docID
in class DocIdSetIterator
public float score() throws IOException
Scorer
DocIdSetIterator.nextDoc()
or DocIdSetIterator.advance(int)
is called the first time, or when called from within
Collector.collect(int)
.
score
in class Scorer
IOException
protected Explanation explain(int doc) throws IOException
Scorer
,
but it is needed by SpanWeight to build an explanation.
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |