com.raritantechnologies.searchApp.scheduler
Class QueryProcessorPipeline

java.lang.Object
  com.raritantechnologies.searchApp.scheduler.QueryProcessorPipeline

All Implemented Interfaces:

IConfigurable, IJobProcess, IReportingProcess

public class QueryProcessorPipeline

extends java.lang.Object

implements IJobProcess, IReportingProcess

End-to-end query processor pipeline Job Process. Executes a query against a search source and passes the results to an IResultSetProcessor.

XML Configuration Template:

   <JobProcess class="com.raritantechnologies.searchApp.scheduler.QueryProcessorPipeline" 
                            searchSource="sourceName" 
                            userName="userName"
                            password="userPassword" >
     <QueryList>
       <Query>
        <Field ID="[a search field]" value="[value to search]" />
        <Field ID="[another field]" value="[value to search]" />
       </Query>
       <Query>
        <Field ID="[a search field]" value="[value to search]" />
        <Field ID="[another field]" value="[value to search]" />
       </Query>
     </QueryList>

     <!-- One or more FieldFormatters -->
     <FieldFormatter class="[ class of com.raritantechnologies.searchApp.IFieldFormatter ]" >

     </FieldFormatter>

     <!-- ResultSetProcessor: used for persistence of query results -->
     <ResultSetProcessor class="[some IResultSetProcessor instance]" >
       <!-- ResultSetProcessor initialization data . . . -->
     </ResultSetProcessor>

     <!-- Alternately: use GatewayOutputProcessor: used for persistence of query results -->
     <GatewayOutputProcessor class="[some IResultSetProcessor instance]" >
       <!-- GatewayOutputProcessor initialization data . . . -->
     </GatewayOutputProcessor>

     <!-- As Reporting Process: need an IReporter and an IDisplayFormRenderer -->
     <Reporting name="[ optional name of display form ]" 
                   pageSize="[ optional page size for reporting display pages ]" >

        </Reporter class="[ class of com.raritantechnologies.searchApp.reporting.IReporter ]" >

        </Reporter>

        <DisplayFormRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IDisplayFormRenderer ]" >

        </DisplayFormRenderer>

     </Reporting> 
 
  </JobProcess>

 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Constructor Summary

QueryProcessorPipeline()

Method Summary

void	executeJob(RaritanPageContext rpc)
void	executeJob(java.lang.String[] args)
void	executeJob(java.lang.String sessionID, IReporter reporter, SourceLoginInfo[] sources, OrderedMap searchParams, java.lang.String[] args)
java.lang.String	getConfigurationXML()
IGatewayOutputProcessor	getGatewayOutputProcessor()
IQueryList	getQueryList()
IReporter	getReporter() returns the IReporter used by this reporting process.
IResultSetProcessor	getResultSetProcessor()
SourceLoginInfo[]	getSearchSources()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setGatewayOutputProcessor(IGatewayOutputProcessor outputProc)
void	setQueryList(IQueryList queryList)
void	setReporter(IReporter reporter) sets the Reporter to use for data output handling.
void	setResultSetProcessor(IResultSetProcessor resSetProc)
void	setSearchParams(OrderedMap searchParams)
void	setSearchSources(SourceLoginInfo[] sources)
void	setSessionID(java.lang.String sessionID)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryProcessorPipeline

public QueryProcessorPipeline()

Method Detail

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 IJobProcess

executeJob

public void executeJob(RaritanPageContext rpc)

Specified by:

executeJob in interface IJobProcess

executeJob

public void executeJob(java.lang.String[] args)

Specified by:

executeJob in interface IJobProcess

getQueryList

public IQueryList getQueryList()

setQueryList

public void setQueryList(IQueryList queryList)

setReporter

public void setReporter(IReporter reporter)

Description copied from interface: IReportingProcess

sets the Reporter to use for data output handling.

Specified by:

setReporter in interface IReportingProcess

Parameters:

reporter - The IReporter object that will handle data saving etc.

getReporter

public IReporter getReporter()

Description copied from interface: IReportingProcess

returns the IReporter used by this reporting process.

Specified by:

getReporter in interface IReportingProcess

setResultSetProcessor

public void setResultSetProcessor(IResultSetProcessor resSetProc)

getResultSetProcessor

public IResultSetProcessor getResultSetProcessor()

setGatewayOutputProcessor

public void setGatewayOutputProcessor(IGatewayOutputProcessor outputProc)

getGatewayOutputProcessor

public IGatewayOutputProcessor getGatewayOutputProcessor()

setSearchSources

public void setSearchSources(SourceLoginInfo[] sources)

Specified by:

setSearchSources in interface IReportingProcess

getSearchSources

public SourceLoginInfo[] getSearchSources()

Specified by:

getSearchSources in interface IReportingProcess

setSearchParams

public void setSearchParams(OrderedMap searchParams)

Specified by:

setSearchParams in interface IReportingProcess

setSessionID

public void setSessionID(java.lang.String sessionID)

Specified by:

setSessionID in interface IReportingProcess

executeJob

public void executeJob(java.lang.String sessionID,
                       IReporter reporter,
                       SourceLoginInfo[] sources,
                       OrderedMap searchParams,
                       java.lang.String[] args)

Specified by:

executeJob in interface IReportingProcess

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IJobProcess