com.raritantechnologies.searchApp
Class SelectedRecordsSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.searchApp.SelectedRecordsSearchSource

All Implemented Interfaces:

IXMLSearchSourceFactory

public class SelectedRecordsSearchSource

extends SearchSource

implements IXMLSearchSourceFactory

Provides a SearchSource for the selected records in a user session. Records can be selected by the user adding a CheckboxResultRenderer. The selected results can then be displayed, sorted, etc using a StaticDisplayForm linked to the SelectedRecordsSearchSource.

XML Configuration Template:

  <SourceType name="[ name of SelectedRecords source ]" type="SelectedRecordsSearchSource"
            sourceFactoryClass="com.raritantechnologies.searchApp.SelectedRecordsSearchSource" 
            queryProcessor="com.raritantechnologies.searchApp.SelectedRecordsSearchSource" 
            cacheResultSetName="[ name to use as session cache key of selected results ]" 
            cacheFieldID="[ fieldID of cached records ]" >

    <!-- Use QueryFields if want to search within the selected records set -->
    <QueryFields>
      <Field inputField="[ name of field in input parameters ]" queryField="[ name of field in query ]" />
    </QueryFields>

  </SourceType>
 

Developed by Raritan Technologies .

Author:

Ted Sullivan

Nested Class Summary

class

SelectedRecordsSearchSource.SelectedRecordsQueryProcessor

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.SearchSource

ID_FIELD, IS_FEDERATED, NUMBER_OF_FIELDS, SECURE, SOURCE_NAME, SOURCE_TYPE, TITLE_FIELD, URL_FIELD

Constructor Summary

SelectedRecordsSearchSource()

Method Summary

SearchSource[]	createSearchSources(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory)
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
void	initializeSource(org.w3c.dom.Element sourceElem, SearchSource source)

Methods inherited from class com.raritantechnologies.searchApp.SearchSource

addFieldFormatter, addSearchField, addSourceAttributes, addStaticField, addStaticFields, addUserSearchField, canAccess, canConsolidateSources, consolidateSources, delSearchField, formatResult, formatResult, formatResultField, formatResultField, formatResults, formatResults, getAccessableFields, getAttributes, getBasePath, getConfigPath, getDisplayName, getFieldFormatters, getIDField, getName, getProperty, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, getSourcePropertyNames, getTitleField, getType, getURLField, getUserSearchFields, isMultiThreaded, setConfigPath, setDisplayName, setIDField, setMultiThreaded, setName, setSecurityManagerName, setSecurityModel, setSortMap, setSourcePropertyInfoSource, setTitleField, setType, setURLField, shouldFormatResults, supportsBackgroundSort

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectedRecordsSearchSource

public SelectedRecordsSearchSource()

Method Detail

getQueryProcessor

public IQueryProcessor getQueryProcessor()

Description copied from class: SearchSource

returns the type of QueryProcessor that can access this SearchSource.

Specified by:

getQueryProcessor in class SearchSource

createSearchSources

public SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem,
                                          ISearchFieldMapFactory factory)

Specified by:

createSearchSources in interface IXMLSearchSourceFactory

initializeSource

public void initializeSource(org.w3c.dom.Element sourceElem,
                             SearchSource source)

Specified by:

initializeSource in interface IXMLSearchSourceFactory