com.raritantechnologies.searchApp.dataCollection
Interface ICollectionGateway

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

DocumentumGateway, ERoomGateway, FileSystemGateway, FilteredCollectionGateway, FlatFileGateway, GoogleConnectorGateway, HTMLScraperGateway, QueryProcessorGateway, QueryProcessorGateway, QueryProcessorXMLGateway, SimpleXMLGateway, TreeBuilderGateway, WebCrawlerGateway, WebDAVGateway

public interface ICollectionGateway

extends java.lang.Runnable

Collection Gateway implementations are responsible for collecting raw data and formatting it as IResultSet objects. The data is then processed by an IGatewayListener which feeds the data to IGatewayOutputProcessor implementations which can create collections or other types of outputs (Parametric Indexes, databases, etc.).

Developed by Raritan Technologies .

Author:

Ted Sullivan

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...

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

pause

public void pause()

resume

public void resume()

isPaused

public boolean isPaused()

run

public void run(ILoginInfo userInfo)

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

setInputParameters

public void setInputParameters(OrderedMap inputParams)

set input parameters...

setGatewayListener

public void setGatewayListener(IGatewayListener listener)

Sets the IGatewayListener interface.

initialize

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

Initialize the ICollectionGateway from a Configuration XML element.

getConfigurationXML

public java.lang.String getConfigurationXML()