com.frameworkset.platform.cms.searchmanager.extractors

Class CmsExtractorMsWord

java.lang.Object

com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractor

com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractorMsOfficeBase

com.frameworkset.platform.cms.searchmanager.extractors.CmsExtractorMsWord

All Implemented Interfaces:

I_CmsTextExtractor, java.io.Serializable, org.apache.poi.poifs.eventfilesystem.POIFSReaderListener

public final class CmsExtractorMsWord
extends A_CmsTextExtractorMsOfficeBase
implements java.io.Serializable

Extracts the text form an MS Word document.

Since:

6.0.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractorMsOfficeBase

cp, ENCODING_CP1252, ENCODING_UTF16, m_documentSummary, m_summary, POWERPOINT_EVENT_NAME, PPT_TEXTBYTE_ATOM, PPT_TEXTCHAR_ATOM

Fields inherited from class com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractor

m_inputBuffer

Constructor Summary

Constructors

Constructor and Description
CmsExtractorMsWord(java.lang.String version) Hide the public constructor.

Method Summary

Modifier and Type	Method and Description
I_CmsExtractionResult	extractText(java.io.InputStream in, java.lang.String encoding) Extracts the text and meta information from the document on the input stream, using the specified content encoding.

Methods inherited from class com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractorMsOfficeBase

cleanup, extractMetaInformation, extractMetaInformation2003, extractMetaInformation2007, processPOIFSReaderEvent

Methods inherited from class com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractor

extractText, extractText, extractText, getStreamCopy, removeControlChars

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsExtractorMsWord

public CmsExtractorMsWord(java.lang.String version)

Hide the public constructor.

Method Detail

extractText

public I_CmsExtractionResult extractText(java.io.InputStream in,
                                         java.lang.String encoding)
                                  throws java.lang.Exception

Description copied from interface: I_CmsTextExtractor

Extracts the text and meta information from the document on the input stream, using the specified content encoding.

The encoding is a hint for the text extractor, if the value given is null then the text extractor should try to figure out the encoding itself.

Specified by:

extractText in interface I_CmsTextExtractor

Overrides:

extractText in class A_CmsTextExtractor

Parameters:

in - the input stream for the document to extract the text from

encoding - the encoding to use

Returns:

the extracted text and meta information

Throws:

java.lang.Exception - if the text extration fails

See Also:

org.opencms.search.extractors.I_CmsTextExtractor#extractText(java.io.InputStream, java.lang.String)