org.opencms.search.galleries
Class CmsGalleryDocumentXmlContent

java.lang.Object
  extended by org.opencms.search.documents.A_CmsVfsDocument
      extended by org.opencms.search.documents.CmsDocumentXmlContent
          extended by org.opencms.search.galleries.CmsGalleryDocumentXmlContent
All Implemented Interfaces:
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.

Since:
8.0.0

Field Summary
 
Fields inherited from class org.opencms.search.documents.A_CmsVfsDocument
m_name
 
Constructor Summary
CmsGalleryDocumentXmlContent(java.lang.String name)
          Creates a new instance of this Lucene document factory.
 
Method Summary
 I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, CmsSearchIndex index)
          Returns the raw text content of a given VFS resource of type CmsResourceTypeXmlContent.
 boolean isLocaleDependend()
          Gallery index content is stored in multiple languages, so the result is NOT locale dependent.
 
Methods inherited from class org.opencms.search.documents.CmsDocumentXmlContent
getDocumentKeys, isUsingCache
 
Methods inherited from class org.opencms.search.documents.A_CmsVfsDocument
createDocument, getCache, getDocumentKey, getName, readFile, setCache
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmsGalleryDocumentXmlContent

public CmsGalleryDocumentXmlContent(java.lang.String name)
Creates a new instance of this Lucene document factory.

Parameters:
name - name of the document type
Method Detail

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].

Specified by:
extractContent in interface I_CmsSearchExtractor
Overrides:
extractContent in class CmsDocumentXmlContent
Parameters:
cms - the cms object
resource - the resource to extract the content from
index - the index to extract the content for
Returns:
the extracted content of the resource
Throws:
CmsException - if somethin goes wrong
See Also:
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.

Specified by:
isLocaleDependend in interface I_CmsDocumentFactory
Overrides:
isLocaleDependend in class CmsDocumentXmlContent
Returns:
true if this document factory is locale depended
See Also:
CmsDocumentXmlContent.isLocaleDependend()