net.sf.mmm.content.parser.impl.poi

Class AbstractContentParserPoi

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

All Implemented Interfaces:

ContentParser

Direct Known Subclasses:

ContentParserDoc, ContentParserPpt, ContentParserXls

public abstract class AbstractContentParserPoi
extends AbstractContentParser

This is the abstract base implementation of the ContentParser interface for parsing binary Microsoft office documents using apache POI.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	POIFS_EXCEL_DOC name of the entry for a excel document in the POI filesystem
static String	POIFS_POWERPOINT_DOC name of the entry for a powerpoint document in the POI filesystem
static String	POIFS_WORD_DOC name of the entry for a word document in the POI filesystem

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
AbstractContentParserPoi() The constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract 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.
void	parse(InputStream inputStream, long filesize, ContentParserOptions options, MutableGenericContext context)

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

doInitialize, getAlternativeKeyArray, 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

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

getExtension, getMimetype

Field Detail

POIFS_WORD_DOC

public static final String POIFS_WORD_DOC

name of the entry for a word document in the POI filesystem

See Also:

Constant Field Values

POIFS_POWERPOINT_DOC

public static final String POIFS_POWERPOINT_DOC

name of the entry for a powerpoint document in the POI filesystem

See Also:

Constant Field Values

POIFS_EXCEL_DOC

public static final String POIFS_EXCEL_DOC

name of the entry for a excel document in the POI filesystem

See Also:

Constant Field Values

Constructor Detail

AbstractContentParserPoi

public AbstractContentParserPoi()

The constructor.

Method Detail

parse

public void parse(InputStream inputStream,
                  long filesize,
                  ContentParserOptions options,
                  MutableGenericContext context)
           throws Exception

Specified by:

parse in class AbstractContentParser

Parameters:

inputStream - is the fresh input stream of the content to parse.

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.

context - is the MutableGenericContext where the extracted metadata from the parsed inputStream will be added to.

Throws:

Exception - if the operation fails for arbitrary reasons.

See Also:

ContentParser.parse(InputStream, long)

extractText

protected abstract 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.

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.