Interface IPayloadAttribute

The payload of a Token.

The payload is stored in the index at each position, and can be used to influence scoring when using Payload-based queries in the Lucene.Net.Search.Payloads and Lucene.Net.Search.Spans namespaces.

NOTE: because the payload will be stored at each position, its usually best to use the minimum number of bytes necessary. Some codec implementations may optimize payload storage when all payloads have the same length.

Inherited Members
Namespace: Lucene.Net.Analysis.TokenAttributes
Assembly: Lucene.Net.dll
Syntax
public interface IPayloadAttribute : IAttribute

Properties

| Improve this Doc View Source

Payload

Gets or Sets this Token's payload.

Declaration
BytesRef Payload { get; set; }
Property Value
Type Description
BytesRef

See Also