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

Class AbstractContentParserOoxml

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.AbstractContentParserOoxml

All Implemented Interfaces:

ContentParser

Direct Known Subclasses:

ContentParserDocx, ContentParserPptx, ContentParserXlsx

public abstract class AbstractContentParserOoxml
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	KEY_MIMETYPE_GENERIC The generic mimetype for OOXML.

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

Method Summary

Modifier and Type	Method and Description
protected org.apache.poi.POIXMLTextExtractor	createExtractor(org.apache.poi.openxml4j.opc.OPCPackage opcPackage) This method creates the POIXMLTextExtractor for the given opcPackage.
protected String	extractText(org.apache.poi.POIXMLTextExtractor extractor, long filesize) 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

KEY_MIMETYPE_GENERIC

public static final String KEY_MIMETYPE_GENERIC

The generic mimetype for OOXML.

See Also:

Constant Field Values

Constructor Detail

AbstractContentParserOoxml

public AbstractContentParserOoxml()

The constructor.

Method Detail

createExtractor

protected org.apache.poi.POIXMLTextExtractor createExtractor(org.apache.poi.openxml4j.opc.OPCPackage opcPackage)
                                                      throws Exception

This method creates the POIXMLTextExtractor for the given opcPackage.

Parameters:

opcPackage - is the OPCPackage.

Returns:

the POIXMLTextExtractor.

Throws:

Exception - if something goes wrong.

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 String extractText(org.apache.poi.POIXMLTextExtractor extractor,
                             long filesize)
                      throws Exception

This method extracts the text from the office document given by poiFs.

Parameters:

extractor - is the POIXMLTextExtractor.

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.

Returns:

the plain text extracted from the content.

Throws:

Exception - if something goes wrong.