prajna.io

Interface FormatReader<X>

Type Parameters:

X - The object type read by this reader

All Known Implementing Classes:

AlchemyRssDocReader, MSWordDocReader, PdfDocReader, PstDocReader, RssDocReader, RssReader, SemanticXmlReader, SwrlReader, TabbedRecordReader, XmlDocReader

public interface FormatReader<X>

Class representing a generalized format reader which reads a series of objects from an InputStream.

Author:

Edward Swing

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead() Return whether this reader is in a state where it can attempt to read data.
void	close() Close this reader.
java.lang.String	getFilters() Get the filters for this reader.
java.lang.String	getSource() Get the source for this reader
boolean	hasMoreData() Returns whether the reader has more data to read.
java.util.List<X>	readData() Read the series of data elements.
void	setFilters(java.lang.String filters) Set filters for the items returned by this reader.
void	setSource(java.lang.String source) Set the source for this reader.

Method Detail

canRead

boolean canRead()

Return whether this reader is in a state where it can attempt to read data. This call is typically used to determine if the reader has been initialized properly, but can also serve to check other status depending on the reader.

Returns:

true if it can read data, false otherwise

close

void close()

Close this reader. This method should close the input stream, and clean up.

getFilters

java.lang.String getFilters()

Get the filters for this reader. This method should return the string passed into the setFilters() method.

Returns:

the filters for this reader

getSource

java.lang.String getSource()

Get the source for this reader

Returns:

the source for this reader

hasMoreData

boolean hasMoreData()

Returns whether the reader has more data to read.

Returns:

true if the reader has more data to read, false otherwise

readData

java.util.List<X> readData()

Read the series of data elements.

Returns:

the list of data elements, returned in order they are read.

setFilters

void setFilters(java.lang.String filters)

Set filters for the items returned by this reader. The format of the filter string is implementation-dependent.

Parameters:

filters - the filters for this reader

setSource

void setSource(java.lang.String source)

Set the source for this reader. The source may be a URL, file, or directory, depending on the reader. When this method is called, the reader should flush any objects that are pending a readData() call.

Parameters:

source - the source for the reader