com.raritantechnologies.federated.eRoom
Class UserERoomsQueryProcessorFilter

java.lang.Object
  com.raritantechnologies.searchApp.QueryProcessorFilter
      com.raritantechnologies.federated.eRoom.UserERoomsQueryProcessorFilter

All Implemented Interfaces:

IQueryProcessor

public class UserERoomsQueryProcessorFilter

extends QueryProcessorFilter

Selects eRoom collections that a user has access to.

XML Configuration Template:

   <SourceType name="filteredSource Name" 
                  inputSource  = "[ name of delegate SearchSource ]"
                  type="[ type of real search source ]"
                  sourceFactoryClass="com.raritantechnologies.searchApp.QueryProcessorFilterFactory"
                  filterClass  = "com.raritantechnologies.federated.eRoom.UserERoomsQueryProcessorFilter"
                  eRoomLogSource = "[ search source to get eRoom collection mapping information ]"
                  eRoomUserAttribute="[ Attribute added by system ERoomUserInfoReader ]"
                  eRoomURIDelimiter="|"
                  selectCollectionField="[ name of field in inputParameters to put collection name list ]" >

     <LogIndexMap
           eRoomNameField     ="[ name of eRoomName field in logging database ]" 
           eRoomURLField      ="[ name of eRoomURL field in logging database ]"
           collectionNameField="[ name of collection name field in logging database ]"
           lastIndexTimeField ="[ name of last index time field in logging database ]"
           lastIndexTimeFormat="[ format of last index time data ]"
     /> 

     <!-- Can define Local ERoomUserInfoReader - just used by this Filter: -->
     <ERoomUserInfoReader 
                eRoomSecurityManagers="[ comma separated list of ERoomSecurityManagers ]"
                uriPattern="[ optional pattern to store eRoom URI: use {EROOM_NAME} {EROOM_URL} to specify 
                              where parameter values are to be inserted ]" />

  </SourceType>
 

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.QueryProcessorFilter

theQueryProcessor

Constructor Summary

UserERoomsQueryProcessorFilter()

Method Summary

IResultSet	executeQuery(java.lang.Integer queryID, ISearchFieldMap searchMap, SourceLoginInfo[] sources, OrderedMap inputParameters, java.lang.Integer pageSize, java.lang.Integer startRec) Base implementation executes the query then starts filter chain.
void	initialize(org.w3c.dom.Element elem) subclasses should override this to initialize themselves.

Methods inherited from class com.raritantechnologies.searchApp.QueryProcessorFilter

doExecuteQuery, filterResultSet, getQueryProcessor, getQueryProcessor, getRealSources, setNextFilter, setQueryProcessor

Methods inherited from class java.lang.Object

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

Constructor Detail

UserERoomsQueryProcessorFilter

public UserERoomsQueryProcessorFilter()

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 class: QueryProcessorFilter

Base implementation executes the query then starts filter chain.

Specified by:

executeQuery in interface IQueryProcessor

Overrides:

executeQuery in class QueryProcessorFilter

Throws:

QueryProcessorException

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from class: QueryProcessorFilter

subclasses should override this to initialize themselves.

Overrides:

initialize in class QueryProcessorFilter