org.apache.lucene.analysis.tokenattributes

Interface PayloadAttribute

  • All Superinterfaces:
    Attribute
    All Known Implementing Classes:
    PayloadAttributeImpl, Token


    public interface PayloadAttribute
    extends Attribute
    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.

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

    See Also:
    PostingsEnum