prajna.entity.alchemy

Class AlchemyRssDocReader

java.lang.Object

prajna.io.RssDocReader

prajna.entity.alchemy.AlchemyRssDocReader

All Implemented Interfaces:

FormatReader<DocData>

public class AlchemyRssDocReader
extends RssDocReader

Implementation of an RSS Document reader that reads RssItems from a reader, and creates DocData objects for each RSS item. The reader returns AlchemyDocData objects. The RssReader must be configured, and the Alchemy API key in the AlchemyDocData object must be set before this class can create documents.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
AlchemyRssDocReader() Create a new AlchemyRssDocReader.
AlchemyRssDocReader(FormatReader<RssItem> rssReader) Create a new AlchemyRssDocReader that reads Rss items from the RssReader

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.
protected DocData	convertUrl(java.net.URL url) Convert a webpage, specified by URL, into a DocData object
java.lang.String	toString() Return a String representation of this reader

Methods inherited from class prajna.io.RssDocReader

close, getFilters, getSource, hasMoreData, readData, setFilters, setSource

Methods inherited from class java.lang.Object

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

Constructor Detail

AlchemyRssDocReader

public AlchemyRssDocReader()

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

AlchemyRssDocReader

public AlchemyRssDocReader(FormatReader<RssItem> rssReader)

Create a new AlchemyRssDocReader that reads Rss items from the RssReader

Parameters:

rssReader - The RssReader

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 and if the Alchemy API key has been set.

Specified by:

canRead in interface FormatReader<DocData>

Overrides:

canRead in class RssDocReader

Returns:

true if it can read data, false otherwise

convertUrl

protected DocData convertUrl(java.net.URL url)

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

Overrides:

convertUrl in class RssDocReader

Parameters:

url - the URL

Returns:

a DocData object containing the document contents of the URL

toString

public java.lang.String toString()

Return a String representation of this reader

Overrides:

toString in class RssDocReader

Returns:

a string representation of this reader