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

Public for extension only.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	doc
protected boolean	firstTime
protected float	freq
protected boolean	more
protected byte[]	norms
protected Spans	spans
protected float	value
protected Weight	weight

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)

Method Summary

Methods

Modifier and Type	Method and Description
int	doc() Returns the current document number matching the query.
Explanation	explain(int doc) Returns an explanation of the score for a document.
boolean	next() Advances to the document matching this Scorer with the lowest doc Id greater than the current value of Scorer.doc() (or to the matching document with the lowest doc Id if next has never been called on this Scorer).
float	score() Returns the score of the current document matching the query.
protected boolean	setFreqCurrentDoc()
boolean	skipTo(int target) Skips to the document matching this Scorer with the lowest doc Id greater than or equal to a given target.

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

spans

protected Spans spans

weight

protected Weight weight

norms

protected byte[] norms

value

protected float value

firstTime

protected boolean firstTime

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

next

public boolean next()
             throws IOException

Description copied from class: Scorer

Advances to the document matching this Scorer with the lowest doc Id greater than the current value of Scorer.doc() (or to the matching document with the lowest doc Id if next has never been called on this Scorer).

When this method is used the Scorer.explain(int) method should not be used.

Specified by:

next in class Scorer

Returns:

true iff there is another document matching the query.

Throws:

IOException

See Also:

BooleanQuery.setAllowDocsOutOfOrder(boolean)

skipTo

public boolean skipTo(int target)
               throws IOException

Description copied from class: Scorer

Skips to the document matching this Scorer with the lowest doc Id greater than or equal to a given target.

The behavior of this method is undefined if the target specified is less than or equal to the current value of Scorer.doc().

Behaves as if written:

   boolean skipTo(int target) {
     do {
       if (!next())
             return false;
     } while (target > doc());
     return true;
   }
 

Most implementations are considerably more efficient than that.

When this method is used the Scorer.explain(int) method should not be used.

Specified by:

skipTo in class Scorer

Parameters:

target - The target document number.

Returns:

true iff there is such a match.

Throws:

IOException

See Also:

BooleanQuery.setAllowDocsOutOfOrder(boolean)

setFreqCurrentDoc

protected boolean setFreqCurrentDoc()
                             throws IOException

Throws:

IOException

doc

public int doc()

Description copied from class: Scorer

Returns the current document number matching the query. Initially invalid, until Scorer.next() is called the first time.

Specified by:

doc in class Scorer

score

public float score()
            throws IOException

Description copied from class: Scorer

Returns the score of the current document matching the query. Initially invalid, until Scorer.next() or Scorer.skipTo(int) is called the first time.

Specified by:

score in class Scorer

Throws:

IOException

explain

public Explanation explain(int doc)
                    throws IOException

Description copied from class: Scorer

Returns an explanation of the score for a document.
When this method is used, the Scorer.next(), Scorer.skipTo(int) and Scorer.score(HitCollector) methods should not be used.

Specified by:

explain in class Scorer

Parameters:

doc - The document number for the explanation.

Throws:

IOException