org.terrier.structures

Class FSOMapFileLexiconGeneric.MapFileLexiconEntryIterator<T extends org.apache.hadoop.io.WritableComparable<?>>

java.lang.Object

org.terrier.structures.FSOMapFileLexiconGeneric.MapFileLexiconEntryIterator<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<LexiconEntry>, Skipable

Direct Known Subclasses:

FSOMapFileLexicon.MapFileLexiconEntryIterator

Enclosing class:

FSOMapFileLexiconGeneric<K1,K2 extends org.apache.hadoop.io.WritableComparable>

public static class FSOMapFileLexiconGeneric.MapFileLexiconEntryIterator<T extends org.apache.hadoop.io.WritableComparable<?>>
extends Object
implements Iterator<LexiconEntry>, Closeable, Skipable

Iterate through the values in order

Field Summary

Fields

Modifier and Type	Field and Description
protected Iterator<Map.Entry<T,LexiconEntry>>	internalIterator

Constructor Summary

Constructors

Constructor and Description
MapFileLexiconEntryIterator(Iterator<Map.Entry<T,LexiconEntry>> _internalIterator) Construct an instance of the class with
MapFileLexiconEntryIterator(String filename, FixedSizeWriteableFactory<T> keyFactory, FixedSizeWriteableFactory<LexiconEntry> valueFactory) Construct an instance of the class with
MapFileLexiconEntryIterator(String structureName, IndexOnDisk index) Construct an instance of the class with
MapFileLexiconEntryIterator(String structureName, String path, String prefix, FixedSizeWriteableFactory<T> keyFactory, FixedSizeWriteableFactory<LexiconEntry> valueFactory) Construct an instance of the class with

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasNext()
LexiconEntry	next()
void	remove()
void	skip(int numEntries) Skip forward the specified number of entries.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

internalIterator

protected Iterator<Map.Entry<T extends org.apache.hadoop.io.WritableComparable<?>,LexiconEntry>> internalIterator

Constructor Detail

MapFileLexiconEntryIterator

public MapFileLexiconEntryIterator(String structureName,
                                   IndexOnDisk index)
                            throws IOException

Construct an instance of the class with

Parameters:

structureName -

index -

Throws:

IOException

MapFileLexiconEntryIterator

public MapFileLexiconEntryIterator(String structureName,
                                   String path,
                                   String prefix,
                                   FixedSizeWriteableFactory<T> keyFactory,
                                   FixedSizeWriteableFactory<LexiconEntry> valueFactory)
                            throws IOException

Construct an instance of the class with

Parameters:

structureName -

path -

prefix -

keyFactory -

valueFactory -

Throws:

IOException

MapFileLexiconEntryIterator

public MapFileLexiconEntryIterator(String filename,
                                   FixedSizeWriteableFactory<T> keyFactory,
                                   FixedSizeWriteableFactory<LexiconEntry> valueFactory)
                            throws IOException

Construct an instance of the class with

Parameters:

filename -

keyFactory -

valueFactory -

Throws:

IOException

MapFileLexiconEntryIterator

public MapFileLexiconEntryIterator(Iterator<Map.Entry<T,LexiconEntry>> _internalIterator)

Construct an instance of the class with

Parameters:

_internalIterator -

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<LexiconEntry>

next

public LexiconEntry next()

Specified by:

next in interface Iterator<LexiconEntry>

remove

public void remove()

Specified by:

remove in interface Iterator<LexiconEntry>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

skip

public void skip(int numEntries)
          throws IOException

Skip forward the specified number of entries. Should be followed by a next() call.

Specified by:

skip in interface Skipable

Parameters:

numEntries - number of entries to skip

Throws:

IOException - if an IO problem occurs.