Class InstantiatedTermPositions
- java.lang.Object
-
- org.apache.lucene.store.instantiated.InstantiatedTermDocs
-
- org.apache.lucene.store.instantiated.InstantiatedTermPositions
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,org.apache.lucene.index.TermDocs
,org.apache.lucene.index.TermPositions
public class InstantiatedTermPositions extends InstantiatedTermDocs implements org.apache.lucene.index.TermPositions
ATermPositions
navigating anInstantiatedIndexReader
.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.store.instantiated.InstantiatedTermDocs
currentDocumentInformation, currentTerm
-
-
Constructor Summary
Constructors Constructor Description InstantiatedTermPositions(InstantiatedIndexReader reader)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
getPayload(byte[] data, int offset)
int
getPayloadLength()
boolean
isPayloadAvailable()
boolean
next()
Moves to the next pair in the enumeration.int
nextPosition()
Returns next position in the current document.boolean
skipTo(int target)
Skips entries to the first beyond the current whose document number is greater than or equal totarget .-
Methods inherited from class org.apache.lucene.store.instantiated.InstantiatedTermDocs
close, doc, freq, read, seek, seek
-
-
-
-
Constructor Detail
-
InstantiatedTermPositions
public InstantiatedTermPositions(InstantiatedIndexReader reader)
-
-
Method Detail
-
getPayloadLength
public int getPayloadLength()
- Specified by:
getPayloadLength
in interfaceorg.apache.lucene.index.TermPositions
-
getPayload
public byte[] getPayload(byte[] data, int offset) throws IOException
- Specified by:
getPayload
in interfaceorg.apache.lucene.index.TermPositions
- Throws:
IOException
-
isPayloadAvailable
public boolean isPayloadAvailable()
- Specified by:
isPayloadAvailable
in interfaceorg.apache.lucene.index.TermPositions
-
nextPosition
public int nextPosition()
Returns next position in the current document. It is an error to call this more thanInstantiatedTermDocs.freq()
times without callingnext()
This is invalid until
next()
is called for the first time.- Specified by:
nextPosition
in interfaceorg.apache.lucene.index.TermPositions
-
next
public boolean next()
Moves to the next pair in the enumeration.Returns true if there is such a next pair in the enumeration.
- Specified by:
next
in interfaceorg.apache.lucene.index.TermDocs
- Overrides:
next
in classInstantiatedTermDocs
-
skipTo
public boolean skipTo(int target)
Skips entries to the first beyond the current whose document number is greater than or equal totarget .Returns true iff there is such an entry.
Behaves as if written:
boolean skipTo(int target) { do { if (!next()) return false; } while (target > doc()); return true; }
Some implementations are considerably more efficient than that.- Specified by:
skipTo
in interfaceorg.apache.lucene.index.TermDocs
- Overrides:
skipTo
in classInstantiatedTermDocs
-
-