Interface TermPositions
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.
Inherited Members
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public interface TermPositions : TermDocs, IDisposableProperties
| Name | Description |
|---|---|
| IsPayloadAvailable | Checks if a payload can be loaded at this position. Payloads can only be loaded once per call to NextPosition(). |
| PayloadLength | Returns the length of the payload at the current term position.
This is invalid until NextPosition() is called for
the first time. |
Methods
| Name | Description |
|---|---|
| GetPayload(Byte[], Int32) | 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. |
| NextPosition() | Returns next position in the current document. It is an error to call this more than Freq times without calling Next() This is invalid until Next() is called for the first time. |