org.opencms.search.documents

接口 I_CmsSearchExtractor

所有已知子接口:

I_CmsDocumentFactory

所有已知实现类:

A_CmsVfsDocument, CmsDocumentContainerPage, CmsDocumentGeneric, CmsDocumentHtml, CmsDocumentMsOfficeOLE2, CmsDocumentMsOfficeOOXML, CmsDocumentOpenOffice, CmsDocumentPdf, CmsDocumentPlainText, CmsDocumentRtf, CmsDocumentXmlContent, CmsDocumentXmlPage, CmsGalleryDocumentXmlContent, CmsGalleryDocumentXmlPage, CmsSolrDocumentContainerPage, CmsSolrDocumentXmlContent

public interface I_CmsSearchExtractor

Defines a text extractor for the integrated search engine.

The job of a search extractor is to extract indexable plain text from a resource in the OpenCms VFS. This may be from the resource content, for example from a PDF file, or from the resource properties, for example the Title, Keywords and Description properties.

从以下版本开始:

6.0.0

方法概要

方法

限定符和类型	方法和说明
I_CmsExtractionResult	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.

方法详细资料

extractContent

I_CmsExtractionResult extractContent(CmsObject cms,
                                   CmsResource resource,
                                   CmsSearchIndex index)
                                     throws CmsException

Extracts the content of a given index resource according to the resource file type and the configuration of the given index.

参数:

cms - the cms object

resource - the resource to extract the content from

index - the index to extract the content for

返回:

the extracted content of the resource

抛出:

CmsException - if something goes wrong