|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.lucene.search.DocIdSetIterator
org.apache.lucene.search.Scorer
org.apache.lucene.search.spans.SpanScorer
public class SpanScorer
Public for extension only.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer |
|---|
Scorer.ScorerVisitor<P extends Query,C extends Query,S extends Scorer> |
| Field Summary | |
|---|---|
protected int |
doc
|
protected float |
freq
|
protected boolean |
more
|
protected byte[] |
norms
|
protected Spans |
spans
|
protected float |
value
|
| Fields inherited from class org.apache.lucene.search.Scorer |
|---|
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 (see NOTE below) 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. |
float |
freq()
Returns number of matches for the current document. |
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, visitScorers, visitSubScorers |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Spans spans
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
DocIdSetIteratorDocIdSetIterator.NO_MORE_DOCS if there are no more docs in the
set.
nextDoc in class DocIdSetIteratorIOException
public int advance(int target)
throws IOException
DocIdSetIteratorDocIdSetIterator.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: when target ≤ current implementations may opt
not to advance beyond their current DocIdSetIterator.docID().
NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS 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 DocIdSetIteratorIOException
protected boolean setFreqCurrentDoc()
throws IOException
IOExceptionpublic int docID()
DocIdSetIteratorDocIdSetIterator.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
ScorerDocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int)
is called the first time, or when called from within
Collector.collect(int).
score in class ScorerIOException
public float freq()
throws IOException
Scorer
freq in class ScorerIOException
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 | |||||||||