Package org.apache.lucene.payloads

Class PayloadSpanUtil

java.lang.Object

org.apache.lucene.payloads.PayloadSpanUtil

public class PayloadSpanUtil
extends java.lang.Object

Experimental class to get set of payloads for most standard Lucene queries. Operates like Highlighter - IndexReader should only contain doc of interest, best to use MemoryIndex.

Field Summary

Fields

Modifier and Type	Field	Description
private IndexReaderContext	context

Constructor Summary

Constructors

Constructor	Description
PayloadSpanUtil(IndexReaderContext context)

Method Summary

Modifier and Type	Method	Description
private void	getPayloads(java.util.Collection<byte[]> payloads, SpanQuery query)
java.util.Collection<byte[]>	getPayloadsForQuery(Query query)	Query should be rewritten for wild/fuzzy support.
private void	queryToSpanQuery(Query query, java.util.Collection<byte[]> payloads)

Methods inherited from class java.lang.Object

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

Field Detail

context

private IndexReaderContext context

Constructor Detail

PayloadSpanUtil

public PayloadSpanUtil(IndexReaderContext context)

Parameters:

context - that contains doc with payloads to extract

See Also:

IndexReader.getContext()

Method Detail

getPayloadsForQuery

public java.util.Collection<byte[]> getPayloadsForQuery(Query query)
                                                 throws java.io.IOException

Query should be rewritten for wild/fuzzy support.

Parameters:

query - rewritten query

Returns:

payloads Collection

Throws:

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

queryToSpanQuery

private void queryToSpanQuery(Query query,
                              java.util.Collection<byte[]> payloads)
                       throws java.io.IOException

Throws:

java.io.IOException

getPayloads

private void getPayloads(java.util.Collection<byte[]> payloads,
                         SpanQuery query)
                  throws java.io.IOException

Throws:

java.io.IOException