edu.ucla.sspace.text

Class OneLinePerDocumentIterator

java.lang.Object

edu.ucla.sspace.text.OneLinePerDocumentIterator

All Implemented Interfaces:

Iterator<Document>

public class OneLinePerDocumentIterator
extends Object
implements Iterator<Document>

An iterator implementation that returns Document instances given a file that contains list of files.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
OneLinePerDocumentIterator(String documentsFile) Constructs an Iterator for the documents contained in the provided file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are more documents in the provided file.
Document	next() Returns the next document from the file.
void	remove() Throws an UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

OneLinePerDocumentIterator

public OneLinePerDocumentIterator(String documentsFile)
                           throws IOException

Constructs an Iterator for the documents contained in the provided file.

Parameters:

documentsFile - a file that contains one document per line

Throws:

IOException - if any error occurs when reading documentsFile

Method Detail

hasNext

public boolean hasNext()

Returns true if there are more documents in the provided file.

Specified by:

hasNext in interface Iterator<Document>

next

public Document next()

Returns the next document from the file.

Specified by:

next in interface Iterator<Document>

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<Document>