lucene::index::TermPositions Class Reference
TermPositions provides an interface for enumerating the <document, frequency, <position>* > tuples for a term. More...
#include <Terms.h>
Public Member Functions | |
| virtual int32_t | nextPosition ()=0 |
| Returns next position in the current document. | |
| virtual | ~TermPositions () |
| virtual int32_t | getPayloadLength () const =0 |
| Returns the length of the payload at the current term position. | |
| virtual uint8_t * | getPayload (uint8_t *data, int32_t offset)=0 |
| Returns the payload data at the current term position. | |
| virtual bool | isPayloadAvailable () const =0 |
| Checks if a payload can be loaded at this position. | |
| virtual TermDocs * | __asTermDocs ()=0 |
| Solve the diamond inheritence problem by providing a reinterpret function. | |
| virtual TermPositions * | __asTermPositions ()=0 |
| Solve the diamond inheritence problem by providing a reinterpret function. | |
Detailed Description
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()
Constructor & Destructor Documentation
| virtual lucene::index::TermPositions::~TermPositions | ( | ) | [virtual] |
Member Function Documentation
| virtual int32_t lucene::index::TermPositions::nextPosition | ( | ) | [pure virtual] |
| virtual int32_t lucene::index::TermPositions::getPayloadLength | ( | ) | const [pure virtual] |
Returns the length of the payload at the current term position.
This is invalid until nextPosition() is called for the first time.
- Returns:
- length of the current payload in number of bytes
| virtual uint8_t* lucene::index::TermPositions::getPayload | ( | uint8_t * | data, | |
| int32_t | offset | |||
| ) | [pure virtual] |
Returns the payload data at the current term position.
This is invalid until 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.
- 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
| virtual bool lucene::index::TermPositions::isPayloadAvailable | ( | ) | const [pure virtual] |
Checks if a payload can be loaded at this position.
Payloads can only be loaded once per call to nextPosition().
- Returns:
- true if there is a payload available at this position that can be loaded
| virtual TermDocs* lucene::index::TermPositions::__asTermDocs | ( | ) | [pure virtual] |
Solve the diamond inheritence problem by providing a reinterpret function.
No dynamic casting is required and no RTTI data is needed to do this
| virtual TermPositions* lucene::index::TermPositions::__asTermPositions | ( | ) | [pure virtual] |
Solve the diamond inheritence problem by providing a reinterpret function.
No dynamic casting is required and no RTTI data is needed to do this
Implements lucene::index::TermDocs.
The documentation for this class was generated from the following file: