| org.apache.lucene.index.TermPositions
All known Subclasses: org.apache.lucene.index.MultipleTermPositions, org.apache.lucene.index.SegmentTermPositions,
| TermPositions | | public interface TermPositions extends TermDocs(Code) | | TermPositions provides an interface for enumerating the <document,
frequency, <position>* > tuples for a term. 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: IndexReader.termPositions |
| getPayload | | byte[] getPayload(byte[] data, int offset) throws IOException(Code) | | Returns the payload data at the current term position.
This is invalid until
TermPositions.nextPosition() is called for
the first time.
This method must not be called more than once after each call
of
TermPositions.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.
Parameters:
data - the array into which the data of this payload is to bestored, if it is big enough; otherwise, a new byte[] arrayis allocated for this purpose.
Parameters:
offset - the offset in the array into which the data of this payloadis to be stored. a byte[] array containing the data of this payload
throws:
IOException - |
| getPayloadLength | | int getPayloadLength()(Code) | | Returns the length of the payload at the current term position.
This is invalid until
TermPositions.nextPosition() is called for
the first time.
length of the current payload in number of bytes |
| isPayloadAvailable | | public boolean isPayloadAvailable()(Code) | | Checks if a payload can be loaded at this position.
Payloads can only be loaded once per call to
TermPositions.nextPosition() .
true if there is a payload available at this position that can be loaded |
|
|