Package javax.help.search
Class SearchEngine
java.lang.Object
javax.help.search.SearchEngine
- Direct Known Subclasses:
MergingSearchEngine
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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a SearchEngine.SearchEngine
(URL base, Hashtable params) Creates a SearchEngine using the standard JavaHelp SearchEngine parameters. -
Method Summary
-
Field Details
-
base
-
params
-
-
Constructor Details
-
SearchEngine
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.- Throws:
InvalidParameterException
-
SearchEngine
public SearchEngine()Creates a SearchEngine.
-
-
Method Details
-
createQuery
Creates a new search query.- Throws:
IllegalStateException
-