org.terrier.structures

Interface PostingIndexInputStream

All Superinterfaces:

AutoCloseable, Closeable, Iterator<IterablePosting>

All Known Implementing Classes:

BitPostingIndexInputStream, BlockDirectIndexInputStream, BlockInvertedIndexInputStream, DirectIndexInputStream, IntegerCodingPostingIndexInputStream, InvertedIndexInputStream, MemoryInvertedIndex.InvertedIterator

public interface PostingIndexInputStream
extends Closeable, Iterator<IterablePosting>

Interface for reading postings from an input stream

Method Summary

Methods

Modifier and Type	Method and Description
Pointer	getCurrentPointer() Returns the pointer associated with the current postings being accessed
int	getEntriesSkipped() Returns the number of entries that were skipped during a call to the next().
IterablePosting	getNextPostings() Return the next IterablePosting object, or null if none defined.
int	getNumberOfCurrentPostings() Returns the number of postings in the current IterablePosting object
void	print() Renders the entire structure to stdout

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

getNextPostings

IterablePosting getNextPostings()
                                throws IOException

Return the next IterablePosting object, or null if none defined. Use this method instead of hasNext() and next().

Returns:

IterablePosting postings for next object

Throws:

IOException - if an I/O problem occurs.

getNumberOfCurrentPostings

int getNumberOfCurrentPostings()

Returns the number of postings in the current IterablePosting object

getCurrentPointer

Pointer getCurrentPointer()

Returns the pointer associated with the current postings being accessed

getEntriesSkipped

int getEntriesSkipped()

Returns the number of entries that were skipped during a call to the next().

Returns:

int the number of entries skipped.

print

void print()

Renders the entire structure to stdout