Package edu.indiana.lib.twinpeaks.search

Class SearchSource

java.lang.Object

edu.indiana.lib.twinpeaks.search.SearchSource

public class SearchSource
extends Object

Method Summary

Modifier and Type	Method	Description
String	getAuthority()	Return authority information
String	getConfiguredParameter(String name)	Return a custom parameter configured for this source
static String	getConfiguredParameter(String name, String parameterName)	Return a custom parameter configured for this source
static String	getDefaultSourceName()	Get the default search source
String	getDescription()	Return the search source description
String	getDomain()	Return search domain
static String	getGlobalConfigurationValue(String name)	Return a global parameter
String	getId()	Return the search source id (a unique String)
static String	getMandatoryGlobalConfigurationValue(String name)	Return a mandatory global configuration value
static String	getMandatoryParameter(String name, String parameterName)	Return a mandatory parameter for this source
String	getName()	Return the search source (repository) name
QueryBase	getQueryHandler()	Return a new QueryBase object for the specified search source.
String	getQueryHandlerClassName()	Return the query handler class name.
static Iterator	getSearchListIterator()	Return an Iterator to the source list
SearchResultBase	getSearchResultHandler()	Return a new SearchResultBase object for the specified search source.
String	getSearchResultHandlerClassName()	Return the search result handler class name.
String	getSearchType()	Return the search type
static SearchSource	getSourceByName(String name)	Lookup a search source by name
String	getTypeDescription()	Return the search type description
boolean	isEnabled()	Is this source available?
static boolean	isSourceListPopulated()	Has source list has been populated?
static void	populate(InputStream xmlStream)	Create a populated SearchSource list.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Return the search source (repository) name

Returns:

The name of this source (eg Academic Search, ERIC)

getId

public String getId()

Return the search source id (a unique String)

Returns:

The name of this source (eg Academic Search

getAuthority

public String getAuthority()

Return authority information

Returns:

The authority for this source

getDomain

public String getDomain()

Return search domain

Returns:

The domain for this source (eg search)

getSearchType

public String getSearchType()

Return the search type

Returns:

The type of search (eg keyword)

getTypeDescription

public String getTypeDescription()

Return the search type description

Returns:

The description (eg "keyword search")

getDescription

public String getDescription()

Return the search source description

Returns:

A description of this repository

isEnabled

public boolean isEnabled()

Is this source available?

Returns:

true (if available)

getQueryHandler

public QueryBase getQueryHandler()
                          throws ClassNotFoundException,
                                 InstantiationException,
                                 IllegalAccessException

Return a new QueryBase object for the specified search source. Class loading is defered until request time.

Returns:

A QueryBase object for this source

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

getQueryHandlerClassName

public String getQueryHandlerClassName()

Return the query handler class name.

Returns:

Query handler class name

getSearchResultHandler

public SearchResultBase getSearchResultHandler()
                                        throws ClassNotFoundException,
                                               InstantiationException,
                                               IllegalAccessException

Return a new SearchResultBase object for the specified search source. Class loading is defered until request time.

Returns:

A SearchResultBase object for this source

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

getSearchResultHandlerClassName

public String getSearchResultHandlerClassName()

Return the search result handler class name.

Returns:

Result handler class name

getGlobalConfigurationValue

public static String getGlobalConfigurationValue(String name)

Return a global parameter

Parameters:

name - Parameter name

Returns:

Parameter value (null if none)

getMandatoryGlobalConfigurationValue

public static String getMandatoryGlobalConfigurationValue(String name)

Return a mandatory global configuration value

Parameters:

name - The name of the cglobal configuration item

Returns:

The configured value

getConfiguredParameter

public String getConfiguredParameter(String name)

Return a custom parameter configured for this source

Parameters:

name - Parameter name

Returns:

Parameter value (null if none)

getConfiguredParameter

public static String getConfiguredParameter(String name,
                                            String parameterName)

Return a custom parameter configured for this source

Parameters:

name - The source name (eg ERIC)

parameterName - Parameter to fetech

Returns:

The parameter value (null if none)

getMandatoryParameter

public static String getMandatoryParameter(String name,
                                           String parameterName)

Return a mandatory parameter for this source

Parameters:

name - The source name (eg ERIC)

parameterName - Parameter to fetech

Returns:

The parameter value

getSourceByName

public static SearchSource getSourceByName(String name)

Lookup a search source by name

Parameters:

name - Source name

Returns:

SearchSource object

getDefaultSourceName

public static String getDefaultSourceName()

Get the default search source

Returns:

The search source name

getSearchListIterator

public static Iterator getSearchListIterator()

Return an Iterator to the source list

Returns:

Source list Iterator

populate

public static void populate(InputStream xmlStream)
                     throws DomException,
                            SearchException

Create a populated SearchSource list.

Parameters:

xmlStream - Configuration file as an InputStream

Throws:

DomException

SearchException

isSourceListPopulated

public static boolean isSourceListPopulated()

Has source list has been populated?

Returns:

true if so