Package org.apache.lucene.search.spans
Class SpanScorer
- java.lang.Object
-
- org.apache.lucene.search.Scorer
-
- org.apache.lucene.search.spans.SpanScorer
-
public class SpanScorer extends Scorer
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer
Scorer.ChildScorer
-
-
Constructor Summary
Constructors Constructor Description SpanScorer(SpanWeight weight, Spans spans, Similarity.SimScorer docScorer)
Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
docID()
Returns the doc ID that is currently being scored.Spans
getSpans()
return the Spans for this ScorerDocIdSetIterator
iterator()
Return aDocIdSetIterator
over matching documents.float
score()
Returns the score of the current document matching the query.protected float
scoreCurrentDoc()
Score the current doc.protected void
setFreqCurrentDoc()
Setsfreq
andnumMatches
for the current document.TwoPhaseIterator
twoPhaseIterator()
Optional method: Return aTwoPhaseIterator
view of thisScorer
.-
Methods inherited from class org.apache.lucene.search.Scorer
getChildren, getWeight
-
-
-
-
Field Detail
-
spans
protected final Spans spans
-
docScorer
protected final Similarity.SimScorer docScorer
-
-
Constructor Detail
-
SpanScorer
public SpanScorer(SpanWeight weight, Spans spans, Similarity.SimScorer docScorer)
Sole constructor.
-
-
Method Detail
-
getSpans
public Spans getSpans()
return the Spans for this Scorer
-
docID
public int docID()
Description copied from class:Scorer
Returns the doc ID that is currently being scored. This will return-1
if theScorer.iterator()
is not positioned orDocIdSetIterator.NO_MORE_DOCS
if it has been entirely consumed.- Specified by:
docID
in classScorer
- See Also:
DocIdSetIterator.docID()
-
iterator
public DocIdSetIterator iterator()
Description copied from class:Scorer
Return aDocIdSetIterator
over matching documents. The returned iterator will either be positioned on-1
if no documents have been scored yet,DocIdSetIterator.NO_MORE_DOCS
if all documents have been scored already, or the last document id that has been scored otherwise. The returned iterator is a view: calling this method several times will return iterators that have the same state.
-
twoPhaseIterator
public TwoPhaseIterator twoPhaseIterator()
Description copied from class:Scorer
Optional method: Return aTwoPhaseIterator
view of thisScorer
. A return value ofnull
indicates that two-phase iteration is not supported. Note that the returnedTwoPhaseIterator
'sapproximation
must advance synchronously with theScorer.iterator()
: advancing the approximation must advance the iterator and vice-versa. Implementing this method is typically useful onScorer
s that have a high per-document overhead in order to confirm matches. The default implementation returnsnull
.- Overrides:
twoPhaseIterator
in classScorer
-
scoreCurrentDoc
protected float scoreCurrentDoc() throws IOException
Score the current doc. The default implementation scores the doc with the similarity using the slop-adjustedfreq
.- Throws:
IOException
-
setFreqCurrentDoc
protected final void setFreqCurrentDoc() throws IOException
- Throws:
IOException
-
score
public final 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 on theScorer.iterator()
the first time, or when called from withinLeafCollector.collect(int)
.- Specified by:
score
in classScorer
- Throws:
IOException
-
-