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

Class ContentParserXls

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

All Implemented Interfaces:

ContentParser

@Singleton
 @Named
public class ContentParserXls
extends AbstractContentParserPoi

This is the implementation of the ContentParser interface for binary MS-Excel documents.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ContentParserXls.ExcelListener This inner class acts as listener for HSSF events and appends the received text to a string-buffer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_EXTENSION The default extension.
static String	KEY_MIMETYPE The mimetype.

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

Method Summary

Modifier and Type	Method and Description
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

Constructor Detail

ContentParserXls

public ContentParserXls()

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()

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.