com.raritantechnologies.xml.dataCollection.rss
Class RSSDataSource

java.lang.Object
  com.raritantechnologies.xml.dataCollection.rss.RSSDataSource

All Implemented Interfaces:

IConfigurable, IXMLDataSource

public class RSSDataSource

extends java.lang.Object

implements IXMLDataSource

Implementation of IXMLDataSource that acquires XML documents from an RSS Source. May contain a set of IStringFilters to apply to RSS data fields (for example for date conversion).

XML Configuration Template:

  <XMLSource class="com.raritantechnologies.xml.dataCollection.RSSDataSource" 
                rssURL="[URL of rss channel]" >

    <!-- Optional set of StringFilters to apply to data in rss data elements -->
    <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" 
                     tagName="[name or rss data tag to apply filter to ]" >
      <!-- configuration parameters for string filter -->
    </StringFilter>

    <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" 
                     tagName="[another rss data tag to apply filter to ]" >
      <!-- configuration parameters for string filter -->
    </StringFilter>

    <!-- etc... -->
   
  </XMLSource>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

RSSDataSource()

Method Summary

void	addStringFilterMap(java.lang.String tagName, IStringFilter stringFilter)
org.w3c.dom.Document	getNextResult() returns next available document
boolean	hasMoreResults() returns true if more results available, false otherwise
void	init(RaritanPageContext rpc) Initialize the source.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setRssURL(java.lang.String rssURL)
void	setStringFilterMap(java.util.HashMap stringFilterMap)
void	shutdown() close all connections, or other application resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSSDataSource

public RSSDataSource()

Method Detail

init

public void init(RaritanPageContext rpc)

Description copied from interface: IXMLDataSource

Initialize the source. Points to the first available XML Result

Specified by:

init in interface IXMLDataSource

hasMoreResults

public boolean hasMoreResults()

Description copied from interface: IXMLDataSource

returns true if more results available, false otherwise

Specified by:

hasMoreResults in interface IXMLDataSource

getNextResult

public org.w3c.dom.Document getNextResult()

Description copied from interface: IXMLDataSource

returns next available document

Specified by:

getNextResult in interface IXMLDataSource

shutdown

public void shutdown()

Description copied from interface: IXMLDataSource

close all connections, or other application resources.

Specified by:

shutdown in interface IXMLDataSource

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

setRssURL

public void setRssURL(java.lang.String rssURL)

setStringFilterMap

public void setStringFilterMap(java.util.HashMap stringFilterMap)

addStringFilterMap

public void addStringFilterMap(java.lang.String tagName,
                               IStringFilter stringFilter)