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.
IndexReader.termPositions()
Modifier and Type | Method and Description |
---|---|
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.
|
int nextPosition() throws IOException
TermDocs.freq()
times
without calling TermDocs.next()
This is
invalid until TermDocs.next()
is called for
the first time.
IOException
int getPayloadLength()
nextPosition()
is called for
the first time.byte[] getPayload(byte[] data, int offset) throws IOException
nextPosition()
is called for
the first time.
This method must not be called more than once after each call
of nextPosition()
. However, payloads are loaded lazily,
so if the payload data for the current position is not needed,
this method may not be called at all for performance reasons.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.IOException
boolean isPayloadAvailable()
Payloads can only be loaded once per call to
nextPosition()
.