Lucene.Net.Search.Payloads.PayloadSpanUtil Class Reference

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

Public Member Functions
	PayloadSpanUtil (IndexReader reader)
virtual ICollection< byte[]>	GetPayloadsForQuery (Query query)
	Query should be rewritten for wild/fuzzy support.

Detailed Description

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.

<font color="#FF0000"> 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.</font>

Definition at line 50 of file PayloadSpanUtil.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Payloads.PayloadSpanUtil.PayloadSpanUtil

(

IndexReader

reader

)

Parameters

reader

that contains doc with payloads to extract

Definition at line 56 of file PayloadSpanUtil.cs.

Member Function Documentation

virtual ICollection<byte[]> Lucene.Net.Search.Payloads.PayloadSpanUtil.GetPayloadsForQuery ( Query  query )

virtual

Query should be rewritten for wild/fuzzy support.

Parameters

query

Returns

payloads Collection

<throws> IOException </throws>

Definition at line 69 of file PayloadSpanUtil.cs.

---

The documentation for this class was generated from the following file:

• core/Search/Payloads/PayloadSpanUtil.cs