com.raritantechnologies.searchApp.sourceMap
Interface ISourceMap

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

BasicSourceMap, CategorySourceMap, CustomizableSourceMap, DocumentSourceMap

public interface ISourceMap

extends IConfigurable

Base interface for source maps. Provides a lookup interface for search sources based on a set of parameters or on a previous search result.

The Source Map interface is a key RTI Framework interface. In "Quickstart" applications, there must be a SourceMap to link search category names to one or more search sources. The basic implementation does a straight mapping of a source category name to a search source name. More sophisticated implementations can select sources based on a users role, preference settings or browse context (subject-driven source selection).

Developed by Raritan Technologies .

Author:

Ted Sullivan

Method Summary

void	addSourceInputs(java.lang.String sourceKey, SourceInput[] sourceInputs)
java.lang.String[]	getAllSourceKeys(ILoginInfo userInfo, boolean checkSecurity, java.util.Map searchParams) returns a list of all of the source names - links to SearchSource in the ISearchFieldMap
java.lang.String	getDescription(java.lang.String sourceName)
java.lang.String	getDisplayName(java.lang.String sourceKey)
java.lang.String	getObjectType() Returns the type of Source that the source map supports.
int	getPageCacheStyle(java.lang.String sourceKey)
SourceInput[]	getSourceInputs(ILoginInfo userInfo, IResult searchResult)
SourceInput[]	getSourceInputs(ILoginInfo userInfo, java.util.Map searchParams) Looks up the set of federated sources that are appropriate for the parameter set chosen by the user.
SourceInput[]	getSourceInputs(java.lang.String sourceKey)
void	setPageCacheStyle(java.lang.String sourceKey, int pagingStyle) Sets/gets the paging style used by a federated source.

Methods inherited from interface com.raritantechnologies.searchApp.IConfigurable

initialize

Method Detail

getObjectType

public java.lang.String getObjectType()

Returns the type of Source that the source map supports.

getAllSourceKeys

public java.lang.String[] getAllSourceKeys(ILoginInfo userInfo,
                                           boolean checkSecurity,
                                           java.util.Map searchParams)

returns a list of all of the source names - links to SearchSource in the ISearchFieldMap

getSourceInputs

public SourceInput[] getSourceInputs(java.lang.String sourceKey)

getDisplayName

public java.lang.String getDisplayName(java.lang.String sourceKey)

addSourceInputs

public void addSourceInputs(java.lang.String sourceKey,
                            SourceInput[] sourceInputs)

getSourceInputs

public SourceInput[] getSourceInputs(ILoginInfo userInfo,
                                     java.util.Map searchParams)

Looks up the set of federated sources that are appropriate for the parameter set chosen by the user. SourceInput objects map a source name to a set of preset parameters that need to be loaded into the queryParams - this method effectively maps a set of browse selections to a set of federated sources which match the selections and then provides the configuration information needed to direct the source to the proper result type. That it, this method translates a set of browse parameters to specific input parameters needed for each site. This information is obtained from the SourceMap XML used to construct this ISourceMap object.

getSourceInputs

public SourceInput[] getSourceInputs(ILoginInfo userInfo,
                                     IResult searchResult)

getDescription

public java.lang.String getDescription(java.lang.String sourceName)

setPageCacheStyle

public void setPageCacheStyle(java.lang.String sourceKey,
                              int pagingStyle)

Sets/gets the paging style used by a federated source. Constants defined in IFederatedSearchSource.

getPageCacheStyle

public int getPageCacheStyle(java.lang.String sourceKey)