Package org.opencms.search

Implements the main full text search and indexing functions available in OpenCms.

See:
Description

Interface Summary

I_CmsIndexer

Interface for an indexer indexing Cms resources.

Class Summary

A_CmsIndexResource	An index resource is a wrapper class that contains the data of a Cms resource specified by a Lucene search result document.
CmsIndexingThread	Implements the indexing method for a single resource as thread.
CmsIndexingThreadManager	Implements the management of indexing threads.
CmsSearch	Helper class to access the search facility within a jsp.
CmsSearchAnalyzer	An analyzer class is used by Lucene to reduce the content to be indexed with trimmed endings etc.
CmsSearchCategoryCollector	Collects category information during a search process.
CmsSearchDocumentType	A document type specifies which document factory class is used to pull the content of an OpenCms document into a Lucene index document.
CmsSearchIndex	Implements the search within an index and the management of the index configuration.
CmsSearchIndexSource	A search index source is a description of a list of Cms resources to be indexed.
CmsSearchIndexUpdateData	A collection of resources for the incremental update of a search index.
CmsSearchManager	Implements the general management and configuration of the search and indexing facilities in OpenCms.
CmsSearchParameters	Contains the search parameters for a call to CmsSearchIndex.search(org.opencms.file.CmsObject, CmsSearchParameters, int, int).
CmsSearchResult	Contains the data of a single item in a search result.
CmsSearchResultList	A search result object returned as result of a search in CmsSearchIndex.
CmsSearchSimilarity	Reduces the importance of the CmsSearchSimilarity.lengthNorm(String, int) factor for the I_CmsDocumentFactory.DOC_CONTENT field, while keeping the Lucene default for all other fields.
CmsVfsIndexer	Implementation for an indexer indexing VFS Cms resources.
CmsVfsIndexResource	Contains the data of a VFS Cms resource specified by a Lucene search result document.
Messages	Convenience class to access the localized messages of this OpenCms package.

Exception Summary

CmsIndexException	Signals an error during an indexing operation.
CmsSearchException	Signals an error during a search operation.

Package org.opencms.search Description

Implements the main full text search and indexing functions available in OpenCms.

Since:

6.0.0

Version:

$Revision: 1.7 $