Package org.apache.lucene.search.payloads

Class PayloadTermQuery.PayloadTermWeight.PayloadTermSpanScorer

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocsEnum

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	Description
protected BytesRef	payload
protected float	payloadScore
protected int	payloadsSeen

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

doc, docScorer, freq, more, numMatches, spans

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

weight

Fields inherited from class org.apache.lucene.index.DocsEnum

FLAG_FREQS, FLAG_NONE

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

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor	Description
PayloadTermSpanScorer(TermSpans spans, Weight weight, Similarity.SimScorer docScorer)

Method Summary

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

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

getChildren, getWeight, score, score

Methods inherited from class org.apache.lucene.index.DocsEnum

attributes

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

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

PayloadTermSpanScorer

public PayloadTermSpanScorer(TermSpans spans,
                             Weight weight,
                             Similarity.SimScorer docScorer)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

setFreqCurrentDoc

protected boolean setFreqCurrentDoc()
                             throws java.io.IOException

Overrides:

setFreqCurrentDoc in class SpanScorer

Throws:

java.io.IOException

processPayload

protected void processPayload(Similarity similarity)
                       throws java.io.IOException

Throws:

java.io.IOException

score

public float score()
            throws java.io.IOException

Description copied from class: Scorer

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

Overrides:

score in class SpanScorer

Returns:

getSpanScore() * getPayloadScore()

Throws:

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

getSpanScore

protected float getSpanScore()
                      throws java.io.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:

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

See Also:

score()

getPayloadScore

protected float getPayloadScore()

The score for the payload

Returns:

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