edu.ucla.sspace.text

Class LimitedOneLinePerDocumentIterator

java.lang.Object

edu.ucla.sspace.text.LimitedOneLinePerDocumentIterator

All Implemented Interfaces:

Iterator<Document>

public class LimitedOneLinePerDocumentIterator
extends Object
implements Iterator<Document>

An iterator decorator that returns Document instances given a file that contains list of files. This iterator allows an upper limit on the number of documents returned to be set. Once this limit has been reached, the iterator must be reset before it can return more documents.

This class is thread-safe.

Constructor Summary

Constructors

Constructor and Description
LimitedOneLinePerDocumentIterator(Iterator<Document> iter, int docLimit, boolean useMultipleResets) 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.
void	reset() Reset the iterator so that new documents may be returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitedOneLinePerDocumentIterator

public LimitedOneLinePerDocumentIterator(Iterator<Document> iter,
                                 int docLimit,
                                 boolean useMultipleResets)
                                  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>

reset

public void reset()

Reset the iterator so that new documents may be returned.

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<Document>