Class PayloadSpanUtil

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.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

System.Object

PayloadSpanUtil

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lucene.Net.Search.Payloads

Assembly: Lucene.Net.dll

Syntax

public class PayloadSpanUtil

Constructors

PayloadSpanUtil(IndexReaderContext)

Declaration

public PayloadSpanUtil(IndexReaderContext context)

Parameters

Type	Name	Description
IndexReaderContext	context	that contains doc with payloads to extract

See Also

Context

Methods

GetPayloadsForQuery(Query)

Query should be rewritten for wild/fuzzy support.

Declaration

public virtual ICollection<byte[]> GetPayloadsForQuery(Query query)

Parameters

Type	Name	Description
Query	query	rewritten query

Returns

Type	Description
System.Collections.Generic.ICollection<System.Byte[]>	payloads Collection

Exceptions

Type	Condition
System.IO.IOException	if there is a low-level I/O error