com.raritantechnologies.xml.dataCollection
Class SimpleXMLGateway

java.lang.Object
  com.raritantechnologies.xml.dataCollection.SimpleXMLGateway

All Implemented Interfaces:

ICollectionGateway, java.lang.Runnable

public class SimpleXMLGateway

extends java.lang.Object

implements ICollectionGateway

Basic implementation of ICollectionGateway that uses an IXMLDataSource. Also includes a XMLResultProcessor to process the initial XML into an XMLResultSet. XML Data sources for files (FileXMLDataSource), FTP sites (FTPXMLDataSource), HTTP (HTTPXMLDataSource) and RSS feeds (RSSDataSource) are available.

XML Configuration Template:

  <CollectionGateway class="com.raritantechnologies.xml.dataCollection.SimpleXMLGateway"
                        resultTag="[result tag name]"
                        wrapCData="[true(default)|false ]"
                        resultSetSize="[ number of results in each result set to process ]" >

    <XMLSource class="[Implementation class of IXMLDataSource]" >

    </XMLSource>

    <!-- Optional XSLT Transform -->
    <XSLTransform fileName="[ file name of XSLTransform ]" />

    <XMLResultProcessor>

    </XMLResultProcessor>

  </CollectionGateway>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

SimpleXMLGateway()

Method Summary

java.lang.String	getConfigurationXML()
void	initialize(org.w3c.dom.Element gatewayElem, ISearchFieldMap sfMap) Initialize the ICollectionGateway from a Configuration XML element.
boolean	isPaused()
void	pause()
void	resume()
void	run()
void	run(ILoginInfo userInfo) Need to have loginInfo for sources which require login/pw access.
void	setGatewayListener(IGatewayListener listener) Sets the IGatewayListener interface.
void	setInputParameters(OrderedMap inputParams) set input parameters...

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleXMLGateway

public SimpleXMLGateway()

Method Detail

setInputParameters

public void setInputParameters(OrderedMap inputParams)

Description copied from interface: ICollectionGateway

set input parameters...

Specified by:

setInputParameters in interface ICollectionGateway

run

public void run()

Specified by:

run in interface ICollectionGateway

run

public void run(ILoginInfo userInfo)

Description copied from interface: ICollectionGateway

Need to have loginInfo for sources which require login/pw access.

Specified by:

run in interface ICollectionGateway

setGatewayListener

public void setGatewayListener(IGatewayListener listener)

Sets the IGatewayListener interface.

Specified by:

setGatewayListener in interface ICollectionGateway

pause

public void pause()

Specified by:

pause in interface ICollectionGateway

resume

public void resume()

Specified by:

resume in interface ICollectionGateway

isPaused

public boolean isPaused()

Specified by:

isPaused in interface ICollectionGateway

initialize

public void initialize(org.w3c.dom.Element gatewayElem,
                       ISearchFieldMap sfMap)

Initialize the ICollectionGateway from a Configuration XML element.

Specified by:

initialize in interface ICollectionGateway

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface ICollectionGateway