org.opencms.search.solr
Class 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

All Implemented Interfaces:

I_CmsDocumentFactory, I_CmsSearchExtractor

public class CmsSolrDocumentContainerPage
extends CmsSolrDocumentXmlContent

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

Since:

8.5.0

Field Summary

static java.lang.String

TYPE_CONTAINERPAGE_SOLR The solr document type name for xml-contents.

Fields inherited from class org.opencms.search.solr.CmsSolrDocumentXmlContent

TYPE_XMLCONTENT_SOLR

Fields inherited from class org.opencms.search.documents.A_CmsVfsDocument

m_name

Constructor Summary

CmsSolrDocumentContainerPage(java.lang.String name)
Creates a new instance of this lucene document factory.

Method Summary

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.

Methods inherited from class org.opencms.search.documents.CmsDocumentXmlContent

getDocumentKeys

Methods inherited from class org.opencms.search.documents.A_CmsVfsDocument

getCache, getDocumentKey, getName, logContentExtraction, readFile, setCache

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CONTAINERPAGE_SOLR

public static final java.lang.String TYPE_CONTAINERPAGE_SOLR

The solr document type name for xml-contents.

See Also:

Constant Field Values

Constructor Detail

CmsSolrDocumentContainerPage

public CmsSolrDocumentContainerPage(java.lang.String name)

Creates a new instance of this lucene document factory.

Parameters:

name - name of the document type

Method Detail

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.

Specified by:

createDocument in interface I_CmsDocumentFactory

Overrides:

createDocument in class CmsDocumentXmlContent

Parameters:

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

Returns:

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

Throws:

CmsException - if something goes wrong

See Also:

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.

Specified by:

extractContent in interface I_CmsSearchExtractor

Overrides:

extractContent in class CmsSolrDocumentXmlContent

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 something goes wrong

See Also:

I_CmsSearchExtractor.extractContent(CmsObject, CmsResource, CmsSearchIndex)

isLocaleDependend

public boolean isLocaleDependend()

Description copied from interface: I_CmsDocumentFactory

Returns true if this document factory is locale depended.

Specified by:

isLocaleDependend in interface I_CmsDocumentFactory

Overrides:

isLocaleDependend in class CmsDocumentXmlContent

Returns:

true if this document factory is locale depended

See Also:

I_CmsDocumentFactory.isLocaleDependend()

isUsingCache

public boolean isUsingCache()

Description copied from interface: I_CmsDocumentFactory

Returns true if result caching is supported for this factory.

Specified by:

isUsingCache in interface I_CmsDocumentFactory

Overrides:

isUsingCache in class CmsDocumentXmlContent

Returns:

true if result caching is supported for this factory

See Also:

I_CmsDocumentFactory.isUsingCache()