org.opencms.search.galleries

类 CmsGalleryDocumentXmlContent

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.CmsDocumentXmlContent

org.opencms.search.galleries.CmsGalleryDocumentXmlContent

所有已实现的接口:

I_CmsDocumentFactory, I_CmsSearchExtractor

public class CmsGalleryDocumentXmlContent
extends CmsDocumentXmlContent

Special document text extraction factory for the gallery index that creates multiple fields for the content in all the languages available in an XML content.

从以下版本开始:

8.0.0

字段概要

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

m_name

构造器概要

构造器

构造器和说明
CmsGalleryDocumentXmlContent(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.
protected java.util.List<java.util.Locale>	getLocalesToStore(A_CmsXmlDocument content) Gets the locales which should be stored in the locale field of the document for the given content.
protected java.util.List<java.util.Locale>	getTargetLocalesForField(A_CmsXmlDocument xmlContent, java.lang.String fieldName, java.util.Locale sourceLocale) Returns the locales which the given field should be written to in the document.
protected boolean	isGroup(A_CmsXmlDocument content) Helper method to check whether the content is an element group.
boolean	isLocaleDependend() Gallery index content is stored in multiple languages, so the result is NOT locale dependent.
protected void	putMappingValue(A_CmsXmlDocument xmlContent, java.lang.String fieldName, java.util.Locale sourceLocale, java.util.Map<java.lang.String,java.lang.String> items, java.lang.String value) Adds the given value to the document items for all target locales.

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

getDocumentKeys, isUsingCache

从类继承的方法 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

构造器详细资料

CmsGalleryDocumentXmlContent

public CmsGalleryDocumentXmlContent(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 gallery document generators, we never check for CmsSearchIndex.isExtractingContent() since all these classes are assumed to be written with optimizations special to gallery search indexing anyway.

指定者:

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

另请参阅:

CmsSearchFieldConfiguration.createDocument(CmsObject, CmsResource, CmsSearchIndex, I_CmsExtractionResult), I_CmsDocumentFactory.createDocument(CmsObject, CmsResource, 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 start with the locale and have the form like for example de/Text[1] or en/Nested[1]/Text[1].

指定者:

extractContent 在接口中 I_CmsSearchExtractor

覆盖:

extractContent 在类中 CmsDocumentXmlContent

参数:

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()

Gallery index content is stored in multiple languages, so the result is NOT locale dependent.

指定者:

isLocaleDependend 在接口中 I_CmsDocumentFactory

覆盖:

isLocaleDependend 在类中 CmsDocumentXmlContent

返回:

true if this document factory is locale depended

另请参阅:

CmsDocumentXmlContent.isLocaleDependend()

getLocalesToStore

protected java.util.List<java.util.Locale> getLocalesToStore(A_CmsXmlDocument content)

Gets the locales which should be stored in the locale field of the document for the given content.

参数:

content - the XML content

返回:

the list of locales for the locale field

getTargetLocalesForField

protected java.util.List<java.util.Locale> getTargetLocalesForField(A_CmsXmlDocument xmlContent,
                                                        java.lang.String fieldName,
                                                        java.util.Locale sourceLocale)

Returns the locales which the given field should be written to in the document.

参数:

xmlContent - the XML content

fieldName - the field name

sourceLocale - the source locale

返回:

the list of locales to which the field should be written

isGroup

protected boolean isGroup(A_CmsXmlDocument content)

Helper method to check whether the content is an element group.

参数:

content - the content to check

返回:

true if the content is an element group

putMappingValue

protected void putMappingValue(A_CmsXmlDocument xmlContent,
                   java.lang.String fieldName,
                   java.util.Locale sourceLocale,
                   java.util.Map<java.lang.String,java.lang.String> items,
                   java.lang.String value)

Adds the given value to the document items for all target locales.

参数:

xmlContent - the XML content

fieldName - the field name

sourceLocale - the source locale

items - the document items

value - the value to put