public interface PayloadAttribute extends Attribute
The payload is stored in the index at each position, and can
be used to influence scoring when using Payload-based queries
in the org.apache.lucene.search.payloads
and
org.apache.lucene.search.spans
packages.
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.
DocsAndPositionsEnum
Modifier and Type | Method and Description |
---|---|
BytesRef |
getPayload()
Returns this Token's payload.
|
void |
setPayload(BytesRef payload)
Sets this Token's payload.
|
BytesRef getPayload()
setPayload(BytesRef)
void setPayload(BytesRef payload)
getPayload()
Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.