public class

SpanScorer

extends Scorer
java.lang.Object
   ↳ org.apache.lucene.search.DocIdSetIterator
     ↳ org.apache.lucene.search.Scorer
       ↳ org.apache.lucene.search.spans.SpanScorer
Known Direct Subclasses

Class Overview

Public for extension only.

Summary

[Expand]
Inherited Constants
From class org.apache.lucene.search.DocIdSetIterator
Fields
protected int doc
protected float freq
protected boolean more
protected byte[] norms
protected Spans spans
protected float value
protected Weight weight
Protected Constructors
SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)
Public Methods
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:
int nextDoc()
Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.
float score()
Returns the score of the current document matching the query.
Protected Methods
Explanation explain(int doc)
This method is no longer an official member of Scorer, but it is needed by SpanWeight to build an explanation.
boolean setFreqCurrentDoc()
[Expand]
Inherited Methods
From class org.apache.lucene.search.Scorer
From class org.apache.lucene.search.DocIdSetIterator
From class java.lang.Object

Fields

protected int doc

protected float freq

protected boolean more

protected byte[] norms

protected Spans spans

protected float value

protected Weight weight

Protected Constructors

protected SpanScorer (Spans spans, Weight weight, Similarity similarity, byte[] norms)

Throws
IOException

Public Methods

public int advance (int target)

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or 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 {@value #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.

Throws
IOException

public int docID ()

Returns the following:

public int nextDoc ()

Advances to the next document in the set and returns the doc it is currently on, or 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.

Throws
IOException

public float score ()

Returns the score of the current document matching the query. Initially invalid, until nextDoc() or advance(int) is called the first time, or when called from within collect(int).

Throws
IOException

Protected Methods

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.

Throws
IOException

protected boolean setFreqCurrentDoc ()

Throws
IOException