prajna.entity.alchemy

Class AlchemyDocData

java.lang.Object

prajna.data.DocData

prajna.entity.alchemy.AlchemyDocData

public class AlchemyDocData
extends DocData

DocData object which uses the Alchemy public service at http://www.alchemyapi.com to retrieve the content of a web-accessible document. This extractor requires an API key, which is specified with the setApiKey method. An API key may be obtained from the Alchemy web site.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
AlchemyDocData(java.lang.String url) Create a new AlchemyDocData object for the specified URL
AlchemyDocData(java.net.URL url) Create a new AlchemyDocData object for the specified URL

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBody() Get the body of the document.
java.lang.String	getName() Get the name of the document.
static void	setApiKey(java.lang.String key) Set the API key for Alchemy.

Methods inherited from class prajna.data.DocData

addKey, addKey, addKeyMap, calculateSimilarity, clearKeys, equals, getKeyMap, getKeys, getLink, getSections, getSummary, getTimeStamp, getValueForKey, hashCode, loadContent, matchesKey, setBody, setLink, setName, setSummary, setTimeStamp, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlchemyDocData

public AlchemyDocData(java.lang.String url)
               throws java.net.MalformedURLException

Create a new AlchemyDocData object for the specified URL

Parameters:

url - the URL of the document

Throws:

java.net.MalformedURLException - if the argument is not a valid URL

AlchemyDocData

public AlchemyDocData(java.net.URL url)

Create a new AlchemyDocData object for the specified URL

Parameters:

url - the URL of the document

Method Detail

getBody

public java.lang.String getBody()

Get the body of the document. If the body has not already been retrieved, this method issues a request to Alchemy to parse the document and extract the text.

Overrides:

getBody in class DocData

Returns:

the body

getName

public java.lang.String getName()

Get the name of the document. If the name has not already been retrieved, this method issues a request to Alchemy to parse the document and extract the title.

Overrides:

getName in class DocData

Returns:

the name or title

setApiKey

public static void setApiKey(java.lang.String key)

Set the API key for Alchemy. This must be set prior to retrieving any document data.

Parameters:

key - the Alchemy API key.