org.apache.lucene.index.TermPositions |
Known Indirect Subclasses |
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.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the payload data at the current term position.
| |||||||||||
Returns the length of the payload at the current term position.
| |||||||||||
Checks if a payload can be loaded at this position.
| |||||||||||
Returns next position in the current document.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From interface
java.io.Closeable
| |||||||||||
From interface
org.apache.lucene.index.TermDocs
|
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.
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 |
---|
Returns the length of the payload at the current term position.
This is invalid until nextPosition()
is called for
the first time.
Checks if a payload can be loaded at this position.
Payloads can only be loaded once per call to
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.
IOException |
---|