com.raritantechnologies.searchApp.alert
Class AlertOutputProcessor

java.lang.Object
  com.raritantechnologies.searchApp.alert.AlertOutputProcessor

All Implemented Interfaces:

IGatewayOutputProcessor

public class AlertOutputProcessor

extends java.lang.Object

implements IGatewayOutputProcessor

IGatewayOutput processor pipeline for sending alerts. Assumes that "new" documents have been acquired (e.g. from a QueryProcessorGateway or document collection pipeline).

XML Configuration Template:

  <OutputProcessor class="com.raritantechnologies.searchApp.alert.AlertOutputProcessor" 
                      userListSource="[search source name to get user list for alert ]"
                      emailAddressParam="[ result field in user source where email address is stored ]"
                      userNameParam="[ result field in user source where user name is stored ]" >

    <QueryReader class="[ class of com.raritantechnologies.searchApp.query.IQueryResultSetReader ]" >

    </QueryReader>

    <QueryRules>

    </QueryRules>

  </OutputProcessor>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

AlertOutputProcessor()

Method Summary

void	dataComplete() Data feed is complete.
java.lang.String	getConfigurationXML()
void	initialize(org.w3c.dom.Element outputProcElem, ISearchFieldMap sfMap) Initialize the GatewayOutputProcessor from XML Element.
void	initialize(java.util.Map initParams) Used for dynamic initialization (connection, collection name, file name, etc.)
java.lang.String	processData(IResultSet data) returns name of XML File created/appended.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertOutputProcessor

public AlertOutputProcessor()

Method Detail

processData

public java.lang.String processData(IResultSet data)

Description copied from interface: IGatewayOutputProcessor

returns name of XML File created/appended.

Specified by:

processData in interface IGatewayOutputProcessor

dataComplete

public void dataComplete()

Data feed is complete.

Specified by:

dataComplete in interface IGatewayOutputProcessor

initialize

public void initialize(java.util.Map initParams)

Description copied from interface: IGatewayOutputProcessor

Used for dynamic initialization (connection, collection name, file name, etc.)

Specified by:

initialize in interface IGatewayOutputProcessor

initialize

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

Initialize the GatewayOutputProcessor from XML Element.

Specified by:

initialize in interface IGatewayOutputProcessor

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IGatewayOutputProcessor