Package org.opencms.search
Implements the main full text search and indexing functions available in OpenCms.
- Since:
- 6.0.0
-
Interface Summary Interface Description I_CmsIndexer Indexes resources for the OpenCms search.I_CmsIndexWriter Abstracts the index writer implementation for the most important index manipulation operations.I_CmsSearchDocument The interface for search documents.I_CmsSearchIndex Interface for search indizes that should be handled by theCmsSearchManager
. -
Class Summary Class Description A_CmsSearchIndex Abstract base class for search indexes.CmsDependencyIndexer A VFS indexer that resolves locale dependent documents.CmsIndexingThread Implements the indexing method for a single resource as thread.CmsIndexingThreadManager Implements the management of indexing threads.CmsLuceneDocument A Lucene search document implementation.CmsLuceneIndexWriter Delegates indexing to a standard Lucene IndexWriter.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 Abstract search index implementation.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.CmsSearchManager.CmsSearchForceUnlockMode Enumeration class for force unlock types.CmsSearchParameters Contains the search parameters for a call to
.CmsSearchIndex.search(org.opencms.file.CmsObject, CmsSearchParameters)
CmsSearchParameters.CmsSearchFieldQuery Describes a specific search field query.CmsSearchResource A resource implementation that combines the Solr document together with a OpenCms VFS resource.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
factor for theCmsSearchSimilarity.computeNorm(FieldInvertState)
field, while keeping the Lucene default for all other fields.CmsSearchField.FIELD_CONTENT
CmsSearchUtil Provides common functions regarding searching.CmsVfsIndexer An indexer indexingCmsResource
based content from the OpenCms VFS.Messages Convenience class to access the localized messages of this OpenCms package. -
Exception Summary Exception Description CmsIndexException Signals an error during an indexing operation.CmsSearchException Signals an error during a search operation.