org.apache.lucene.index
public interface TermPositions extends TermDocs
The document and frequency are the same as for a TermDocs. The positions portion lists the ordinal positions of each occurrence of a term in a document.
See Also: termPositions
Method Summary | |
---|---|
byte[] | getPayload(byte[] data, int offset)
Returns the payload data at the current term position.
|
int | getPayloadLength()
Returns the length of the payload at the current term position.
|
boolean | isPayloadAvailable()
Checks if a payload can be loaded at this position.
|
int | nextPosition() Returns next position in the current document. |
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.
Parameters: data the array into which the data of this payload is to be stored, if it is big enough; otherwise, a new byte[] array is allocated for this purpose. offset the offset in the array into which the data of this payload is to be stored.
Returns: a byte[] array containing the data of this payload
Throws: IOException
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.
Returns: length of the current payload in number of bytes
Payloads can only be loaded once per call to nextPosition.
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.
Returns: true if there is a payload available at this position that can be loaded
This is invalid until TermPositions is called for the first time.