com.raritantechnologies.searchApp.query
Class QueryResultBean

java.lang.Object
  com.raritantechnologies.searchApp.query.QueryResultBean

All Implemented Interfaces:

IConfigurable

public class QueryResultBean

extends java.lang.Object

implements IConfigurable

Java Bean which contains the context and results of a Search.

Developed by Raritan Technologies .

Author:

Ted Sullivan

Field Summary

static java.lang.String	APPLICATION_NAME
static java.lang.String	QUERY_ID
static java.lang.String	QUERY_NAME
static java.lang.String	ROLE_NAME
static java.lang.String	SOURCE_NAMES
static java.lang.String	USER_NAME

Constructor Summary

QueryResultBean()

QueryResultBean(java.lang.Integer queryID, ILoginInfo userInfo, OrderedMap inputParameters, java.util.Date theDate, java.lang.Integer pageSize, java.lang.Integer startRec, java.lang.String[] sourceNames, IResultSet results, boolean convertSources)

QueryResultBean(java.lang.Integer queryID, ILoginInfo userInfo, OrderedMap inputParameters, java.util.Date theDate, java.lang.Integer pageSize, java.lang.Integer startRec, java.lang.String[] sourceNames, IResultSet results, boolean convertSources, java.lang.String alternateLoginName)

QueryResultBean(java.lang.Integer queryID, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec, IResultSet results)

QueryResultBean(java.lang.Integer queryID, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec, IResultSet results, java.lang.String alternateLoginName)

QueryResultBean(java.lang.String applicationName, java.lang.Integer queryID, ILoginInfo userInfo, OrderedMap queryParams, IResultSet results)

QueryResultBean(java.lang.String applicationName, java.lang.Integer queryID, ILoginInfo userInfo, OrderedMap queryParams, IResultSet results, java.lang.String alternateLoginName)

QueryResultBean(java.lang.String applicationName, java.lang.String queryName, java.lang.String[] sourceNames, ILoginInfo userInfo, RaritanPageContext pageContext)
Constructor extracts parameters from HTTP request.

QueryResultBean(java.lang.String applicationName, java.lang.String queryName, java.lang.String[] sourceNames, ILoginInfo userInfo, RaritanPageContext pageContext, java.lang.String alternateLoginName)

Method Summary

void	addQueryParam(java.lang.String name, java.lang.String value)
void	addToMemorySource(InMemorySearchSource inMemSS, int maxRecords, int pageSize)
java.lang.String	getAdhocParameter(java.lang.String name)
java.util.Map	getAdhocParameters()
java.lang.String	getApplicationName()
void	getDatedResultSet(DateTimePeriod[] periods, DateSearchField fromDateField, DateSearchField toDateField, boolean saveResults) uses the DateTimePeriod array to get a set of from and to times.
java.util.Date	getDateTime()
long	getElapsedTimeMS()
long	getLastExecutedTime()
java.lang.String	getName()
IResultSet	getNewResults(java.lang.Integer pageSize, java.lang.Integer startRec, DateSearchField dateQuery)
int	getNumberOfQueries()
java.lang.Integer	getPageSize()
java.lang.Integer	getQueryID()
java.lang.String	getQueryParam(java.lang.String name)
OrderedMap	getQueryParameters()
IResultSet	getQueryResults()
java.lang.String	getRoleName()
java.lang.String	getSessionID()
java.lang.String[]	getSourceNames()
SourceLoginInfo[]	getSources()
java.lang.String	getSourcesCSV(java.lang.String delimiter) return a CSV list of the source names.
java.lang.Integer	getStartRec()
int	getTotalDocs()
ILoginInfo	getUserInfo()
java.lang.String	getUserName()
java.lang.String	getXML()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
boolean	isEmptyQuery() returns true if the QueryResultBean's query is empty.
boolean	matchesParameters(OrderedMap searchParams) returns true if the QueryResultBean's search parameters match the set of parameters passed.
IResultSet	reExecuteQuery(java.lang.Integer pageSize, java.lang.Integer startRec) Re-executes the QueryResultBean's query against the SearchSource used for the original query.
IResultSet	reExecuteQuery(java.lang.Integer pageSize, java.lang.Integer startRec, DateSearchField fromDate, DateSearchField toDate) Re-executes the QueryResultBean's query against the SearchSource used for the original query over a specified date range.
IResultSet	reExecuteQuery(SourceLoginInfo[] searchSources, java.lang.Integer pageSize, java.lang.Integer startRec) Re-executes the QueryResultBean's query against the set of SearchSources provided.
IResultSet	reExecuteQuery(SourceLoginInfo[] searchSources, java.lang.Integer pageSize, java.lang.Integer startRec, DateSearchField fromDate, DateSearchField toDate) Re-executes the QueryResultBean's query against the set of SearchSources provided over a specified date range.
void	setAdhocParameter(java.lang.String name, java.lang.String value) "Adhoc" parameters are metadata fields that label or describe the Query.
void	setApplicationName(java.lang.String appName)
void	setName(java.lang.String name)
void	setPageSize(java.lang.Integer pageSize)
void	setQueryID(java.lang.Integer queryID)
void	setQueryParameters(OrderedMap inputParams)
void	setQueryParser(IQueryParser queryParser) Sets the IQueryParser to use for query reExecution.
void	setQueryResults(IResultSet results)
void	setQueryResults(IResultSet results, boolean resetCounts)
void	setRoleName(java.lang.String roleName)
void	setSessionID(java.lang.String sessionID)
void	setSourceNames(java.lang.String[] sourceNames)
void	setStartRec(java.lang.Integer startRec)
void	setUserName(java.lang.String userName)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE_NAME

public static final java.lang.String ROLE_NAME

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

QUERY_NAME

public static final java.lang.String QUERY_NAME

See Also:

Constant Field Values

QUERY_ID

public static final java.lang.String QUERY_ID

See Also:

Constant Field Values

APPLICATION_NAME

public static final java.lang.String APPLICATION_NAME

See Also:

Constant Field Values

SOURCE_NAMES

public static final java.lang.String SOURCE_NAMES

See Also:

Constant Field Values

Constructor Detail

QueryResultBean

public QueryResultBean()

QueryResultBean

public QueryResultBean(java.lang.Integer queryID,
                       SourceLoginInfo[] sources,
                       OrderedMap inputParameters,
                       java.lang.Integer pageSize,
                       java.lang.Integer startRec,
                       IResultSet results)

QueryResultBean

public QueryResultBean(java.lang.Integer queryID,
                       SourceLoginInfo[] sources,
                       OrderedMap inputParameters,
                       java.lang.Integer pageSize,
                       java.lang.Integer startRec,
                       IResultSet results,
                       java.lang.String alternateLoginName)

QueryResultBean

public QueryResultBean(java.lang.Integer queryID,
                       ILoginInfo userInfo,
                       OrderedMap inputParameters,
                       java.util.Date theDate,
                       java.lang.Integer pageSize,
                       java.lang.Integer startRec,
                       java.lang.String[] sourceNames,
                       IResultSet results,
                       boolean convertSources)

QueryResultBean

public QueryResultBean(java.lang.Integer queryID,
                       ILoginInfo userInfo,
                       OrderedMap inputParameters,
                       java.util.Date theDate,
                       java.lang.Integer pageSize,
                       java.lang.Integer startRec,
                       java.lang.String[] sourceNames,
                       IResultSet results,
                       boolean convertSources,
                       java.lang.String alternateLoginName)

QueryResultBean

public QueryResultBean(java.lang.String applicationName,
                       java.lang.Integer queryID,
                       ILoginInfo userInfo,
                       OrderedMap queryParams,
                       IResultSet results)

QueryResultBean

public QueryResultBean(java.lang.String applicationName,
                       java.lang.Integer queryID,
                       ILoginInfo userInfo,
                       OrderedMap queryParams,
                       IResultSet results,
                       java.lang.String alternateLoginName)

QueryResultBean

public QueryResultBean(java.lang.String applicationName,
                       java.lang.String queryName,
                       java.lang.String[] sourceNames,
                       ILoginInfo userInfo,
                       RaritanPageContext pageContext)

Constructor extracts parameters from HTTP request.

QueryResultBean

public QueryResultBean(java.lang.String applicationName,
                       java.lang.String queryName,
                       java.lang.String[] sourceNames,
                       ILoginInfo userInfo,
                       RaritanPageContext pageContext,
                       java.lang.String alternateLoginName)

Method Detail

isEmptyQuery

public boolean isEmptyQuery()

returns true if the QueryResultBean's query is empty.

getDateTime

public java.util.Date getDateTime()

getQueryID

public java.lang.Integer getQueryID()

setQueryID

public void setQueryID(java.lang.Integer queryID)

setPageSize

public void setPageSize(java.lang.Integer pageSize)

getPageSize

public java.lang.Integer getPageSize()

setStartRec

public void setStartRec(java.lang.Integer startRec)

getStartRec

public java.lang.Integer getStartRec()

getQueryParameters

public OrderedMap getQueryParameters()

setQueryParameters

public void setQueryParameters(OrderedMap inputParams)

addQueryParam

public void addQueryParam(java.lang.String name,
                          java.lang.String value)

getQueryParam

public java.lang.String getQueryParam(java.lang.String name)

getQueryResults

public IResultSet getQueryResults()

setQueryResults

public void setQueryResults(IResultSet results)

setQueryResults

public void setQueryResults(IResultSet results,
                            boolean resetCounts)

getUserInfo

public ILoginInfo getUserInfo()

getSources

public SourceLoginInfo[] getSources()

getSourceNames

public java.lang.String[] getSourceNames()

setSourceNames

public void setSourceNames(java.lang.String[] sourceNames)

getSourcesCSV

public java.lang.String getSourcesCSV(java.lang.String delimiter)

return a CSV list of the source names. This uses a treeset to sort things, so it gives a uniform order (for comparison reasons)

getXML

public java.lang.String getXML()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setApplicationName

public void setApplicationName(java.lang.String appName)

getApplicationName

public java.lang.String getApplicationName()

setUserName

public void setUserName(java.lang.String userName)

getUserName

public java.lang.String getUserName()

setRoleName

public void setRoleName(java.lang.String roleName)

getRoleName

public java.lang.String getRoleName()

setSessionID

public void setSessionID(java.lang.String sessionID)

getSessionID

public java.lang.String getSessionID()

matchesParameters

public boolean matchesParameters(OrderedMap searchParams)

returns true if the QueryResultBean's search parameters match the set of parameters passed.

setAdhocParameter

public void setAdhocParameter(java.lang.String name,
                              java.lang.String value)

"Adhoc" parameters are metadata fields that label or describe the Query. They are distinct from the query parameters themselves which 'are' the query. standard adhoc fields: ApplicationName QueryName UserName

getAdhocParameter

public java.lang.String getAdhocParameter(java.lang.String name)

getAdhocParameters

public java.util.Map getAdhocParameters()

setQueryParser

public void setQueryParser(IQueryParser queryParser)

Sets the IQueryParser to use for query reExecution.

reExecuteQuery

public IResultSet reExecuteQuery(java.lang.Integer pageSize,
                                 java.lang.Integer startRec)

Re-executes the QueryResultBean's query against the SearchSource used for the original query.

reExecuteQuery

public IResultSet reExecuteQuery(SourceLoginInfo[] searchSources,
                                 java.lang.Integer pageSize,
                                 java.lang.Integer startRec)

Re-executes the QueryResultBean's query against the set of SearchSources provided.

reExecuteQuery

public IResultSet reExecuteQuery(java.lang.Integer pageSize,
                                 java.lang.Integer startRec,
                                 DateSearchField fromDate,
                                 DateSearchField toDate)

Re-executes the QueryResultBean's query against the SearchSource used for the original query over a specified date range.

reExecuteQuery

public IResultSet reExecuteQuery(SourceLoginInfo[] searchSources,
                                 java.lang.Integer pageSize,
                                 java.lang.Integer startRec,
                                 DateSearchField fromDate,
                                 DateSearchField toDate)

Re-executes the QueryResultBean's query against the set of SearchSources provided over a specified date range.

getNewResults

public IResultSet getNewResults(java.lang.Integer pageSize,
                                java.lang.Integer startRec,
                                DateSearchField dateQuery)

getDatedResultSet

public void getDatedResultSet(DateTimePeriod[] periods,
                              DateSearchField fromDateField,
                              DateSearchField toDateField,
                              boolean saveResults)

uses the DateTimePeriod array to get a set of from and to times. Runs reExecuteQuery on these time periods and either adds the result sets or the result set counts to the DateTimePeriod objects as their dated object depending on the value of saveResults flag.

addToMemorySource

public void addToMemorySource(InMemorySearchSource inMemSS,
                              int maxRecords,
                              int pageSize)

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 IConfigurable

getLastExecutedTime

public long getLastExecutedTime()

getTotalDocs

public int getTotalDocs()

getNumberOfQueries

public int getNumberOfQueries()

getElapsedTimeMS

public long getElapsedTimeMS()