Package org.opencms.search.documents
Class CmsDocumentContainerPage
- java.lang.Object
-
- org.opencms.search.documents.A_CmsVfsDocument
-
- org.opencms.search.documents.CmsDocumentContainerPage
-
- All Implemented Interfaces:
I_CmsDocumentFactory
,I_CmsSearchExtractor
public class CmsDocumentContainerPage extends A_CmsVfsDocument
Lucene document factory class to extract index data from a resource of typeCmsResourceTypeContainerPage
.- Since:
- 8.0
-
-
Field Summary
-
Fields inherited from class org.opencms.search.documents.A_CmsVfsDocument
DEFAULT_ALL_TYPES, DEFAULT_ALL_UNCONFIGURED_TYPES, m_name
-
-
Constructor Summary
Constructors Constructor Description CmsDocumentContainerPage(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_CmsSearchDocument
createDocument(CmsObject cms, CmsResource resource, I_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, I_CmsSearchIndex index)
Returns the raw text content of a VFS resource of typeCmsResourceTypeContainerPage
.boolean
isLocaleDependend()
Returnstrue
if this document factory is locale depended.boolean
isUsingCache()
Returnstrue
if result caching is supported for this factory.-
Methods inherited from class org.opencms.search.documents.A_CmsVfsDocument
getCache, getDocumentKey, getDocumentKeys, getName, logContentExtraction, readFile, setCache
-
-
-
-
Constructor Detail
-
CmsDocumentContainerPage
public CmsDocumentContainerPage(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, I_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 interfaceI_CmsDocumentFactory
- Overrides:
createDocument
in classA_CmsVfsDocument
- Parameters:
cms
- the OpenCms user context used to access the OpenCms VFSresource
- the search index resource to create the Lucene document fromindex
- 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:
I_CmsDocumentFactory.createDocument(CmsObject, CmsResource, I_CmsSearchIndex)
-
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
.- 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)
-
isLocaleDependend
public boolean isLocaleDependend()
Description copied from interface:I_CmsDocumentFactory
Returnstrue
if this document factory is locale depended.- 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.- Returns:
true
if result caching is supported for this factory- See Also:
I_CmsDocumentFactory.isUsingCache()
-
-