A_CmsTextExtractorMsOfficeBase (pdp-cms 5.0.2 API)

java.lang.Object
- com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractor
- - com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractorMsOfficeBase

All Implemented Interfaces:

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

Direct Known Subclasses:

CmsExtractorMsExcel, CmsExtractorMsPowerPoint, CmsExtractorMsWord
```
public abstract class A_CmsTextExtractorMsOfficeBase
extends A_CmsTextExtractor
implements org.apache.poi.poifs.eventfilesystem.POIFSReaderListener, java.io.Serializable
```
Base class to extract summary information from MS office documents.

Since:

6.0.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.poi.POIXMLProperties.CoreProperties`	`cp`
`protected static java.lang.String`	`ENCODING_CP1252` Windows Cp1252 endocing (western europe) is used as default for single byte fields.
`protected static java.lang.String`	`ENCODING_UTF16` UTF-16 encoding is used for double byte fields.
`protected org.apache.poi.hpsf.DocumentSummaryInformation`	`m_documentSummary` The summary of the POI document.
`protected org.apache.poi.hpsf.SummaryInformation`	`m_summary` The summary of the POI document.
`protected static java.lang.String`	`POWERPOINT_EVENT_NAME` Event event name for a MS PowerPoint document.
`protected static int`	`PPT_TEXTBYTE_ATOM` PPT text byte atom.
`protected static int`	`PPT_TEXTCHAR_ATOM` PPT text char atom.
`protected java.lang.String`	`version`

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

Constructor Summary

Constructors
Constructor and Description

A_CmsTextExtractorMsOfficeBase()

Constructors
Constructor and Description
`A_CmsTextExtractorMsOfficeBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`cleanup()` Cleans up some internal memory.
`protected java.util.Map`	`extractMetaInformation()`
`protected java.util.Map`	`extractMetaInformation2003()` Returns a map with the extracted meta information from the document.
`protected java.util.Map`	`extractMetaInformation2007()` Returns a map with the extracted meta information from the document.
`void`	`processPOIFSReaderEvent(org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent event)`

Methods inherited from class com.frameworkset.platform.cms.searchmanager.extractors.A_CmsTextExtractor
extractText, extractText, extractText, extractText, getStreamCopy, removeControlChars

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENCODING_CP1252
```
protected static final java.lang.String ENCODING_CP1252
```
    Windows Cp1252 endocing (western europe) is used as default for single byte fields.
    
    See Also:
    
    Constant Field Values
  - ENCODING_UTF16
```
protected static final java.lang.String ENCODING_UTF16
```
    UTF-16 encoding is used for double byte fields.
    
    See Also:
    
    Constant Field Values
  - POWERPOINT_EVENT_NAME
```
protected static final java.lang.String POWERPOINT_EVENT_NAME
```
    Event event name for a MS PowerPoint document.
    
    See Also:
    
    Constant Field Values
  - PPT_TEXTBYTE_ATOM
```
protected static final int PPT_TEXTBYTE_ATOM
```
    PPT text byte atom.
    
    See Also:
    
    Constant Field Values
  - PPT_TEXTCHAR_ATOM
```
protected static final int PPT_TEXTCHAR_ATOM
```
    PPT text char atom.
    
    See Also:
    
    Constant Field Values
  - m_documentSummary
```
protected org.apache.poi.hpsf.DocumentSummaryInformation m_documentSummary
```
    The summary of the POI document.
  - m_summary
```
protected org.apache.poi.hpsf.SummaryInformation m_summary
```
    The summary of the POI document.
  - cp
```
protected org.apache.poi.POIXMLProperties.CoreProperties cp
```
  - version
```
protected java.lang.String version
```
- Constructor Detail
  - A_CmsTextExtractorMsOfficeBase
```
public A_CmsTextExtractorMsOfficeBase()
```
- Method Detail
  - processPOIFSReaderEvent
```
public void processPOIFSReaderEvent(org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent event)
```
    Specified by:
    
    processPOIFSReaderEvent in interface org.apache.poi.poifs.eventfilesystem.POIFSReaderListener
    
    See Also:
    
    POIFSReaderListener.processPOIFSReaderEvent(org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent)
  - cleanup
```
protected void cleanup()
```
    Cleans up some internal memory.
  - extractMetaInformation
```
protected java.util.Map extractMetaInformation()
```
  - extractMetaInformation2003
```
protected java.util.Map extractMetaInformation2003()
```
    Returns a map with the extracted meta information from the document.
    
    Returns:
    
    a map with the extracted meta information from the document
  - extractMetaInformation2007
```
protected java.util.Map extractMetaInformation2007()
```
    Returns a map with the extracted meta information from the document.
    
    Returns:
    
    a map with the extracted meta information from the document

Class A_CmsTextExtractorMsOfficeBase

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ENCODING_CP1252

ENCODING_UTF16

POWERPOINT_EVENT_NAME

PPT_TEXTBYTE_ATOM

PPT_TEXTCHAR_ATOM

m_documentSummary

m_summary

cp

version

Constructor Detail

A_CmsTextExtractorMsOfficeBase

Method Detail

processPOIFSReaderEvent

cleanup

extractMetaInformation

extractMetaInformation2003

extractMetaInformation2007