com.raritantechnologies.verity.parametric
Class ParametricQueryProcessor

java.lang.Object
  com.raritantechnologies.verity.parametric.ParametricQueryProcessor

All Implemented Interfaces:

IQueryProcessor

Direct Known Subclasses:

OrderingParametricQueryProcessor, SortingParametricQueryProcessor

public class ParametricQueryProcessor

extends java.lang.Object

implements IQueryProcessor

Executes a parametric search using VParametricSearch API.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

protected ParaDocumentSearcher	documentSearcher
protected static VParametricSearch	vPSearch

Constructor Summary

ParametricQueryProcessor()

Method Summary

void	dumpPI(PI pi)
IResultSet	executeQuery(java.lang.Integer queryID, ISearchFieldMap searchMap, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec) Executes a Query.
java.lang.String	getCookedQuery(ParametricSearchSource pss, OrderedMap queryParams, ILoginInfo userInfo)
java.lang.String	getCookedQueryParam()
EnumView	getEnumView(java.lang.String fieldname)
KTreeView	getKTreeView(java.lang.String fieldname)
protected ParametricResultSet	getParametricResults(java.lang.Integer queryID, ParametricResult paraResult, int startRec, int pageSize, ParametricSearchSource pss, OrderedMap inputParameters)
IQueryCooker	getQueryCooker()
java.lang.String	getSimpleQueryParam()
void	initialize(ParametricSearchSource pss, java.util.Map searchParams)
void	initializeSecurity(VParametricSearch vPSearch, SourceLoginInfo[] sources)
void	setCookQuery(boolean cookQuery)
void	setQueryCooker(IQueryCooker qCooker)
void	setSimpleQueryParam(java.lang.String queryParam)

Methods inherited from class java.lang.Object

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

Field Detail

vPSearch

protected static VParametricSearch vPSearch

documentSearcher

protected ParaDocumentSearcher documentSearcher

Constructor Detail

ParametricQueryProcessor

public ParametricQueryProcessor()

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

getParametricResults

protected ParametricResultSet getParametricResults(java.lang.Integer queryID,
                                                   ParametricResult paraResult,
                                                   int startRec,
                                                   int pageSize,
                                                   ParametricSearchSource pss,
                                                   OrderedMap inputParameters)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

initialize

public void initialize(ParametricSearchSource pss,
                       java.util.Map searchParams)

dumpPI

public void dumpPI(PI pi)

initializeSecurity

public void initializeSecurity(VParametricSearch vPSearch,
                               SourceLoginInfo[] sources)

getKTreeView

public KTreeView getKTreeView(java.lang.String fieldname)

getEnumView

public EnumView getEnumView(java.lang.String fieldname)

setQueryCooker

public void setQueryCooker(IQueryCooker qCooker)

getQueryCooker

public IQueryCooker getQueryCooker()

setSimpleQueryParam

public void setSimpleQueryParam(java.lang.String queryParam)

setCookQuery

public void setCookQuery(boolean cookQuery)

getCookedQuery

public java.lang.String getCookedQuery(ParametricSearchSource pss,
                                       OrderedMap queryParams,
                                       ILoginInfo userInfo)

getCookedQueryParam

public java.lang.String getCookedQueryParam()

getSimpleQueryParam

public java.lang.String getSimpleQueryParam()