net.sf.mmm.content.parser.impl.xml

Class ContentParserXml

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.xml.ContentParserXml

All Implemented Interfaces:

ContentParser

@Singleton
 @Named
public class ContentParserXml
extends AbstractContentParser

This is the implementation of the ContentParser interface for XML documents (content with the mimetype "text/xml").
It does NOT use a standard XML parser such as SAX or StAX to be fault tolerant. Still it supports XML encoding declarations, entities, CDATA sections, etc. Features like XInclude or entity-includes are (intentionally) NOT supported.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() This method performs the actual initialization.
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.
String[]	getSecondaryKeyArray() This method gets the secondary keys as array.
protected XmlUtil	getXmlUtil()
void	parse(BufferedReader bufferedReader, ContentParserOptions options, MutableGenericContext context, StringBuilder textBuffer) This method parses the content of the given bufferedReader and appends the textual content to the textBuffer.
void	parse(InputStream inputStream, long filesize, ContentParserOptions options, MutableGenericContext context)
void	setXmlUtil(XmlUtil xmlUtil)

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

getPrimaryKeys, 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

xmlUtil

private XmlUtil xmlUtil

See Also:

getXmlUtil()

Constructor Detail

ContentParserXml

public ContentParserXml()

The constructor.

Method Detail

doInitialize

protected void doInitialize()

This method performs the actual initialization. It is called when AbstractComponent.initialize() is invoked for the first time.
ATTENTION:
When you override this method from a sub-class you need to do a super.AbstractComponent.doInitialize().

Overrides:

doInitialize in class AbstractContentParser

getXmlUtil

protected XmlUtil getXmlUtil()

Returns:

the xmlUtil

setXmlUtil

@Inject
public void setXmlUtil(XmlUtil xmlUtil)

Parameters:

xmlUtil - is the xmlUtil to set

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

getSecondaryKeyArray

public String[] getSecondaryKeyArray()

This method gets the secondary keys as array. This is just a convenience to make it easier for the implementors of individual parsers not to deal with creating a Set and make it unmodifiable.

Overrides:

getSecondaryKeyArray in class AbstractContentParser

Returns:

an array with the alternative keys.

See Also:

AbstractContentParser.getPrimaryKeys()

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)

parse

public void parse(BufferedReader bufferedReader,
                  ContentParserOptions options,
                  MutableGenericContext context,
                  StringBuilder textBuffer)
           throws Exception

This method parses the content of the given bufferedReader and appends the textual content to the textBuffer. Additional metadata can directly be set in the given properties.

Parameters:

bufferedReader - is where to read the content from.

options - are the ContentParserOptions.

context - is where the metadata is collected.

textBuffer - is the buffer where the textual content should be appended to.

Throws:

Exception - if something goes wrong.