public class

PayloadSpanUtil

extends Object
java.lang.Object
   ↳ org.apache.lucene.search.payloads.PayloadSpanUtil

Class Overview

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.

WARNING: The status of the Payloads feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.

Summary

Public Constructors
PayloadSpanUtil(IndexReader reader)
Public Methods
Collection<byte[]> getPayloadsForQuery(Query query)
Query should be rewritten for wild/fuzzy support.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PayloadSpanUtil (IndexReader reader)

Parameters
reader that contains doc with payloads to extract

Public Methods

public Collection<byte[]> getPayloadsForQuery (Query query)

Query should be rewritten for wild/fuzzy support.

Returns
  • payloads Collection
Throws
IOException