|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.store.instantiated.InstantiatedTermDocs org.apache.lucene.store.instantiated.InstantiatedTermPositions
public class InstantiatedTermPositions
A TermPositions
navigating an InstantiatedIndexReader
.
Field Summary |
---|
Fields inherited from class org.apache.lucene.store.instantiated.InstantiatedTermDocs |
---|
currentDocumentInformation, currentTerm |
Constructor Summary | |
---|---|
InstantiatedTermPositions(InstantiatedIndexReader reader)
|
Method Summary | |
---|---|
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 to |
Methods inherited from class org.apache.lucene.store.instantiated.InstantiatedTermDocs |
---|
close, doc, freq, read, seek, seek |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.lucene.index.TermDocs |
---|
close, doc, freq, read, seek, seek |
Constructor Detail |
---|
public InstantiatedTermPositions(InstantiatedIndexReader reader)
Method Detail |
---|
public int getPayloadLength()
getPayloadLength
in interface org.apache.lucene.index.TermPositions
public byte[] getPayload(byte[] data, int offset) throws IOException
getPayload
in interface org.apache.lucene.index.TermPositions
IOException
public boolean isPayloadAvailable()
isPayloadAvailable
in interface org.apache.lucene.index.TermPositions
public int nextPosition()
InstantiatedTermDocs.freq()
times
without calling next()
This is
invalid until next()
is called for
the first time.
nextPosition
in interface org.apache.lucene.index.TermPositions
public boolean next()
Returns true if there is such a next pair in the enumeration.
next
in interface org.apache.lucene.index.TermDocs
next
in class InstantiatedTermDocs
public boolean skipTo(int target)
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.
skipTo
in interface org.apache.lucene.index.TermDocs
skipTo
in class InstantiatedTermDocs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |