org.apache.lucene.queries.payloads

Class PayloadNearQuery.PayloadNearSpanScorer

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.Scorer

org.apache.lucene.search.spans.Spans

org.apache.lucene.queries.payloads.PayloadNearQuery.PayloadNearSpanScorer

All Implemented Interfaces:

SpanCollector

Enclosing class:

PayloadNearQuery

public class PayloadNearQuery.PayloadNearSpanScorer
extends Spans
implements SpanCollector

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.Spans

docScorer, freq, NO_MORE_POSITIONS, 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.SimScorer docScorer)

Method Summary

Methods

Modifier and Type	Method and Description
int	advance(int target)
void	collect(SpanCollector collector)
void	collectLeaf(PostingsEnum postings, int position, Term term)
long	cost()
int	docID()
protected void	doCurrentSpans()
protected void	doStartCurrentDoc()
int	endPosition()
int	nextDoc()
int	nextStartPosition()
float	positionsCost()
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.
void	reset()
float	scoreCurrentDoc()
int	startPosition()
int	width()

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

freq, score, setFreqCurrentDoc, sloppyFreq, toString

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

asTwoPhaseIterator, 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, wait, wait, wait

Field Detail

payloadScore

protected float payloadScore

Constructor Detail

PayloadNearQuery.PayloadNearSpanScorer

protected PayloadNearQuery.PayloadNearSpanScorer(Spans spans,
                                      SpanWeight weight,
                                      Similarity.SimScorer docScorer)
                                          throws IOException

Throws:

IOException

Method Detail

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

nextStartPosition

public int nextStartPosition()
                      throws IOException

Specified by:

nextStartPosition in class Spans

Throws:

IOException

startPosition

public int startPosition()

Specified by:

startPosition in class Spans

endPosition

public int endPosition()

Specified by:

endPosition in class Spans

width

public int width()

Specified by:

width in class Spans

collect

public void collect(SpanCollector collector)
             throws IOException

Specified by:

collect in class Spans

Throws:

IOException

doStartCurrentDoc

protected void doStartCurrentDoc()
                          throws IOException

Overrides:

doStartCurrentDoc in class Spans

Throws:

IOException

doCurrentSpans

protected void doCurrentSpans()
                       throws IOException

Overrides:

doCurrentSpans in class Spans

Throws:

IOException

scoreCurrentDoc

public float scoreCurrentDoc()
                      throws IOException

Overrides:

scoreCurrentDoc in class Spans

Throws:

IOException

collectLeaf

public void collectLeaf(PostingsEnum postings,
               int position,
               Term term)
                 throws IOException

Specified by:

collectLeaf in interface SpanCollector

Throws:

IOException

reset

public void reset()

Specified by:

reset in interface SpanCollector

docID

public int docID()

Specified by:

docID in class DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

Specified by:

nextDoc in class DocIdSetIterator

Throws:

IOException

advance

public int advance(int target)
            throws IOException

Specified by:

advance in class DocIdSetIterator

Throws:

IOException

cost

public long cost()

Specified by:

cost in class DocIdSetIterator

positionsCost

public float positionsCost()

Specified by:

positionsCost in class Spans