com.raritantechnologies.federated
Class FederatedSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.federated.FederatedSearchSource

All Implemented Interfaces:

IFederatedSearchSource, java.io.Serializable

public class FederatedSearchSource

extends SearchSource

implements IFederatedSearchSource, java.io.Serializable

Represents a set of search sources that wraps a PagingFederatedSearch query processor.

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

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

Fields inherited from interface com.raritantechnologies.federated.IFederatedSearchSource

CONSTANT_RESULTS_PER_PAGE, CONSTANT_RESULTS_PER_SOURCE, INIT_REFRESH, NO_PAGING, PAGING_NOT_SET

Constructor Summary

FederatedSearchSource()

FederatedSearchSource(SourceLoginInfo[] sources)

Method Summary

java.lang.String	getName()
java.lang.Object	getProperty(java.lang.String property) returns a Source Property.
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
java.lang.String[]	getSourcePropertyNames() Returns a list of Source type specific property names.
SourceLoginInfo[]	getSources()
void	setPagingStyle(int pageStyle)
void	setSources(SourceLoginInfo[] sources) Sets the delegate search sources to be used in the Federated Search.

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, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, 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

FederatedSearchSource

public FederatedSearchSource()

FederatedSearchSource

public FederatedSearchSource(SourceLoginInfo[] sources)

Method Detail

setSources

public void setSources(SourceLoginInfo[] sources)

Sets the delegate search sources to be used in the Federated Search. Also checks if there is a standard QueryProcessorFilter pipeline defined for this application. If so, wraps the Federated Search in the QueryProcessorFilter so that this filter will be returned in calls to the SearchSource getQueryProcessor( ) method.

Specified by:

setSources in interface IFederatedSearchSource

getSources

public SourceLoginInfo[] getSources()

Specified by:

getSources in interface IFederatedSearchSource

getName

public java.lang.String getName()

Overrides:

getName in class SearchSource

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

getSourcePropertyNames

public java.lang.String[] getSourcePropertyNames()

Description copied from class: SearchSource

Returns a list of Source type specific property names.

Overrides:

getSourcePropertyNames in class SearchSource

getProperty

public java.lang.Object getProperty(java.lang.String property)

Description copied from class: SearchSource

returns a Source Property. The standard pattern is to return a String or Object if a property has a single value and a String or Object Array if the property has multiple values.

Overrides:

getProperty in class SearchSource

setPagingStyle

public void setPagingStyle(int pageStyle)

Specified by:

setPagingStyle in interface IFederatedSearchSource