org.terrier.realtime.memory

Class MemoryInvertedIndex.InvertedIterator

java.lang.Object

org.terrier.realtime.memory.MemoryInvertedIndex.InvertedIterator

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<IterablePosting>, PostingIndexInputStream

Enclosing class:

MemoryInvertedIndex

public class MemoryInvertedIndex.InvertedIterator
extends Object
implements PostingIndexInputStream

Inverted index iterator.

Constructor Summary

Constructors

Constructor and Description
MemoryInvertedIndex.InvertedIterator()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
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
boolean	hasNext()
IterablePosting	next()
void	print() Renders the entire structure to stdout
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemoryInvertedIndex.InvertedIterator

public MemoryInvertedIndex.InvertedIterator()

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<IterablePosting>

next

public IterablePosting next()

Specified by:

next in interface Iterator<IterablePosting>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

remove

public void remove()

Specified by:

remove in interface Iterator<IterablePosting>

getNextPostings

public IterablePosting getNextPostings()
                                throws IOException

Description copied from interface: PostingIndexInputStream

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

Specified by:

getNextPostings in interface PostingIndexInputStream

Returns:

IterablePosting postings for next object

Throws:

IOException - if an I/O problem occurs.

getNumberOfCurrentPostings

public int getNumberOfCurrentPostings()

Description copied from interface: PostingIndexInputStream

Returns the number of postings in the current IterablePosting object

Specified by:

getNumberOfCurrentPostings in interface PostingIndexInputStream

getCurrentPointer

public Pointer getCurrentPointer()

Description copied from interface: PostingIndexInputStream

Returns the pointer associated with the current postings being accessed

Specified by:

getCurrentPointer in interface PostingIndexInputStream

getEntriesSkipped

public int getEntriesSkipped()

Description copied from interface: PostingIndexInputStream

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

Specified by:

getEntriesSkipped in interface PostingIndexInputStream

Returns:

int the number of entries skipped.

print

public void print()

Description copied from interface: PostingIndexInputStream

Renders the entire structure to stdout

Specified by:

print in interface PostingIndexInputStream