org.apache.lucene.search.payloads

Class PayloadNearQuery.PayloadNearSpanScorer

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.Scorer

org.apache.lucene.search.spans.SpanScorer

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

Enclosing class:

PayloadNearQuery

public class PayloadNearQuery.PayloadNearSpanScorer
extends SpanScorer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorer

Scorer.ChildScorer

Field Summary

Fields

Modifier and Type	Field and Description
protected float	payloadScore

Fields inherited from class org.apache.lucene.search.spans.SpanScorer

docScorer, freq, numMatches

Fields inherited from class org.apache.lucene.search.Scorer

weight

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PayloadNearQuery.PayloadNearSpanScorer(Spans spans, SpanWeight weight, Similarity similarity, Similarity.SimScorer docScorer)

Method Summary

Methods

Modifier and Type	Method and Description
void	getPayloads(Spans[] subSpans)
protected void	processPayloads(Collection<byte[]> payLoads, int start, int end) By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things.
float	scoreCurrentDoc() Score the current doc.
protected void	setFreqCurrentDoc() Sets SpanScorer.freq and SpanScorer.numMatches for the current document.

Methods inherited from class org.apache.lucene.search.spans.SpanScorer

advance, asTwoPhaseIterator, cost, docID, freq, nextDoc, score, sloppyFreq

Methods inherited from class org.apache.lucene.search.Scorer

getChildren, getWeight

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

all, empty, slowAdvance

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,
                                      SpanWeight weight,
                                      Similarity similarity,
                                      Similarity.SimScorer docScorer)
                                          throws IOException

Throws:

IOException

Method Detail

getPayloads

public void getPayloads(Spans[] subSpans)
                 throws IOException

Throws:

IOException

processPayloads

protected void processPayloads(Collection<byte[]> 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 void setFreqCurrentDoc()
                          throws IOException

Description copied from class: SpanScorer

Sets SpanScorer.freq and SpanScorer.numMatches for the current document.

This will be called at most once per document.

Overrides:

setFreqCurrentDoc in class SpanScorer

Throws:

IOException

scoreCurrentDoc

public float scoreCurrentDoc()
                      throws IOException

Description copied from class: SpanScorer

Score the current doc. The default implementation scores the doc with the similarity using the slop-adjusted SpanScorer.freq.

Overrides:

scoreCurrentDoc in class SpanScorer

Throws:

IOException