com.raritantechnologies.searchApp.query
Class FilterQueryResultSetReader

java.lang.Object
  extended bycom.raritantechnologies.searchApp.query.FilterQueryResultSetReader
All Implemented Interfaces:
IConfigurable, IQueryResultSetReader

public class FilterQueryResultSetReader
extends java.lang.Object
implements IQueryResultSetReader

Applies an IQueryResultSetFilter to a QueryResultBeanSet after reading in the QueryResultSet using a proxy IQueryResultSetReader.

XML Configuration Template:
  <QueryResultSetReader class="com.raritantechnologies.searchApp.query.FilterQueryResultSetReader>

   <QueryResultSetReader class="[ the real class]" >
     <!-- its stuff -->
   </QueryResultSetReader>

   <QueryResultSetFilter class="[the filter class]" >
     *lt;!-- its stuff -->
   </QueryResultSetFilter>

  </QueryResultSetReader>

 
Developed by Raritan Technologies .

Author:
Ted Sullivan

Field Summary
 
Fields inherited from interface com.raritantechnologies.searchApp.query.IQueryResultSetReader
ADHOC, APPLICATION_NAME, DATE, IGNORE_COLUMN, PAGE_SIZE, QUERY_ID, QUERY_NAME, RESP_TIME, ROLE_NAME, SESSION_ID, SOURCE_NAMES, START_REC, TOTAL_DOCS, USER_NAME
 
Constructor Summary
FilterQueryResultSetReader()
           
 
Method Summary
 java.lang.String getConfigurationXML()
           
 IQueryResultSetReader getProxyReader()
           
 IQueryResultSetFilter getQueryResultSetFilter()
           
 void initialize(org.w3c.dom.Element elem)
          Initializes the object from an XML tag or element.
 QueryResultBeanSet readQueries(java.lang.String sessionID, OrderedMap searchParams)
           
 QueryResultBeanSet readQueries(java.lang.String sessionID, OrderedMap searchParams, java.util.Date from, java.util.Date to)
           
 void setAdhocFieldName(java.lang.String fieldName)
           
 void setProxyReader(IQueryResultSetReader proxyReader)
           
 void setQueryParser(IQueryParser queryParser)
          Set the queryParser to be used to transform the query after it is read from the persistent source.
 void setQueryResultSetFilter(IQueryResultSetFilter queryResultFilter)
           
 void setSavedFields(java.lang.String[] savedFields)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterQueryResultSetReader

public FilterQueryResultSetReader()
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 IQueryResultSetReader

readQueries

public QueryResultBeanSet readQueries(java.lang.String sessionID,
                                      OrderedMap searchParams,
                                      java.util.Date from,
                                      java.util.Date to)
Specified by:
readQueries in interface IQueryResultSetReader

readQueries

public QueryResultBeanSet readQueries(java.lang.String sessionID,
                                      OrderedMap searchParams)
Specified by:
readQueries in interface IQueryResultSetReader

setSavedFields

public void setSavedFields(java.lang.String[] savedFields)
Specified by:
setSavedFields in interface IQueryResultSetReader

setAdhocFieldName

public void setAdhocFieldName(java.lang.String fieldName)
Specified by:
setAdhocFieldName in interface IQueryResultSetReader

setProxyReader

public void setProxyReader(IQueryResultSetReader proxyReader)

getProxyReader

public IQueryResultSetReader getProxyReader()

setQueryParser

public void setQueryParser(IQueryParser queryParser)
Description copied from interface: IQueryResultSetReader
Set the queryParser to be used to transform the query after it is read from the persistent source.

Specified by:
setQueryParser in interface IQueryResultSetReader

setQueryResultSetFilter

public void setQueryResultSetFilter(IQueryResultSetFilter queryResultFilter)

getQueryResultSetFilter

public IQueryResultSetFilter getQueryResultSetFilter()

getConfigurationXML

public java.lang.String getConfigurationXML()