类 org.opencms.search.CmsSearchIndex
的使用

使用CmsSearchIndex的程序包

程序包	说明
org.opencms.search	Implements the main full text search and indexing functions available in OpenCms.
org.opencms.search.documents	Handles indexing different sorts of document and resource type from the OpenCms VFS for the full text search.
org.opencms.search.fields	These classes control the mapping of the OpenCms content to the Lucene search fields.
org.opencms.search.galleries	Implements the search functions for the OpenCms Gallery search index, which is used by the Advanced Direct Edit (ADE) functions.
org.opencms.search.solr
org.opencms.workplace.tools.searchindex	This package contains the tool classes for the management of search indexes and related administration views.

org.opencms.search中CmsSearchIndex的使用

声明为CmsSearchIndex的org.opencms.search中的字段

限定符和类型	字段和说明
protected CmsSearchIndex	CmsVfsIndexer.m_index The index.

类型参数类型为CmsSearchIndex的org.opencms.search中的字段

限定符和类型	字段和说明
protected java.util.List<CmsSearchIndex>	CmsSearchManager.m_offlineIndexes The list of indexes that are configured for offline index mode.

返回CmsSearchIndex的org.opencms.search中的方法

限定符和类型	方法和说明
CmsSearchIndex	CmsVfsIndexer.getIndex() Returns the OpenCms search index updated by this indexer.
CmsSearchIndex	CmsSearchManager.getIndex(java.lang.String indexName) Returns the Lucene search index configured with the given name.
CmsSearchIndex	CmsSearchParameters.getSearchIndex() Returns the search index to search in or null if not set before (CmsSearchParameters.setSearchIndex(CmsSearchIndex)).

返回变量类型为CmsSearchIndex的类型的org.opencms.search中的方法

限定符和类型	方法和说明
java.util.List<CmsSearchIndex>	CmsSearchManager.getSearchIndexes() Returns an unmodifiable list of all configured CmsSearchIndex instances.
java.util.List<CmsSearchIndex>	CmsSearchManager.getSearchIndexesAll() Returns an unmodifiable list of all configured CmsSearchIndex instances.

参数类型为CmsSearchIndex的org.opencms.search中的方法

限定符和类型	方法和说明
void	CmsSearchManager.addSearchIndex(CmsSearchIndex searchIndex) Adds a search index to the configuration.
protected I_CmsSearchDocument	CmsIndexingThread.createIndexDocument(CmsObject cms, CmsResource res, CmsSearchIndex index, int count, I_CmsReport report) Creates the search index document.
I_CmsIndexer	CmsDependencyIndexer.newInstance(CmsObject cms, I_CmsReport report, CmsSearchIndex index)
I_CmsIndexer	CmsVfsIndexer.newInstance(CmsObject cms, I_CmsReport report, CmsSearchIndex index)
I_CmsIndexer	I_CmsIndexer.newInstance(CmsObject cms, I_CmsReport report, CmsSearchIndex index) Creates and initializes a new instance of this indexer implementation.
void	CmsSearchManager.removeSearchIndex(CmsSearchIndex searchIndex) Removes a search index from the configuration.
void	CmsSearchParameters.setSearchIndex(CmsSearchIndex index) Sets the search index to use for the search.
protected void	CmsSearchManager.updateIndex(CmsSearchIndex index, I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Updates (if required creates) the index with the given name.
protected void	CmsSearchManager.updateIndexIncremental(CmsObject cms, CmsSearchIndex index, I_CmsReport report, java.util.List<CmsPublishedResource> resourcesToIndex) Incrementally updates the given index.

参数类型为CmsSearchIndex的org.opencms.search中的构造器

构造器和说明
CmsIndexingThread(CmsObject cms, CmsResource res, CmsSearchIndex index, int count, I_CmsReport report) Create a new indexing thread.
CmsLuceneIndexWriter(org.apache.lucene.index.IndexWriter indexWriter, CmsSearchIndex index) Creates a new index writer based on the provided standard Lucene IndexWriter for the provided OpenCms search index instance.

org.opencms.search.documents中CmsSearchIndex的使用

参数类型为CmsSearchIndex的org.opencms.search.documents中的方法

限定符和类型	方法和说明
I_CmsSearchDocument	A_CmsVfsDocument.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	CmsDocumentContainerPage.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsSearchDocument	I_CmsDocumentFactory.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Creates the Lucene Document for the given VFS resource and the given search index.
I_CmsSearchDocument	CmsDocumentXmlContent.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index)
I_CmsExtractionResult	CmsDocumentXmlPage.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource of type CmsResourceTypeXmlPage.
I_CmsExtractionResult	CmsDocumentMsOfficeOOXML.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentPlainText.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing plain text data.
I_CmsExtractionResult	CmsDocumentHtml.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given VFS resource containing HTML data.
I_CmsExtractionResult	CmsDocumentGeneric.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Just returns an empty extraction result since the content can't be extracted form a generic resource.
I_CmsExtractionResult	CmsDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsDocumentPdf.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing Adobe PDF data.
I_CmsExtractionResult	CmsDocumentRtf.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing RTF data.
I_CmsExtractionResult	I_CmsSearchExtractor.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Extracts the content of a given index resource according to the resource file type and the configuration of the given index.
I_CmsExtractionResult	CmsDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given VFS resource of type CmsResourceTypeXmlContent.
I_CmsExtractionResult	CmsDocumentOpenOffice.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
I_CmsExtractionResult	CmsDocumentMsOfficeOLE2.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given vfs resource containing MS Word data.
java.lang.String	CmsTermHighlighterHtml.getExcerpt(org.apache.lucene.document.Document doc, CmsSearchIndex index, CmsSearchParameters params, org.apache.lucene.search.Query query, org.apache.lucene.analysis.Analyzer analyzer)
java.lang.String	I_CmsTermHighlighter.getExcerpt(org.apache.lucene.document.Document doc, CmsSearchIndex index, CmsSearchParameters params, org.apache.lucene.search.Query query, org.apache.lucene.analysis.Analyzer analyzer) Returns an excerpt of the given document related based on the given index and query.
protected void	A_CmsVfsDocument.logContentExtraction(CmsResource resource, CmsSearchIndex index) Logs content extraction for the specified resource and index.

org.opencms.search.fields中CmsSearchIndex的使用

返回CmsSearchIndex的org.opencms.search.fields中的方法

限定符和类型	方法和说明
CmsSearchIndex	CmsSearchFieldConfiguration.getIndex() Returns the index.

参数类型为CmsSearchIndex的org.opencms.search.fields中的方法

限定符和类型	方法和说明
I_CmsSearchDocument	CmsSearchFieldConfiguration.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index, I_CmsExtractionResult extraction) Creates the Lucene Document with this field configuration for the provided VFS resource, search index and content.
void	CmsSearchFieldConfiguration.setIndex(CmsSearchIndex index) Sets the index.

org.opencms.search.galleries中CmsSearchIndex的使用

org.opencms.search.galleries中CmsSearchIndex的子类

限定符和类型	类和说明
class	CmsGallerySearchIndex Implements the search within a the gallery index.

参数类型为CmsSearchIndex的org.opencms.search.galleries中的方法

限定符和类型	方法和说明
I_CmsSearchDocument	CmsGalleryDocumentXmlContent.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsExtractionResult	CmsGalleryDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a given VFS resource of type CmsResourceTypeXmlContent.

org.opencms.search.solr中CmsSearchIndex的使用

org.opencms.search.solr中CmsSearchIndex的子类

限定符和类型	类和说明
class	CmsSolrIndex Implements the search within an Solr index.

参数类型为CmsSearchIndex的org.opencms.search.solr中的方法

限定符和类型	方法和说明
I_CmsSearchDocument	CmsSolrDocumentContainerPage.createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) Generates a new lucene document instance from contents of the given resource for the provided index.
I_CmsExtractionResult	CmsSolrDocumentContainerPage.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
I_CmsExtractionResult	CmsSolrDocumentXmlContent.extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index)

org.opencms.workplace.tools.searchindex中CmsSearchIndex的使用

声明为CmsSearchIndex的org.opencms.workplace.tools.searchindex中的字段

限定符和类型	字段和说明
protected CmsSearchIndex	A_CmsEditSearchIndexDialog.m_index The user object that is edited on this dialog.

返回CmsSearchIndex的org.opencms.workplace.tools.searchindex中的方法

限定符和类型	方法和说明
protected CmsSearchIndex	A_CmsEditSearchIndexDialog.getSearchIndexIndex() Returns the search index.