Package org.opencms.search.documents
Class CmsDocumentXmlPage
- java.lang.Object
-
- org.opencms.search.documents.A_CmsVfsDocument
-
- org.opencms.search.documents.CmsDocumentXmlPage
-
- All Implemented Interfaces:
I_CmsDocumentFactory
,I_CmsSearchExtractor
public class CmsDocumentXmlPage extends A_CmsVfsDocument
Lucene document factory class to extract index data from a cms resource of typeCmsResourceTypeXmlPage
.- Since:
- 6.0.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 CmsDocumentXmlPage(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 given vfs resource of typeCmsResourceTypeXmlPage
.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
createDocument, getCache, getDocumentKey, getDocumentKeys, getName, logContentExtraction, readFile, setCache
-
-
-
-
Constructor Detail
-
CmsDocumentXmlPage
public CmsDocumentXmlPage(java.lang.String name)
Creates a new instance of this lucene document factory.- Parameters:
name
- name of the documenttype
-
-
Method Detail
-
extractContent
public I_CmsExtractionResult extractContent(CmsObject cms, CmsResource resource, I_CmsSearchIndex index) throws CmsException
Returns the raw text content of a given vfs resource of typeCmsResourceTypeXmlPage
.- 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()
-
-