org.openprivacy.reptile.search
Class SearchProviderManager

java.lang.Object
  |
  +--org.openprivacy.reptile.search.SearchProviderManager

public class SearchProviderManager
extends java.lang.Object

Handles creating and managing SearchProviders.

Version:
$Id: SearchProviderManager.java,v 1.9 2002/03/17 06:44:11 burton Exp $
Author:
Kevin A. Burton

Field Summary
static java.lang.String ADVANCED_SEARCH_REQUEST_PACKAGE
           
static java.lang.String SEARCH_PROVIDER_PACKAGE
           
 
Constructor Summary
SearchProviderManager()
           
 
Method Summary
 void destroy(SearchProvider provider)
          Destroy the given SearchProvider and remove all evidence that it ever existed.
static SearchProviderManager getInstance()
          Get an instance of the SearchProviderManager.
 SearchProvider getSearchProvider(java.lang.String handle)
          Get an instantiated search provider (which is probably running or has ran a search) by its handle.
 int getSearchProviderCount()
          Get the total number of instantiated SearchProviders.
 java.util.Iterator getSearchProviders()
          Get a collection of all instantiated SearchProviders.
 SearchProvider newProvider(java.lang.Class cprovider)
          Create a new SearchProvider, throw an Exception if there was a problem.
 SearchProvider newProvider(java.lang.String classname)
          Create a new SearchProvider, throw an Exception if there was a problem.
 SearchProvider newProvider(java.lang.String classname, boolean expand)
          Create a new SearchProvider, throw an Exception if there was a problem.
 SearchProvider newProvider(java.lang.String classname, java.lang.String request_name)
          Create a new SearchProvider, throw an Exception if there was a problem.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEARCH_PROVIDER_PACKAGE

public static final java.lang.String SEARCH_PROVIDER_PACKAGE
See Also:
Constant Field Values

ADVANCED_SEARCH_REQUEST_PACKAGE

public static final java.lang.String ADVANCED_SEARCH_REQUEST_PACKAGE
See Also:
Constant Field Values
Constructor Detail

SearchProviderManager

public SearchProviderManager()
Method Detail

getInstance

public static SearchProviderManager getInstance()
Get an instance of the SearchProviderManager.


newProvider

public SearchProvider newProvider(java.lang.String classname,
                                  java.lang.String request_name)
                           throws java.lang.Exception
Create a new SearchProvider, throw an Exception if there was a problem. We also instantiate the request name and run a search with it.

java.lang.Exception

newProvider

public SearchProvider newProvider(java.lang.String classname)
                           throws java.lang.Exception
Create a new SearchProvider, throw an Exception if there was a problem.

java.lang.Exception

newProvider

public SearchProvider newProvider(java.lang.String classname,
                                  boolean expand)
                           throws java.lang.Exception
Create a new SearchProvider, throw an Exception if there was a problem.

Parameters:
expand - if true we will expand the short version of this classname 'ArticleSearchProvider' into a full classname 'org.openprivacy.reptile.search.impl.ArticleSearchProvider'
java.lang.Exception

newProvider

public SearchProvider newProvider(java.lang.Class cprovider)
                           throws java.lang.Exception
Create a new SearchProvider, throw an Exception if there was a problem.

java.lang.Exception

destroy

public void destroy(SearchProvider provider)
Destroy the given SearchProvider and remove all evidence that it ever existed.


getSearchProviders

public java.util.Iterator getSearchProviders()
Get a collection of all instantiated SearchProviders.


getSearchProviderCount

public int getSearchProviderCount()
Get the total number of instantiated SearchProviders.


getSearchProvider

public SearchProvider getSearchProvider(java.lang.String handle)
                                 throws java.lang.Exception
Get an instantiated search provider (which is probably running or has ran a search) by its handle. This should be a provider that was already instantiated by newProvider.

java.lang.Exception
See Also:
newProvider(java.lang.String, java.lang.String)