Package org.opencms.search.solr
Class CmsSolrDocumentContainerPage
- java.lang.Object
-
- org.opencms.search.documents.A_CmsVfsDocument
-
- 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 typeCmsResourceTypeContainerPage
.- Since:
- 8.5.0
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPE_CONTAINERPAGE_SOLR
The solr document type name for xml-contents.-
Fields inherited from class org.opencms.search.solr.CmsSolrDocumentXmlContent
MAPPING_GALLERY_DESCRIPTION, MAPPING_GALLERY_NAME
-
Fields inherited from class org.opencms.search.documents.A_CmsVfsDocument
DEFAULT_ALL_TYPES, DEFAULT_ALL_UNCONFIGURED_TYPES, m_name
-
-
Constructor Summary
Constructors Constructor Description CmsSolrDocumentContainerPage(java.lang.String name)
Creates a new instance of this lucene document factory.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description I_CmsExtractionResult
extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index)
Returns the raw text content of a VFS resource of typeCmsResourceTypeContainerPage
.I_CmsExtractionResult
extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, java.util.Locale forceLocale)
Extracts the content of a given index resource according to the resource file type and the configuration of the given index.boolean
isLocaleDependend()
Solr index content is stored in multiple languages, so the result is NOT locale dependent.boolean
isUsingCache()
Returnstrue
if result caching is supported for this factory.-
Methods inherited from class org.opencms.search.solr.CmsSolrDocumentXmlContent
collectSchemaXpathsForSimpleValues, extractXmlContent, extractXmlContent, extractXmlContent, extractXmlContent
-
Methods inherited from class org.opencms.search.documents.A_CmsVfsDocument
createDocument, getCache, getDocumentKey, getDocumentKeys, getName, logContentExtraction, readFile, setCache
-
-
-
-
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
-
extractContent
public I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) throws CmsException
Returns the raw text content of a VFS resource of typeCmsResourceTypeContainerPage
.- Specified by:
extractContent
in interfaceI_CmsSearchExtractor
- Overrides:
extractContent
in classCmsSolrDocumentXmlContent
- Parameters:
cms
- the cms objectresource
- the resource to extract the content fromindex
- 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, I_CmsSearchIndex)
-
extractContent
public I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index, java.util.Locale forceLocale) throws CmsException
Extracts the content of a given index resource according to the resource file type and the configuration of the given index.- Parameters:
cms
- the cms objectresource
- the resource to extract the content fromindex
- the index to extract the content forforceLocale
- if set, only the content values for the given locale will be extracted- Returns:
- the extracted content of the resource
- Throws:
CmsException
- if something goes wrong
-
isLocaleDependend
public boolean isLocaleDependend()
Description copied from class:CmsSolrDocumentXmlContent
Solr index content is stored in multiple languages, so the result is NOT locale dependent.- Specified by:
isLocaleDependend
in interfaceI_CmsDocumentFactory
- Overrides:
isLocaleDependend
in classCmsSolrDocumentXmlContent
- Returns:
true
if this document factory is locale depended- See Also:
I_CmsDocumentFactory.isLocaleDependend()
-
isUsingCache
public boolean isUsingCache()
Description copied from interface:I_CmsDocumentFactory
Returnstrue
if result caching is supported for this factory.- Specified by:
isUsingCache
in interfaceI_CmsDocumentFactory
- Overrides:
isUsingCache
in classCmsSolrDocumentXmlContent
- Returns:
true
if result caching is supported for this factory- See Also:
I_CmsDocumentFactory.isUsingCache()
-
-