net.sf.mmm.content.parser.impl.opendoc

Class AbstractContentParserOpenDoc

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.opendoc.AbstractContentParserOpenDoc

All Implemented Interfaces:

ContentParser

Direct Known Subclasses:

ContentParserOdb, ContentParserOdc, ContentParserOdf, ContentParserOdg, ContentParserOdi, ContentParserOdm, ContentParserOdp, ContentParserOds, ContentParserOdt, ContentParserOth

public abstract class AbstractContentParserOpenDoc
extends AbstractContentParser

This is the abstract base-implementation of a ContentParser for content of the open-document format (content with the mimetypes "application/vnd.oasis.opendocument.*").

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private static String	ENTRY_CONTENT_XML the content.xml entry of the document
private static String	ENTRY_META_XML the meta.xml entry of the document
private static String	ENTRY_STYLES_XML the styles.xml entry of the document
private static Set<String>	TEXT_TAGS The Set of XML tags that contain relevant text.

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

Method Summary

Modifier and Type	Method and Description
void	parse(InputStream inputStream, long filesize, ContentParserOptions options, MutableGenericContext context)
protected void	parseContent(InputStream inputStream, ContentParserOptions options, MutableGenericContext context, StringBuilder buffer) This method parses the content of the document.
protected void	parseMetadata(InputStream inputStream, ContentParserOptions options, MutableGenericContext context) This method parses the metadata of the document.
protected void	parseStyles(InputStream inputStream, ContentParserOptions options, MutableGenericContext context, StringBuilder buffer) This method parses the content of the document.

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

ENTRY_CONTENT_XML

private static final String ENTRY_CONTENT_XML

the content.xml entry of the document

See Also:

Constant Field Values

ENTRY_META_XML

private static final String ENTRY_META_XML

the meta.xml entry of the document

See Also:

Constant Field Values

ENTRY_STYLES_XML

private static final String ENTRY_STYLES_XML

the styles.xml entry of the document

See Also:

Constant Field Values

TEXT_TAGS

private static final Set<String> TEXT_TAGS

The Set of XML tags that contain relevant text.

Constructor Detail

AbstractContentParserOpenDoc

public AbstractContentParserOpenDoc()

The constructor.

Method Detail

parseMetadata

protected void parseMetadata(InputStream inputStream,
                             ContentParserOptions options,
                             MutableGenericContext context)
                      throws Exception

This method parses the metadata of the document.

Parameters:

inputStream - is the InputStream where to read the metadata from.

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.

parseContent

protected void parseContent(InputStream inputStream,
                            ContentParserOptions options,
                            MutableGenericContext context,
                            StringBuilder buffer)
                     throws Exception

This method parses the content of the document.

Parameters:

inputStream - is the InputStream where to read the metadata from.

options - are the ContentParserOptions

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

buffer - is the StringBuilder where to append the text.

Throws:

Exception - if the operation fails for arbitrary reasons.

parseStyles

protected void parseStyles(InputStream inputStream,
                           ContentParserOptions options,
                           MutableGenericContext context,
                           StringBuilder buffer)
                    throws Exception

This method parses the content of the document.

Parameters:

inputStream - is the InputStream where to read the metadata from.

options - are the ContentParserOptions

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

buffer - is the StringBuilder where to append the text.

Throws:

Exception - if the operation fails for arbitrary reasons.

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)