Package javax.help.search
Supports simple access to search engines. JavaHelp supports a
standard full-text search view and navigator. The view interacts
with a search engine through this package. The reference
implementation provides a search engine that implements these
interfaces, but others can also be used--the specific search engine
is part of the information specified in the search view. This separation
provides full-text search functionality while not imposing specific
formats. These details are encapsulated in a search engine type.
HelpSearch is an abstract base class for the search
engines, SearchQuery obtained from it can be used to
perform the actual queries. Individual items found by a search are
SearchItems which can be fired as
HelpEvents.
The creation of search databases is done by subclasses of the
abstract class IndexBuilder based on the MIME type of
each document being indexed. Details of the index building process
can be given through instances of ConfigFile.
Note: Registration of IndexerKits should probably be visible in this package.
Related Documentation
For overviews, tutorials, examples, guides, tool support, and other documentation, please see the JavaHelp System User's Guide.
-
Interface Summary Interface Description SearchListener Defines the interface for an object that listens to changes from a SearchQuery instance. -
Class Summary Class Description ConfigFile Describes and parses the configuration file for the full-text search indexer.IndexBuilder Abstract base class that builds an index for a search database.IndexerKit Establishes the requirements of an indexing object for a type of text content.MergingSearchEngine SearchEngine Defines the methods used to access a search engine.SearchEvent Encapsulates information that describes changes to a SearchQuery.SearchItem A SearchItem corresponds to one specific item found in a search query.SearchQuery The instance of a query on a search database.