com.raritantechnologies.federated
Class PagingFederatedSearch

java.lang.Object
  com.raritantechnologies.federated.PagingFederatedSearch

All Implemented Interfaces:

IFederatedQueryProcessor, IQueryProcessor

public class PagingFederatedSearch

extends java.lang.Object

implements IQueryProcessor, IFederatedQueryProcessor

Implementation of IQueryProcessor that performs a Federated Search using the RTI FederatedSearch interface. Includes page caching for rapid retrieval of recently retrieved results.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.federated.IFederatedQueryProcessor

FULL_RESULTS, NO_RESULTS, PARTIAL_RESULTS

Constructor Summary

PagingFederatedSearch()

PagingFederatedSearch(int pageStyle)

Method Summary

IResultSet	executeQuery(java.lang.Integer queryID, ISearchFieldMap searchMap, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec) Executes a Query.
IResultSet	getCurrentResults()
int	getResultState()
protected int	getTotalPageSize(SourceLoginInfo[] sources, java.lang.Integer pageSize)
void	setMaxDocCount(int maxDocCounts)
void	setPagingStyle(int pageStyle)

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingFederatedSearch

public PagingFederatedSearch()

PagingFederatedSearch

public PagingFederatedSearch(int pageStyle)

Method Detail

executeQuery

public IResultSet executeQuery(java.lang.Integer queryID,
                               ISearchFieldMap searchMap,
                               SourceLoginInfo[] sources,
                               OrderedMap inputParameters,
                               java.lang.Integer pageSize,
                               java.lang.Integer startRec)
                        throws QueryProcessorException

Description copied from interface: IQueryProcessor

Executes a Query. Returns results in the form of an IResultSet object.

Specified by:

executeQuery in interface IQueryProcessor

Parameters:

queryID - Unique ID for this query. Used by front end to manage queries and query pages. QueryProcessor may use this parameter to organize its search results, and to organize any state information it needs to process future page requests (future executeQuery( ) calls with the same queryID.

searchMap - Provides mapping information needed to translate the inputParameters into a search string appropriate for this type of QueryProcessor. Mapping information is obtained by the application framework from local configuration data.

sources - The LoginInfo and SearchSource(s) to be used for this query. The SearchSource(s) must be of the appropriate type for the QueryProcessor.

inputParameters - Form inputs. Use ISearchFieldMap to translate these into implementation and source-specific fields.

pageSize - Integer specifying the number of results to include in the returned Document. if null - use the default page size.

startRec - Integer specifying the starting record in the result set to be returned. if null - start with the first record.

Returns:

IResultSet containing result set.

Throws:

QueryProcessorException

setMaxDocCount

public void setMaxDocCount(int maxDocCounts)

setPagingStyle

public void setPagingStyle(int pageStyle)

getResultState

public int getResultState()

Specified by:

getResultState in interface IFederatedQueryProcessor

getCurrentResults

public IResultSet getCurrentResults()

Specified by:

getCurrentResults in interface IFederatedQueryProcessor

getTotalPageSize

protected int getTotalPageSize(SourceLoginInfo[] sources,
                               java.lang.Integer pageSize)