edu.ucla.sspace.text

Interface CorpusReader<D extends Document>

All Known Implementing Classes:

BloglinesCorpusReader, BloglinesCorpusReader, ChildesCorpusReader, ChildesCorpusReader, DirectoryCorpusReader, PukWacCorpusReader, PukWacDependencyCorpusReader, SemEvalCorpusReader, SemEvalLexSubReader, SenseEvalDependencyCorpusReader, SenseEvalDependencyCorpusReader, TemporalBloglinesCorpusReader, TemporalBloglinesCorpusReader, TemporalUsenetCorpusReader, TemporalUsenetCorpusReader, UsenetCorpusReader, UsenetCorpusReader

public interface CorpusReader<D extends Document>

A basic interface for setting up a CorpusReader, which reads un cleaned text from corpus files and transforms them into an appropriately cleaned Document instance.

Author:

Keith Stevens

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<D>	read(File file) Returns a Iterator that traverses the documents containted in the given file.
Iterator<D>	read(Reader baseReader) Retrusn a Iterator that traverses the documents contained in baseReader.

Method Detail

read

Iterator<D> read(File file)

Returns a Iterator that traverses the documents containted in the given file.

Parameters:

file - A text file holding documents in a format that is readable by a particular CorpusReader. This text file may have it's own unique text structure or an xml format. Each CorpusReader should specify the expected text format.

read

Iterator<D> read(Reader baseReader)

Retrusn a Iterator that traverses the documents contained in baseReader.

Parameters:

baseReader - A Reader that will extract text from a data source, such as a URL, a File, a data stream, or any other source accesible via the Reader interface. Each CorpusReader should specify the expected text format, be it an XML schema or some other unique format.