Package org.apache.lucene.search.spans
Class SpanScorer
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.spans.SpanScorer
-
- Direct Known Subclasses:
PayloadNearQuery.PayloadNearSpanScorer
,PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer
public class SpanScorer extends Scorer
Public for extension only.
-
-
Field Summary
Fields Modifier and Type Field Description 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.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 orDocIdSetIterator.NO_MORE_DOCS
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.protected Explanation
explain(int doc)
This method is no longer an official member ofScorer
, 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, orDocIdSetIterator.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
-
-
-
-
Field Detail
-
spans
protected Spans spans
-
norms
protected byte[] norms
-
value
protected float value
-
more
protected boolean more
-
doc
protected int doc
-
freq
protected float freq
-
-
Constructor Detail
-
SpanScorer
protected SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms) throws IOException
- Throws:
IOException
-
-
Method Detail
-
nextDoc
public int nextDoc() throws IOException
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.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.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
IOException
-
advance
public int advance(int target) throws IOException
Description copied from class:DocIdSetIterator
Advances to the first beyond (see NOTE below) the current whose document number is greater than or equal to target. Returns the current document number orDocIdSetIterator.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 currentDocIdSetIterator.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.
- Specified by:
advance
in classDocIdSetIterator
- Throws:
IOException
-
setFreqCurrentDoc
protected boolean setFreqCurrentDoc() throws IOException
- Throws:
IOException
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:- -1 or
DocIdSetIterator.NO_MORE_DOCS
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet. DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
- -1 or
-
score
public float score() throws IOException
Description copied from class:Scorer
Returns the score of the current document matching the query. Initially invalid, untilDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
is called the first time, or when called from withinCollector.collect(int)
.- Specified by:
score
in classScorer
- Throws:
IOException
-
freq
public float freq() throws IOException
Description copied from class:Scorer
Returns number of matches for the current document. This returns a float (not int) because SloppyPhraseScorer discounts its freq according to how "sloppy" the match was.- Overrides:
freq
in classScorer
- Throws:
IOException
-
explain
protected Explanation explain(int doc) throws IOException
This method is no longer an official member ofScorer
, but it is needed by SpanWeight to build an explanation.- Throws:
IOException
-
-