Module org.apache.lucene.queries

Package org.apache.lucene.queries.payloads

Class PayloadScoreQuery.PayloadSpans

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.queries.spans.Spans

org.apache.lucene.queries.spans.FilterSpans

org.apache.lucene.queries.payloads.PayloadScoreQuery.PayloadSpans

All Implemented Interfaces:

SpanCollector

Enclosing class:

PayloadScoreQuery

private class PayloadScoreQuery.PayloadSpans
extends FilterSpans
implements SpanCollector

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.queries.spans.FilterSpans

FilterSpans.AcceptStatus

Field Summary

Fields

Modifier and Type	Field	Description
private final PayloadDecoder	decoder
float	payloadScore
int	payloadsSeen

Fields inherited from class org.apache.lucene.queries.spans.FilterSpans

in

Fields inherited from class org.apache.lucene.queries.spans.Spans

NO_MORE_POSITIONS

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

NO_MORE_DOCS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PayloadSpans(Spans in, PayloadDecoder decoder)

Method Summary

Modifier and Type	Method	Description
protected FilterSpans.AcceptStatus	accept(Spans candidate)	Returns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.
void	collectLeaf(PostingsEnum postings, int position, Term term)	Collect information from postings
protected void	doCurrentSpans()	Called each time the scorer's SpanScorer is advanced during frequency calculation
protected void	doStartCurrentDoc()	Called before the current doc's frequency is calculated
void	reset()	Call to indicate that the driving Spans has moved to a new position

Methods inherited from class org.apache.lucene.queries.spans.FilterSpans

advance, asTwoPhaseIterator, collect, cost, docID, endPosition, nextDoc, nextStartPosition, positionsCost, startPosition, toString, width

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

all, empty, range, slowAdvance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

decoder

private final PayloadDecoder decoder

payloadsSeen

public int payloadsSeen

payloadScore

public float payloadScore

Constructor Details

PayloadSpans

private PayloadSpans(Spans in,
 PayloadDecoder decoder)

Method Details

accept

protected FilterSpans.AcceptStatus accept(Spans candidate)
                                   throws IOException

Description copied from class: FilterSpans

Returns YES if the candidate should be an accepted match, NO if it should not, and NO_MORE_IN_CURRENT_DOC if iteration should move on to the next document.

Specified by:

accept in class FilterSpans

Throws:

IOException

doStartCurrentDoc

protected void doStartCurrentDoc()

Description copied from class: Spans

Called before the current doc's frequency is calculated

Overrides:

doStartCurrentDoc in class Spans

collectLeaf

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

Description copied from interface: SpanCollector

Collect information from postings

Specified by:

collectLeaf in interface SpanCollector

Parameters:

postings - a PostingsEnum

position - the position of the PostingsEnum

term - the Term for this postings list

Throws:

IOException - on error

reset

public void reset()

Description copied from interface: SpanCollector

Call to indicate that the driving Spans has moved to a new position

Specified by:

reset in interface SpanCollector

doCurrentSpans

protected void doCurrentSpans()
                       throws IOException

Description copied from class: Spans

Called each time the scorer's SpanScorer is advanced during frequency calculation

Overrides:

doCurrentSpans in class Spans

Throws:

IOException