org.apache.lucene.search.payloads
Class PayloadNearQuery.PayloadNearSpanScorer

java.lang.Object
  extended by org.apache.lucene.search.DocIdSetIterator
      extended by org.apache.lucene.search.Scorer
          extended by org.apache.lucene.search.spans.SpanScorer
              extended by org.apache.lucene.search.payloads.PayloadNearQuery.PayloadNearSpanScorer
Enclosing class:
PayloadNearQuery

public class PayloadNearQuery.PayloadNearSpanScorer
extends SpanScorer


Field Summary
protected  float payloadScore
           
 
Fields inherited from class org.apache.lucene.search.spans.SpanScorer
doc, firstTime, freq, more, norms, value, weight
 
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
 
Constructor Summary
protected PayloadNearQuery.PayloadNearSpanScorer(Spans spans, Weight weight, Similarity similarity, byte[] norms)
           
 
Method Summary
 Explanation explain(int doc)
          Returns an explanation of the score for a document.
 void getPayloads(Spans[] subSpans)
           
protected  void processPayloads(Collection payLoads, int start, int end)
          By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things.
 float score()
          Returns the score of the current document matching the query.
protected  boolean setFreqCurrentDoc()
           
 
Methods inherited from class org.apache.lucene.search.spans.SpanScorer
advance, doc, docID, next, nextDoc, skipTo
 
Methods inherited from class org.apache.lucene.search.Scorer
getSimilarity, score, score, score, score
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

payloadScore

protected float payloadScore
Constructor Detail

PayloadNearQuery.PayloadNearSpanScorer

protected PayloadNearQuery.PayloadNearSpanScorer(Spans spans,
                                                 Weight weight,
                                                 Similarity similarity,
                                                 byte[] norms)
                                          throws IOException
Throws:
IOException
Method Detail

getPayloads

public void getPayloads(Spans[] subSpans)
                 throws IOException
Throws:
IOException

processPayloads

protected void processPayloads(Collection payLoads,
                               int start,
                               int end)
By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things.

Parameters:
payLoads - The payloads
start - The start position of the span being scored
end - The end position of the span being scored
See Also:
Spans

setFreqCurrentDoc

protected boolean setFreqCurrentDoc()
                             throws IOException
Overrides:
setFreqCurrentDoc in class SpanScorer
Throws:
IOException

score

public float score()
            throws IOException
Description copied from class: Scorer
Returns the score of the current document matching the query. Initially invalid, until DocIdSetIterator.next() or DocIdSetIterator.skipTo(int) is called the first time, or when called from within Collector.collect(int).

Overrides:
score in class SpanScorer
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 DocIdSetIterator.next(), DocIdSetIterator.skipTo(int) and Scorer.score(HitCollector) methods should not be used.

Overrides:
explain in class SpanScorer
Parameters:
doc - The document number for the explanation.
Throws:
IOException


Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.