Package com.arsdigita.search

Provides a set of APIs for interacting with search engines.

See:
          Description

Interface Summary
ContentProvider This interface is the API through which a domain object provides its searchable content.
Document The Document interface provides access to the metadata associated with a single document obtained from the search index.
DocumentObserver This interface is implemented by a search indexer to recieve notification of updates to documents that are searchable.
MetadataProvider The interface defining an adapter between a domain object and the search index metadata.
QueryEngine This interface is the bridge between the generic application programmers API and the backend (search engine specific) implementations.
ResultCache A simple interface for caching sets
ResultSet This interface provides an API for accessing the documents matching a search query in an efficient manner.
Searchable Deprecated. moved to com.arsdigita.search.intermedia package
SearchIndexHelpCustomize Deprecated. moved to com.arsdigita.search.intermedia package
 

Class Summary
BaseDocument A BaseDocument provides a base implementation of the Document interface.
CachedResultSet  
ContentType A class to represent the different types of content that can be indexed
FilterSpecification A filter specification defines the parameters for a plugging into a condition defined by a filter type.
FilterType A filter type defines a condition on which a set of result documents can be restricted.
IndexerType This class records the capabilities of a search indexer implemenation.
Initializer This initializer (which will soon go away) activates the appropriate search engine.
MetadataProviderRegistry  
NoopQueryEngine A query engine that always returns Search.EMPTY_RESULT_SET;
QueryEngineRegistry Provides a registry of query engine implementations for various sets of filters.
QuerySpecification Represents the set of parameters for a search query.
Search The Search class provides an application level API for querying search indexes.
SearchableACSObject Deprecated. moved to com.arsdigita.search.intermedia package
SearchableObserver Deprecated. moved to com.arsdigita.search.intermedia package
SearchConfig Stores the configuration record for the search service
SearchDataQuery Deprecated. moved to com.arsdigita.search.intermedia package
SearchIndexHelp Deprecated. moved to com.arsdigita.search.intermedia package
SearchSpecification Deprecated. moved to com.arsdigita.search.intermedia package
SimpleSearchSpecification Deprecated. moved to com.arsdigita.search.intermedia package
TimedResultCache Implements a timed-expiry result set cache.
 

Package com.arsdigita.search Description

Provides a set of APIs for interacting with search engines. The APIs are split into two groups, one set for application authors, and another for query engine authors. The former are indexer-agnostic, enabling applications to provide search functionality without becoming tied to a specific implmentation. Applications authors should only use classes from the com.arsdigita.seach package. Query engine authors may also use classes in the com.arsdigita.search.lucene and com.arsdigita.search.intermedia sub-packages.

General APIs

Application APIs

Populating the search index

Querying the search index

Accessing query results

Query Engine APIs

Deprecation

Having been moved into the com.arsdigita.search.intermedia package, the following intermedia specific classes are now deprecated:



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC