javax.help.search

Class SearchEngine

Known Direct Subclasses:
MergingSearchEngine

public abstract class SearchEngine
extends java.lang.Object

Defines the methods used to access a search engine. Each instance is created by a engine factory. Extensions of SearchEngine can perform the search or negotiate the search results with an outside agent. A server search engine is an an example of an outside agent. Search results are returned through SearchEvents to listeners that register with a SearchQuery instance. The SearchQuery is returned from the method createQuery.
See Also:
SearchEvent, SearchListener

Field Summary

protected URL
base
protected Hashtable
params

Constructor Summary

SearchEngine()
Creates a SearchEngine.
SearchEngine(URL base, Hashtable params)
Creates a SearchEngine using the standard JavaHelp SearchEngine parameters.

Method Summary

abstract SearchQuery
createQuery()
Creates a new search query.

Field Details

base

protected URL base

params

protected Hashtable params

Constructor Details

SearchEngine

public SearchEngine()
Creates a SearchEngine.

SearchEngine

public SearchEngine(URL base,
                    Hashtable params)
            throws InvalidParameterException
Creates a SearchEngine using the standard JavaHelp SearchEngine parameters. Only this constructor is used to create a SearchEngine from within a search view.
Parameters:
base - The base address of the data.
params - A hashtable of parameters from the search view.

Method Details

createQuery

public abstract SearchQuery createQuery()
            throws IllegalStateException
Creates a new search query.