PostingIndexInputStream (Terrier Information Retrieval Platform 5.5 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.util.Iterator<IterablePosting>

All Known Implementing Classes:

BitPostingIndexInputStream, MemoryDirectIndex.DirectIterator, MemoryInvertedIndex.InvertedIterator
```
public interface PostingIndexInputStream
extends java.io.Closeable, java.util.Iterator<IterablePosting>
```
Interface for reading postings from an input stream

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	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
forEachRemaining, hasNext, next, remove

- Method Detail
  - getNextPostings
```
IterablePosting getNextPostings()
                         throws java.io.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:
    
    java.io.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