org.opencms.search.documents

类 CmsDocumentXmlContent

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.CmsDocumentXmlContent

所有已实现的接口:

I_CmsDocumentFactory, I_CmsSearchExtractor

直接已知子类:

CmsGalleryDocumentXmlContent, CmsSolrDocumentXmlContent

public class CmsDocumentXmlContent
extends A_CmsVfsDocument

Lucene document factory class to extract index data from an OpenCms VFS resource of type CmsResourceTypeXmlContent.

All XML nodes from the content for all locales will be stored separately in the item map which you can access using CmsExtractionResult.getContentItems(). The XML elements will be accessible using their xpath. The xpath will have the form like for example Text[1] or Nested[1]/Text[1].

从以下版本开始:

6.0.0

字段概要

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

m_name

构造器概要

构造器

构造器和说明
CmsDocumentXmlContent(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 given VFS resource of type CmsResourceTypeXmlContent.
java.util.List<java.lang.String>	getDocumentKeys(java.util.List<java.lang.String> resourceTypes, java.util.List<java.lang.String> mimeTypes) Returns the list of accepted keys for the resource types that can be indexed using this document factory.
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.A_CmsVfsDocument

getCache, getDocumentKey, getName, logContentExtraction, readFile, setCache

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

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

构造器详细资料

CmsDocumentXmlContent

public CmsDocumentXmlContent(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

从类复制的说明: A_CmsVfsDocument

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

指定者:

createDocument 在接口中 I_CmsDocumentFactory

覆盖:

createDocument 在类中 A_CmsVfsDocument

参数:

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 given VFS resource of type CmsResourceTypeXmlContent.

All XML nodes from the content for all locales will be stored separately in the item map which you can access using CmsExtractionResult.getContentItems(). The XML elements will be accessible using their xpath. The xpath will have the form like for example Text[1] or Nested[1]/Text[1].

参数:

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)

getDocumentKeys

public java.util.List<java.lang.String> getDocumentKeys(java.util.List<java.lang.String> resourceTypes,
                                               java.util.List<java.lang.String> mimeTypes)
                                                 throws CmsException

从接口复制的说明: I_CmsDocumentFactory

Returns the list of accepted keys for the resource types that can be indexed using this document factory.

The result List contains String objects. This String is later matched against A_CmsVfsDocument.getDocumentKey(String, String) to find the corrospondig I_CmsDocumentFactory for a resource to index.

The list of accepted resource types may contain a catch-all entry "*"; in this case, a list for all possible resource types is returned, calculated by a logic depending on the document handler class.

指定者:

getDocumentKeys 在接口中 I_CmsDocumentFactory

覆盖:

getDocumentKeys 在类中 A_CmsVfsDocument

参数:

resourceTypes - list of accepted resource types

mimeTypes - list of accepted mime types

返回:

the list of accepted keys for the resource types that can be indexed using this document factory (String objects)

抛出:

CmsException - if something goes wrong

另请参阅:

I_CmsDocumentFactory.getDocumentKeys(java.util.List, java.util.List)

isLocaleDependend

public boolean isLocaleDependend()

从接口复制的说明: I_CmsDocumentFactory

Returns true if this document factory is locale depended.

返回:

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.

返回:

true if result caching is supported for this factory

另请参阅:

I_CmsDocumentFactory.isUsingCache()