ContentParserPpt (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.component.base.AbstractComponent
- - net.sf.mmm.util.component.base.AbstractLoggableComponent
  - - net.sf.mmm.content.parser.base.AbstractContentParser
    - - net.sf.mmm.content.parser.impl.poi.AbstractContentParserPoi
      - net.sf.mmm.content.parser.impl.poi.ContentParserPpt

All Implemented Interfaces:

ContentParser
```
@Singleton
 @Named
public class ContentParserPpt
extends AbstractContentParserPoi
```
This is the implementation of the ContentParser interface for binary MS-Powerpoint documents.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ENCODING_UTF16LE` encoding name
`static String`	`KEY_EXTENSION` The default extension.
`static String`	`KEY_MIMETYPE` The mimetype.
`protected static int`	`PPT_RECORD_INFO_OFFSET` first record item: info (little endian short)
`protected static int`	`PPT_RECORD_LENGTH` third record item: size (little endian int)
`protected static int`	`PPT_RECORD_SIZE_OFFSET` third record item: size (little endian int)
`protected static int`	`PPT_RECORD_TYPE_OFFSET` second record item: type (little endian short)
`protected static int`	`PPT_TYPE_CHAR_STRING` type of character stream
`protected static int`	`PPT_TYPE_DOCUMENT` type of document
`protected static int`	`PPT_TYPE_DOCUMENT_ATOM` type of document atom - ignore
`protected static int`	`PPT_TYPE_DRAWING` type of drawing - ignore
`protected static int`	`PPT_TYPE_DRAWING_GROUP` type of drawing group - ignore
`protected static int`	`PPT_TYPE_ENVIRONMENT` type of environment - ignore
`protected static int`	`PPT_TYPE_ESCHER_DG` type of escher dg
`protected static int`	`PPT_TYPE_ESCHER_DG_CONTAINER` type of escher dg container
`protected static int`	`PPT_TYPE_ESCHER_OPT` type of escher opt
`protected static int`	`PPT_TYPE_ESCHER_SP` type of escher sp
`protected static int`	`PPT_TYPE_ESCHER_SP_CONTAINER` type of escher sp container
`protected static int`	`PPT_TYPE_ESCHER_SPGR_CONTAINER` type of escher spgr container
`protected static int`	`PPT_TYPE_ESCHER_TEXTBOX` type of escher textbox
`protected static int`	`PPT_TYPE_EXTENDED_OBJECT_LIST` type of extended object list - ignore
`protected static int`	`PPT_TYPE_HEADER_FOOTER` type of header/footer
`protected static int`	`PPT_TYPE_HEADER_FOOTER_ATOM` type of header/footer atom
`protected static int`	`PPT_TYPE_INTERACTIVE_INFO` type of interactive info
`protected static int`	`PPT_TYPE_LIST` type of list - ignore
`protected static int`	`PPT_TYPE_MAIN_MASTER` type of main master - ignore
`protected static int`	`PPT_TYPE_NOTES` type of notes
`protected static int`	`PPT_TYPE_NOTES_ATOM` type of notes atom
`protected static int`	`PPT_TYPE_SLIDE` type of slide
`protected static int`	`PPT_TYPE_SLIDE_ATOM` type of slide atom
`protected static int`	`PPT_TYPE_SLIDE_LIST_WITH_TEXT` type of slide-list
`protected static int`	`PPT_TYPE_SLIDE_PERSIST_ATOM` type of slide persist atom - ignore
`protected static int`	`PPT_TYPE_SPEC_INFO_ATOM` type of spec info atom - ignore
`protected static int`	`PPT_TYPE_STYLE_TEXT_PROPERTY_ATOM` type of style text property atom
`protected static int`	`PPT_TYPE_TEXT_BYTES_ATOM` type of text bytes atom
`protected static int`	`PPT_TYPE_TEXT_CHARS_ATOM` type of text chars atom
`protected static int`	`PPT_TYPE_TEXT_HEADER_ATOM` type of text header atom
`protected static int`	`PPT_TYPE_TX_INTERACTIVE_INFO_ATOM` type of interactive info

Fields inherited from class net.sf.mmm.content.parser.impl.poi.AbstractContentParserPoi
POIFS_EXCEL_DOC, POIFS_POWERPOINT_DOC, POIFS_WORD_DOC

Fields inherited from interface net.sf.mmm.content.parser.api.ContentParser
VARIABLE_NAME_CREATOR, VARIABLE_NAME_KEYWORDS, VARIABLE_NAME_LANGUAGE, VARIABLE_NAME_TEXT, VARIABLE_NAME_TITLE

Constructor Summary

Constructors
Constructor and Description

ContentParserPpt()
The constructor.

Constructors
Constructor and Description
`ContentParserPpt()` The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`extractRecursive(byte[] buffer, int offset, int length, StringBuffer textBuffer)`
`protected String`	`extractText(org.apache.poi.poifs.filesystem.POIFSFileSystem poiFs, long filesize, ContentParserOptions options)` This method extracts the text from the office document given by `poiFs`.
`String[]`	`getAlternativeKeyArray()` This method gets the alternative `primary keys` in addition to `extension` and `mimetype`.
`String`	`getExtension()` This method gets the default filename extension excluding the dot (e.g.
`String`	`getMimetype()` This method gets the default mimetype (e.g.

Methods inherited from class net.sf.mmm.content.parser.impl.poi.AbstractContentParserPoi
parse

Methods inherited from class net.sf.mmm.content.parser.base.AbstractContentParser
doInitialize, getPrimaryKeys, getSecondaryKeyArray, getSecondaryKeys, parse, parse, setGenericContextFactory

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent
createLogger, getLogger

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent
doInitialized, getInitializationState, initialize

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

- Field Detail
  - KEY_MIMETYPE
```
public static final String KEY_MIMETYPE
```
    The mimetype.
    
    See Also:
    
    Constant Field Values
  - KEY_EXTENSION
```
public static final String KEY_EXTENSION
```
    The default extension.
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_DOCUMENT
```
protected static final int PPT_TYPE_DOCUMENT
```
    type of document
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_DOCUMENT_ATOM
```
protected static final int PPT_TYPE_DOCUMENT_ATOM
```
    type of document atom - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_SLIDE
```
protected static final int PPT_TYPE_SLIDE
```
    type of slide
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_SLIDE_ATOM
```
protected static final int PPT_TYPE_SLIDE_ATOM
```
    type of slide atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_NOTES
```
protected static final int PPT_TYPE_NOTES
```
    type of notes
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_NOTES_ATOM
```
protected static final int PPT_TYPE_NOTES_ATOM
```
    type of notes atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ENVIRONMENT
```
protected static final int PPT_TYPE_ENVIRONMENT
```
    type of environment - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_SLIDE_PERSIST_ATOM
```
protected static final int PPT_TYPE_SLIDE_PERSIST_ATOM
```
    type of slide persist atom - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_MAIN_MASTER
```
protected static final int PPT_TYPE_MAIN_MASTER
```
    type of main master - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_EXTENDED_OBJECT_LIST
```
protected static final int PPT_TYPE_EXTENDED_OBJECT_LIST
```
    type of extended object list - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_DRAWING_GROUP
```
protected static final int PPT_TYPE_DRAWING_GROUP
```
    type of drawing group - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_DRAWING
```
protected static final int PPT_TYPE_DRAWING
```
    type of drawing - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_LIST
```
protected static final int PPT_TYPE_LIST
```
    type of list - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_TEXT_HEADER_ATOM
```
protected static final int PPT_TYPE_TEXT_HEADER_ATOM
```
    type of text header atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_TEXT_CHARS_ATOM
```
protected static final int PPT_TYPE_TEXT_CHARS_ATOM
```
    type of text chars atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_STYLE_TEXT_PROPERTY_ATOM
```
protected static final int PPT_TYPE_STYLE_TEXT_PROPERTY_ATOM
```
    type of style text property atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_TEXT_BYTES_ATOM
```
protected static final int PPT_TYPE_TEXT_BYTES_ATOM
```
    type of text bytes atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_SPEC_INFO_ATOM
```
protected static final int PPT_TYPE_SPEC_INFO_ATOM
```
    type of spec info atom - ignore
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_CHAR_STRING
```
protected static final int PPT_TYPE_CHAR_STRING
```
    type of character stream
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_HEADER_FOOTER
```
protected static final int PPT_TYPE_HEADER_FOOTER
```
    type of header/footer
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_HEADER_FOOTER_ATOM
```
protected static final int PPT_TYPE_HEADER_FOOTER_ATOM
```
    type of header/footer atom
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_TX_INTERACTIVE_INFO_ATOM
```
protected static final int PPT_TYPE_TX_INTERACTIVE_INFO_ATOM
```
    type of interactive info
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_SLIDE_LIST_WITH_TEXT
```
protected static final int PPT_TYPE_SLIDE_LIST_WITH_TEXT
```
    type of slide-list
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_INTERACTIVE_INFO
```
protected static final int PPT_TYPE_INTERACTIVE_INFO
```
    type of interactive info
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_DG_CONTAINER
```
protected static final int PPT_TYPE_ESCHER_DG_CONTAINER
```
    type of escher dg container
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_SPGR_CONTAINER
```
protected static final int PPT_TYPE_ESCHER_SPGR_CONTAINER
```
    type of escher spgr container
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_SP_CONTAINER
```
protected static final int PPT_TYPE_ESCHER_SP_CONTAINER
```
    type of escher sp container
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_DG
```
protected static final int PPT_TYPE_ESCHER_DG
```
    type of escher dg
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_SP
```
protected static final int PPT_TYPE_ESCHER_SP
```
    type of escher sp
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_OPT
```
protected static final int PPT_TYPE_ESCHER_OPT
```
    type of escher opt
    
    See Also:
    
    Constant Field Values
  - PPT_TYPE_ESCHER_TEXTBOX
```
protected static final int PPT_TYPE_ESCHER_TEXTBOX
```
    type of escher textbox
    
    See Also:
    
    Constant Field Values
  - PPT_RECORD_INFO_OFFSET
```
protected static final int PPT_RECORD_INFO_OFFSET
```
    first record item: info (little endian short)
    
    See Also:
    
    Constant Field Values
  - PPT_RECORD_TYPE_OFFSET
```
protected static final int PPT_RECORD_TYPE_OFFSET
```
    second record item: type (little endian short)
    
    See Also:
    
    Constant Field Values
  - PPT_RECORD_SIZE_OFFSET
```
protected static final int PPT_RECORD_SIZE_OFFSET
```
    third record item: size (little endian int)
    
    See Also:
    
    Constant Field Values
  - PPT_RECORD_LENGTH
```
protected static final int PPT_RECORD_LENGTH
```
    third record item: size (little endian int)
    
    See Also:
    
    Constant Field Values
  - ENCODING_UTF16LE
```
protected static final String ENCODING_UTF16LE
```
    encoding name
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ContentParserPpt
```
public ContentParserPpt()
```
    The constructor.
- Method Detail
  - getExtension
```
public String getExtension()
```
    This method gets the default filename extension excluding the dot (e.g. "txt", "xml", "html", "pdf", etc.) for the content managed by this ContentParser.
    
    Returns:
    
    the default filename extension or null if this is the generic parser.
  - getMimetype
```
public String getMimetype()
```
    This method gets the default mimetype (e.g. "text/plain", "text/xml", "text/html", "application/pdf", etc.) for the content managed by this ContentParser.
    
    Returns:
    
    the default filename extension or null if this is the generic parser.
  - getAlternativeKeyArray
```
public String[] getAlternativeKeyArray()
```
    This method gets the alternative primary keys in addition to extension and mimetype.
    
    Overrides:
    
    getAlternativeKeyArray in class AbstractContentParser
    
    Returns:
    
    an array with the alternative keys.
    
    See Also:
    
    AbstractContentParser.getPrimaryKeys()
  - extractRecursive
```
private void extractRecursive(byte[] buffer,
                              int offset,
                              int length,
                              StringBuffer textBuffer)
                       throws UnsupportedEncodingException
```
    Parameters:
    
    buffer -
    
    offset -
    
    length -
    
    textBuffer -
    
    Throws:
    
    UnsupportedEncodingException
  - extractText
```
protected String extractText(org.apache.poi.poifs.filesystem.POIFSFileSystem poiFs,
                             long filesize,
                             ContentParserOptions options)
                      throws Exception
```
    This method extracts the text from the office document given by poiFs.
    
    Specified by:
    
    extractText in class AbstractContentParserPoi
    
    Parameters:
    
    poiFs - is the POI filesystem of the office document.
    
    filesize - is the size (content-length) of the content to parse in bytes or 0 if NOT available (unknown). If available, the parser may use this value for optimized allocations.
    
    options - are the ContentParserOptions.
    
    Returns:
    
    the plain text extracted from the content.
    
    Throws:
    
    Exception - if something goes wrong.

Class ContentParserPpt

Field Summary

Fields inherited from class net.sf.mmm.content.parser.impl.poi.AbstractContentParserPoi

Fields inherited from interface net.sf.mmm.content.parser.api.ContentParser

Constructor Summary

Method Summary

Methods inherited from class net.sf.mmm.content.parser.impl.poi.AbstractContentParserPoi

Methods inherited from class net.sf.mmm.content.parser.base.AbstractContentParser

Methods inherited from class net.sf.mmm.util.component.base.AbstractLoggableComponent

Methods inherited from class net.sf.mmm.util.component.base.AbstractComponent

Methods inherited from class java.lang.Object

Field Detail

KEY_MIMETYPE

KEY_EXTENSION

PPT_TYPE_DOCUMENT

PPT_TYPE_DOCUMENT_ATOM

PPT_TYPE_SLIDE

PPT_TYPE_SLIDE_ATOM

PPT_TYPE_NOTES

PPT_TYPE_NOTES_ATOM

PPT_TYPE_ENVIRONMENT

PPT_TYPE_SLIDE_PERSIST_ATOM

PPT_TYPE_MAIN_MASTER

PPT_TYPE_EXTENDED_OBJECT_LIST

PPT_TYPE_DRAWING_GROUP

PPT_TYPE_DRAWING

PPT_TYPE_LIST

PPT_TYPE_TEXT_HEADER_ATOM

PPT_TYPE_TEXT_CHARS_ATOM

PPT_TYPE_STYLE_TEXT_PROPERTY_ATOM

PPT_TYPE_TEXT_BYTES_ATOM

PPT_TYPE_SPEC_INFO_ATOM

PPT_TYPE_CHAR_STRING

PPT_TYPE_HEADER_FOOTER

PPT_TYPE_HEADER_FOOTER_ATOM

PPT_TYPE_TX_INTERACTIVE_INFO_ATOM

PPT_TYPE_SLIDE_LIST_WITH_TEXT

PPT_TYPE_INTERACTIVE_INFO

PPT_TYPE_ESCHER_DG_CONTAINER

PPT_TYPE_ESCHER_SPGR_CONTAINER

PPT_TYPE_ESCHER_SP_CONTAINER

PPT_TYPE_ESCHER_DG

PPT_TYPE_ESCHER_SP

PPT_TYPE_ESCHER_OPT

PPT_TYPE_ESCHER_TEXTBOX

PPT_RECORD_INFO_OFFSET

PPT_RECORD_TYPE_OFFSET

PPT_RECORD_SIZE_OFFSET

PPT_RECORD_LENGTH

ENCODING_UTF16LE

Constructor Detail

ContentParserPpt

Method Detail

getExtension

getMimetype

getAlternativeKeyArray

extractRecursive

extractText