prajna.structure

Class PollingCorpus

java.lang.Object

prajna.structure.DocCorpus

prajna.structure.PollingCorpus

All Implemented Interfaces:

java.lang.Runnable

public class PollingCorpus
extends DocCorpus
implements java.lang.Runnable

This class implements a document corpus which polls a URL for document updates. The PollingCorpus can be run as a thread, or have its poll() method invoked at any time. The poll() method opens the URL, and parses the resulting stream using the Document Parser. The document parser and polling URL must both be set before polling.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
PollingCorpus() Create a new PollingCorpus with no polling URL or parser defined.
PollingCorpus(FormatReader<DocData> docParser) Create a new PollingCorpus with a document parser.

Method Summary

Methods

Modifier and Type	Method and Description
FormatReader<DocData>	getParser() Gets the document parser.
boolean	isPolling() Checks if this polling corpus is currently polling.
boolean	poll() Poll the URL to retrieve any new data.
void	run() Run the polling loop of this Polling Corpus.
void	setParser(FormatReader<DocData> docParser) Sets the document parser.
void	setPollTime(int seconds) Sets the poll time.

Methods inherited from class prajna.structure.DocCorpus

addDocData, clearCorpus, createSubCorpus, findDocData, getAllKeys, getCorpus, getCorpusSize, getKeyGraph, getSimilarityGraph, hasMoreData, isGraphDynamic, loadCorpus, removeDoc, setGraphDynamic

Methods inherited from class java.lang.Object

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

Constructor Detail

PollingCorpus

public PollingCorpus()

Create a new PollingCorpus with no polling URL or parser defined.

PollingCorpus

public PollingCorpus(FormatReader<DocData> docParser)

Create a new PollingCorpus with a document parser.

Parameters:

docParser - the parser used to parse the content from the URL

Method Detail

getParser

public FormatReader<DocData> getParser()

Gets the document parser.

Returns:

the document parser

isPolling

public boolean isPolling()

Checks if this polling corpus is currently polling. The corpus is polling if the run() method has been invoked, and the poll time is greater than zero.

Returns:

whether this corpus is currently polling its source

poll

public boolean poll()

Poll the URL to retrieve any new data. This method opens the URL stream, and retrieves any data. This data is passed to the document parser, which converts the records into Document Data records.

Returns:

true if the corpus changes as a result of this call, false otherwise

run

public void run()

Run the polling loop of this Polling Corpus. As long as the poll time is greater than zero, the run() method will execute. It will call poll() after every polling interval.

Specified by:

run in interface java.lang.Runnable

setParser

public void setParser(FormatReader<DocData> docParser)

Sets the document parser.

Parameters:

docParser - the document parser

setPollTime

public void setPollTime(int seconds)

Sets the poll time. This specifies the wait time between polling intervals. The poll time is specified in seconds. If not set, the poll time is zero.

Parameters:

seconds - the new poll time