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 IndexReader#termPositions() - */ - -public interface TermPositions - extends TermDocs -{ - /** Returns next position in the current document. It is an error to call - this more than {@link #freq()} times - without calling {@link #next()}
This is
- invalid until {@link #next()} is called for
- the first time.
- */
- int nextPosition() throws IOException;
-
- /**
- * Returns the length of the payload at the current term position.
- * This is invalid until {@link #nextPosition()} is called for
- * the first time.
- * @return length of the current payload in number of bytes
- */
- int getPayloadLength();
-
- /**
- * Returns the payload data at the current term position.
- * This is invalid until {@link #nextPosition()} is called for
- * the first time.
- * This method must not be called more than once after each call
- * of {@link #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.
- *
- * @param 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.
- * @param offset the offset in the array into which the data of this payload
- * is to be stored.
- * @return a byte[] array containing the data of this payload
- * @throws IOException
- */
- byte[] getPayload(byte[] data, int offset) throws IOException;
-
- /**
- * Checks if a payload can be loaded at this position.
- *
- * Payloads can only be loaded once per call to - * {@link #nextPosition()}. - * - * @return true if there is a payload available at this position that can be loaded - */ - public boolean isPayloadAvailable(); - -}