org.apache.lucene.search.payloads

Class PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.Scorer

org.apache.lucene.search.spans.SpanScorer

org.apache.lucene.search.payloads.PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer

Enclosing class:

PayloadTermQuery.PayloadTermWeight

protected class PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer
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 BytesRef	payload
protected float	payloadScore
protected int	payloadsSeen

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

docScorer, freq, numMatches, spans

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

Constructor and Description
PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer(TermSpans spans, SpanWeight weight, Similarity.SimScorer docScorer)

Method Summary

Methods

Modifier and Type	Method and Description
protected float	getPayloadScore() The score for the payload
protected float	getSpanScore() Returns the SpanScorer score only.
protected void	processPayload(Similarity similarity)
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

payload

protected BytesRef payload

payloadScore

protected float payloadScore

payloadsSeen

protected int payloadsSeen

Constructor Detail

PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer

public PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer(TermSpans spans,
                                                        SpanWeight weight,
                                                        Similarity.SimScorer docScorer)
                                                         throws IOException

Throws:

IOException

Method Detail

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

processPayload

protected void processPayload(Similarity similarity)
                       throws IOException

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

Returns:

getSpanScore() * getPayloadScore()

Throws:

IOException - if there is a low-level I/O error

getSpanScore

protected float getSpanScore()
                      throws IOException

Returns the SpanScorer score only.

Should not be overridden without good cause!

Returns:

the score for just the Span part w/o the payload

Throws:

IOException - if there is a low-level I/O error

See Also:

SpanScorer.score()

getPayloadScore

protected float getPayloadScore()

The score for the payload

Returns:

The score, as calculated by PayloadFunction.docScore(int, String, int, float)