Package org.opencms.search.documents

Class CmsDocumentPlainText

java.lang.Object

org.opencms.search.documents.A_CmsVfsDocument

org.opencms.search.documents.CmsDocumentPlainText

All Implemented Interfaces:

I_CmsDocumentFactory, I_CmsSearchExtractor

public class CmsDocumentPlainText
extends A_CmsVfsDocument

Lucene document factory class to extract index data from a cms resource containing plain text data.

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
CmsDocumentPlainText(String name)	Creates a new instance of this lucene document factory.

Method Summary

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 containing plain text data.
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.A_CmsVfsDocument

addConfigurationParameter, createDocument, getCache, getConfiguration, getDocumentKey, getDocumentKeys, getName, initConfiguration, logContentExtraction, readFile, setCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.search.documents.I_CmsDocumentFactory

isOnlyDependentOnContent

Constructor Details

CmsDocumentPlainText

public CmsDocumentPlainText(String name)

Creates a new instance of this lucene document factory.

Parameters:

name - name of the documenttype

Method Details

extractContent

public I_CmsExtractionResult extractContent(CmsObject cms,
 CmsResource resource,
 I_CmsSearchIndex index)
                                     throws CmsException

Returns the raw text content of a given vfs resource containing plain text data.

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, I_CmsSearchIndex)

isLocaleDependend

public boolean isLocaleDependend()

Description copied from interface: I_CmsDocumentFactory

Returns true 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

Returns true if result caching is supported for this factory.

Returns:

true if result caching is supported for this factory

See Also:

• I_CmsDocumentFactory.isUsingCache()