com.raritantechnologies.searchApp.dataCollection
Class FilteredCollectionGateway

java.lang.Object
  com.raritantechnologies.searchApp.dataCollection.FilteredCollectionGateway

All Implemented Interfaces:

ICollectionGateway, IGatewayListener, java.lang.Runnable

public class FilteredCollectionGateway

extends java.lang.Object

implements ICollectionGateway, IGatewayListener

Collection Gateway that enables an IResultSetFilter to be inserted.

XML Configuration Template:

   <CollectionGateway class="com.raritantechnologies.searchApp.dataCollection.FilteredCollectionGateway" >

     <!-- The "real" collection gateway -->
     <CollectionGateway class="[ class of com.raritantechnologies.searchApp.dataCollection.ICollectionGateway ]" >

     </CollectionGateway>

     <ResultSetFilter class="[ class of com.raritantechnologies.searchApp.IResultSetFilter ]" >

     </ResultSetFilter>

   </CollectionGateway>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

FilteredCollectionGateway()

Method Summary

void	dataComplete(java.lang.Object gateway) Message sent by ICollectionGateway after the last IResultSet has been submitted for processing.
void	gatewayFailed(java.lang.String message)
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	processData(IResultSet dataSet) Command to process a set of results generated by an ICollectionGateway implementation.
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

FilteredCollectionGateway

public FilteredCollectionGateway()

Method Detail

run

public void run()

Specified by:

run 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

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

setInputParameters

public void setInputParameters(OrderedMap inputParams)

Description copied from interface: ICollectionGateway

set input parameters...

Specified by:

setInputParameters in interface ICollectionGateway

setGatewayListener

public void setGatewayListener(IGatewayListener listener)

Sets the IGatewayListener interface.

Specified by:

setGatewayListener 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

processData

public void processData(IResultSet dataSet)

Description copied from interface: IGatewayListener

Command to process a set of results generated by an ICollectionGateway implementation.

Specified by:

processData in interface IGatewayListener

dataComplete

public void dataComplete(java.lang.Object gateway)

Description copied from interface: IGatewayListener

Message sent by ICollectionGateway after the last IResultSet has been submitted for processing.

Specified by:

dataComplete in interface IGatewayListener

gatewayFailed

public void gatewayFailed(java.lang.String message)

Specified by:

gatewayFailed in interface IGatewayListener