edu.ucla.sspace.text

Class DirectoryCorpusReader.BaseFileIterator

java.lang.Object

edu.ucla.sspace.text.DirectoryCorpusReader.BaseFileIterator

All Implemented Interfaces:

Iterator<D>

Direct Known Subclasses:

BloglinesCorpusReader.BloglinesIterator, BloglinesCorpusReader.InnerIterator, ChildesCorpusReader.ChildesFileIterator, ChildesCorpusReader.InnerIterator, SenseEvalDependencyCorpusReader.InnerIterator, TemporalBloglinesCorpusReader.BloglinesIterator, TemporalUsenetCorpusReader.UseNetIterator, UsenetCorpusReader.InnerIterator, UsenetCorpusReader.UseNetIterator

Enclosing class:

DirectoryCorpusReader<D extends Document>

public abstract class DirectoryCorpusReader.BaseFileIterator
extends Object
implements Iterator<D>

Constructor Summary

Constructors

Constructor and Description
DirectoryCorpusReader.BaseFileIterator(Iterator<File> filesToExplore) Creates a new DirectoryCorpusReader.BaseFileIterator.

Method Summary

Methods

Modifier and Type	Method and Description
protected D	advance() Returns the next String representing a complete document that is accessible by this DirectoryCorpusReader.
protected abstract D	advanceInDoc() Returns a new String representing a complete document extracted from currentDoc.
protected String	cleanDoc(String document) Returns a cleaned version of the document if document processing is enabled, otherwise the document text is returned unmodified.
boolean	hasNext()
D	next()
void	remove() Throws UnsupportedOperationException if called.
protected abstract void	setupCurrentDoc(File currentDoc) Sets up any data members needed to process the current file being processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryCorpusReader.BaseFileIterator

public DirectoryCorpusReader.BaseFileIterator(Iterator<File> filesToExplore)

Creates a new DirectoryCorpusReader.BaseFileIterator.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<D extends Document>

next

public D next()

Specified by:

next in interface Iterator<D extends Document>

remove

public void remove()

Throws UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<D extends Document>

advanceInDoc

protected abstract D advanceInDoc()

Returns a new String representing a complete document extracted from currentDoc.

setupCurrentDoc

protected abstract void setupCurrentDoc(File currentDoc)

Sets up any data members needed to process the current file being processed.

cleanDoc

protected String cleanDoc(String document)

Returns a cleaned version of the document if document processing is enabled, otherwise the document text is returned unmodified.

See Also:

DocumentPreprocessor.process(String)

advance

protected D advance()

Returns the next String representing a complete document that is accessible by this DirectoryCorpusReader. If all files have been traversed then this will return null.