Uses of Interface
org.opencms.search.I_CmsSearchIndex
Packages that use I_CmsSearchIndex
Package
Description
Implements the main full text search and indexing functions available in OpenCms.
Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
These classes control the mapping of the OpenCms content to the Lucene search fields.
The package contains the Solr search integration.
Contains classes of the searchindex app.
-
Uses of I_CmsSearchIndex in org.opencms.search
Classes in org.opencms.search that implement I_CmsSearchIndexModifier and TypeClassDescriptionclass
Abstract base class for search indexes.class
Abstract search index implementation.Fields in org.opencms.search declared as I_CmsSearchIndexFields in org.opencms.search with type parameters of type I_CmsSearchIndexModifier and TypeFieldDescriptionprotected List<I_CmsSearchIndex>
CmsSearchManager.m_offlineIndexes
The list of indexes that are configured for offline index mode.Methods in org.opencms.search that return I_CmsSearchIndexModifier and TypeMethodDescriptionReturns the Lucene search index configured with the given name.CmsVfsIndexer.getIndex()
Returns the OpenCms search index updated by this indexer.Methods in org.opencms.search that return types with arguments of type I_CmsSearchIndexModifier and TypeMethodDescriptionCmsSearchManager.getSearchIndexes()
Returns an unmodifiable list of all configured
instances.I_CmsSearchIndex
CmsSearchManager.getSearchIndexesAll()
Returns an unmodifiable list of all configured
instances.I_CmsSearchIndex
Methods in org.opencms.search with parameters of type I_CmsSearchIndexModifier and TypeMethodDescriptionvoid
CmsSearchManager.addSearchIndex
(I_CmsSearchIndex searchIndex) Adds a search index to the configuration.protected I_CmsSearchDocument
CmsIndexingThread.createIndexDocument
(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Creates the search index document.CmsVfsIndexer.newInstance
(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index) I_CmsIndexer.newInstance
(CmsObject cms, I_CmsReport report, I_CmsSearchIndex index) Creates and initializes a new instance of this indexer implementation.void
CmsSearchManager.removeSearchIndex
(I_CmsSearchIndex searchIndex) Removes a search index from the configuration.protected boolean
CmsSearchManager.shouldUpdateAtAll
(I_CmsSearchIndex index) Checks, if the index should be rebuilt/updated at all by the search manager.protected void
CmsSearchManager.updateIndex
(I_CmsSearchIndex index, I_CmsReport report, List<CmsPublishedResource> resourcesToIndex) Updates (if required creates) the index with the given name.protected void
CmsSearchManager.updateIndexCompletely
(CmsObject cms, I_CmsSearchIndex index, I_CmsReport report) The method updates all OpenCms documents that are indexed.protected void
CmsSearchManager.updateIndexIncremental
(CmsObject cms, I_CmsSearchIndex index, I_CmsReport report, List<CmsPublishedResource> resourcesToIndex) Incrementally updates the given index.Constructors in org.opencms.search with parameters of type I_CmsSearchIndexModifierConstructorDescriptionCmsIndexingThread
(CmsObject cms, CmsResource res, I_CmsSearchIndex index, int count, I_CmsReport report) Create a new indexing thread. -
Uses of I_CmsSearchIndex in org.opencms.search.documents
Methods in org.opencms.search.documents with parameters of type I_CmsSearchIndexModifier and TypeMethodDescriptionA_CmsVfsDocument.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Creates the Lucene Document for the given VFS resource and the given search index.CmsDocumentContainerPage.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.CmsDocumentXmlContent.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) I_CmsDocumentFactory.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Creates the Lucene Document for the given VFS resource and the given search index.CmsDocumentContainerPage.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a VFS resource of typeCmsResourceTypeContainerPage
.CmsDocumentGeneric.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Just returns an empty extraction result since the content can't be extracted form a generic resource.CmsDocumentHtml.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given VFS resource containing HTML data.CmsDocumentMsOfficeOLE2.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.CmsDocumentMsOfficeOOXML.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.CmsDocumentOpenOffice.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.CmsDocumentPdf.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing Adobe PDF data.CmsDocumentPlainText.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing plain text data.CmsDocumentRtf.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource containing RTF data.CmsDocumentXmlContent.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given VFS resource of typeCmsResourceTypeXmlContent
.CmsDocumentXmlPage.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a given vfs resource of typeCmsResourceTypeXmlPage
.I_CmsSearchExtractor.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Extracts the content of a given index resource according to the resource file type and the configuration of the given index.protected void
A_CmsVfsDocument.logContentExtraction
(CmsResource resource, I_CmsSearchIndex index) Logs content extraction for the specified resource and index. -
Uses of I_CmsSearchIndex in org.opencms.search.fields
Methods in org.opencms.search.fields that return I_CmsSearchIndexMethods in org.opencms.search.fields with parameters of type I_CmsSearchIndexModifier and TypeMethodDescriptionCmsSearchFieldConfiguration.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extraction) Creates the Lucene Document with this field configuration for the provided VFS resource, search index and content.I_CmsSearchFieldConfiguration.createDocument
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, I_CmsExtractionResult extractionResult) Creates the document to index. -
Uses of I_CmsSearchIndex in org.opencms.search.solr
Classes in org.opencms.search.solr that implement I_CmsSearchIndexMethods in org.opencms.search.solr with parameters of type I_CmsSearchIndexModifier and TypeMethodDescriptionCmsSolrDocumentContainerPage.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Returns the raw text content of a VFS resource of typeCmsResourceTypeContainerPage
.CmsSolrDocumentContainerPage.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale) Extracts the content of a given index resource according to the resource file type and the configuration of the given index.CmsSolrDocumentXmlContent.extractContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) static CmsExtractionResult
CmsSolrDocumentXmlContent.extractXmlContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) Extracts the content of a single XML content resource.static CmsExtractionResult
CmsSolrDocumentXmlContent.extractXmlContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale) Extracts the content of a single XML content resource.static CmsExtractionResult
CmsSolrDocumentXmlContent.extractXmlContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale, Set<CmsUUID> alreadyExtracted) Extracts the content of a single XML content resource.static CmsExtractionResult
CmsSolrDocumentXmlContent.extractXmlContent
(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, Locale forceLocale, Set<CmsUUID> alreadyExtracted, Consumer<A_CmsXmlDocument> contentConsumer) Extracts the content of a single XML content resource. -
Uses of I_CmsSearchIndex in org.opencms.ui.apps.searchindex
Methods in org.opencms.ui.apps.searchindex that return I_CmsSearchIndexMethods in org.opencms.ui.apps.searchindex that return types with arguments of type I_CmsSearchIndexMethods in org.opencms.ui.apps.searchindex with parameters of type I_CmsSearchIndexModifier and TypeMethodDescriptionvoid
CmsSearchindexApp.createElement
(I_CmsSearchIndex element) void
CmsSearchindexApp.writeElement
(I_CmsSearchIndex element) Constructor parameters in org.opencms.ui.apps.searchindex with type arguments of type I_CmsSearchIndexModifierConstructorDescriptionCmsSourceDialog
(I_CmsCRUDApp<I_CmsSearchIndex> app, Runnable cancel) public constructor.