org.apache.lucene.payloads

Class PayloadSpanCollector

java.lang.Object

org.apache.lucene.payloads.PayloadSpanCollector

All Implemented Interfaces:

SpanCollector

public class PayloadSpanCollector
extends java.lang.Object
implements SpanCollector

SpanCollector for collecting payloads

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Collection<byte[]>	payloads

Constructor Summary

Constructors

Constructor and Description
PayloadSpanCollector()

Method Summary

Modifier and Type	Method and Description
void	collectLeaf(PostingsEnum postings, int position, Term term) Collect information from postings
java.util.Collection<byte[]>	getPayloads()
void	reset() Call to indicate that the driving Spans has moved to a new position

Methods inherited from class java.lang.Object

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

Field Detail

payloads

private final java.util.Collection<byte[]> payloads

Constructor Detail

PayloadSpanCollector

public PayloadSpanCollector()

Method Detail

collectLeaf

public void collectLeaf(PostingsEnum postings,
                        int position,
                        Term term)
                 throws java.io.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:

java.io.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

getPayloads

public java.util.Collection<byte[]> getPayloads()

Returns:

the collected payloads