org.opencms.search.solr

类 CmsSolrDocumentContainerPage

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.CmsDocumentXmlContent

org.opencms.search.solr.CmsSolrDocumentXmlContent

org.opencms.search.solr.CmsSolrDocumentContainerPage

所有已实现的接口:

I_CmsDocumentFactory, I_CmsSearchExtractor

public class CmsSolrDocumentContainerPage
extends CmsSolrDocumentXmlContent

Lucene document factory class to extract index data from a resource of type CmsResourceTypeContainerPage.

从以下版本开始:

8.5.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	TYPE_CONTAINERPAGE_SOLR The solr document type name for xml-contents.

从类继承的字段 org.opencms.search.solr.CmsSolrDocumentXmlContent

TYPE_XMLCONTENT_SOLR

从类继承的字段 org.opencms.search.documents.A_CmsVfsDocument

m_name

构造器概要

构造器

构造器和说明
CmsSolrDocumentContainerPage(java.lang.String name) Creates a new instance of this lucene document factory.

方法概要

方法

限定符和类型	方法和说明
I_CmsSearchDocument	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	extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index) Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.
boolean	isLocaleDependend() Returns true if this document factory is locale depended.
boolean	isUsingCache() Returns true if result caching is supported for this factory.

从类继承的方法 org.opencms.search.documents.CmsDocumentXmlContent

getDocumentKeys

从类继承的方法 org.opencms.search.documents.A_CmsVfsDocument

getCache, getDocumentKey, getName, logContentExtraction, readFile, setCache

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

TYPE_CONTAINERPAGE_SOLR

public static final java.lang.String TYPE_CONTAINERPAGE_SOLR

The solr document type name for xml-contents.

另请参阅:

常量字段值

构造器详细资料

CmsSolrDocumentContainerPage

public CmsSolrDocumentContainerPage(java.lang.String name)

Creates a new instance of this lucene document factory.

参数:

name - name of the document type

方法详细资料

createDocument

public I_CmsSearchDocument createDocument(CmsObject cms,
                                 CmsResource resource,
                                 CmsSearchIndex index)
                                   throws CmsException

Generates a new lucene document instance from contents of the given resource for the provided index.

For container pages, we must not cache based on the container page content age, since the content of the included elements may change any time.

指定者:

createDocument 在接口中 I_CmsDocumentFactory

覆盖:

createDocument 在类中 CmsDocumentXmlContent

参数:

cms - the OpenCms user context used to access the OpenCms VFS

resource - the search index resource to create the Lucene document from

index - the search index to create the Document for

返回:

the Search Document for the given index resource and the given search index

抛出:

CmsException - if something goes wrong

另请参阅:

A_CmsVfsDocument.createDocument(org.opencms.file.CmsObject, org.opencms.file.CmsResource, org.opencms.search.CmsSearchIndex)

extractContent

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

Returns the raw text content of a VFS resource of type CmsResourceTypeContainerPage.

指定者:

extractContent 在接口中 I_CmsSearchExtractor

覆盖:

extractContent 在类中 CmsSolrDocumentXmlContent

参数:

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

另请参阅:

I_CmsSearchExtractor.extractContent(CmsObject, CmsResource, CmsSearchIndex)

isLocaleDependend

public boolean isLocaleDependend()

从接口复制的说明: I_CmsDocumentFactory

Returns true if this document factory is locale depended.

指定者:

isLocaleDependend 在接口中 I_CmsDocumentFactory

覆盖:

isLocaleDependend 在类中 CmsDocumentXmlContent

返回:

true if this document factory is locale depended

另请参阅:

I_CmsDocumentFactory.isLocaleDependend()

isUsingCache

public boolean isUsingCache()

从接口复制的说明: I_CmsDocumentFactory

Returns true if result caching is supported for this factory.

指定者:

isUsingCache 在接口中 I_CmsDocumentFactory

覆盖:

isUsingCache 在类中 CmsDocumentXmlContent

返回:

true if result caching is supported for this factory

另请参阅:

I_CmsDocumentFactory.isUsingCache()