prajna.io

Class RssDocReader

java.lang.Object

prajna.io.RssDocReader

All Implemented Interfaces:

FormatReader<DocData>

Direct Known Subclasses:

AlchemyRssDocReader

public class RssDocReader
extends java.lang.Object
implements FormatReader<DocData>

Convert the documents from an RSS feed into DocData objects.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
RssDocReader() Create a new RssDocReader.
RssDocReader(FormatReader<RssItem> rssReader) Create a new RssDocReader that reads RSS items from the RssReader
RssDocReader(java.lang.String urlStr) Create a new RssDocReader, reading from the specified URL.

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
protected DocData	convertUrl(java.net.URL url) Convert a webpage, specified by URL, into a DocData object
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<DocData>	readData() Read data from the underlying RssReader.
void	setFilters(java.lang.String filters) Set filters for this reader
void	setSource(java.lang.String source) Set the source for this FormatReader.
java.lang.String	toString() Return a String representation of this reader

Methods inherited from class java.lang.Object

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

Constructor Detail

RssDocReader

public RssDocReader()

Create a new RssDocReader. The reader will need to have an RSS source provided by the setSource() method.

RssDocReader

public RssDocReader(FormatReader<RssItem> rssReader)

Create a new RssDocReader that reads RSS items from the RssReader

Parameters:

rssReader - The RssReader

RssDocReader

public RssDocReader(java.lang.String urlStr)
             throws java.io.IOException,
                    org.xml.sax.SAXException

Create a new RssDocReader, reading from the specified URL.

Parameters:

urlStr - the RSS feed URL string

Throws:

java.io.IOException - if there is a problem opening a connection to the stream

org.xml.sax.SAXException - if there is a problem reading the data from the stream

Method Detail

canRead

public boolean canRead()

Return whether this reader is in a state where it can attempt to read data. This call checks to see if the underlying RSS reader can read data.

Specified by:

canRead in interface FormatReader<DocData>

Returns:

true if it can read data, false otherwise

close

public void close()

close this reader

Specified by:

close in interface FormatReader<DocData>

convertUrl

protected DocData convertUrl(java.net.URL url)

Convert a webpage, specified by URL, into a DocData object

Parameters:

url - the URL

Returns:

a DocData object containing the document contents of the URL

getFilters

public java.lang.String getFilters()

Get the filters for this reader.

Specified by:

getFilters in interface FormatReader<DocData>

Returns:

the filters for this reader

getSource

public java.lang.String getSource()

Get the source for this reader

Specified by:

getSource in interface FormatReader<DocData>

Returns:

the source for this reader

hasMoreData

public boolean hasMoreData()

Returns whether the reader has more data to read. This method checks the underlying RssReader to see if it has more data

Specified by:

hasMoreData in interface FormatReader<DocData>

Returns:

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

readData

public java.util.List<DocData> readData()

Read data from the underlying RssReader. For each RssItem, this method creates a new AlchemyDocData object. It sets the title, timestamp, and body of the document. It adds keys for each category listed in the RssItem

Specified by:

readData in interface FormatReader<DocData>

Returns:

the list of DocData objects created by this method.

setFilters

public void setFilters(java.lang.String filters)

Set filters for this reader

Specified by:

setFilters in interface FormatReader<DocData>

Parameters:

filters - the filters for this reader

setSource

public void setSource(java.lang.String source)

Set the source for this FormatReader. This method passes the source to the underlying RSS FormatReader.

Specified by:

setSource in interface FormatReader<DocData>

Parameters:

source - the source for this reader. The source should be the URL for an RSS feed

toString

public java.lang.String toString()

Return a String representation of this reader

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this reader