net.sf.mmm.content.parser.impl.text

Class AbstractContentParserText

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.text.AbstractContentParserText

All Implemented Interfaces:

ContentParser

Direct Known Subclasses:

AbstractContentParserTextMarkupAware, ContentParserText

public abstract class AbstractContentParserText
extends AbstractContentParser

This is the abstract base implementation of a ContentParser for plain text.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private EncodingUtil	encodingUtil
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
AbstractContentParserText() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize() This method performs the actual initialization.
protected EncodingUtil	getEncodingUtil() This method gets the EncodingUtil to use.
String	getExtension() This method gets the default filename extension excluding the dot (e.g.
String	getMimetype() This method gets the default mimetype (e.g.
protected XmlUtil	getXmlUtil() This method gets the XmlUtil.
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)
protected void	parseLine(MutableGenericContext context, String line) This method may be overridden to parse additional metadata from the content.
protected void	parseProperty(MutableGenericContext context, String line, Pattern pattern, String propertyName, int group) This method checks if the property identified by propertyName already exists.
protected String	parseProperty(String line, Pattern pattern, int group) This method tries to extract a property value using the given pattern that has to produce it in the given group.
void	setEncodingUtil(EncodingUtil encodingUtil)
void	setXmlUtil(XmlUtil xmlUtil) This method sets the XmlUtil to use.

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

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

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

encodingUtil

private EncodingUtil encodingUtil

See Also:

getEncodingUtil()

xmlUtil

private XmlUtil xmlUtil

See Also:

getXmlUtil()

Constructor Detail

AbstractContentParserText

public AbstractContentParserText()

The constructor.

Method Detail

getEncodingUtil

protected EncodingUtil getEncodingUtil()

This method gets the EncodingUtil to use.

Returns:

the EncodingUtil to use.

setEncodingUtil

@Inject
public void setEncodingUtil(EncodingUtil encodingUtil)

Parameters:

encodingUtil - is the encodingUtil to set

getXmlUtil

protected XmlUtil getXmlUtil()

This method gets the XmlUtil.

Returns:

the xmlUtil

setXmlUtil

@Inject
public void setXmlUtil(XmlUtil xmlUtil)

This method sets the XmlUtil to use.

Parameters:

xmlUtil - is the XmlUtil to use.

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

parseProperty

protected String parseProperty(String line,
                               Pattern pattern,
                               int group)

This method tries to extract a property value using the given pattern that has to produce it in the given group.

Parameters:

line - is a single line read from the text.

pattern - is the regular expression pattern.

group - is the group number of the property in the pattern.

Returns:

the property or null if the pattern did NOT match.

parseProperty

protected void parseProperty(MutableGenericContext context,
                             String line,
                             Pattern pattern,
                             String propertyName,
                             int group)

This method checks if the property identified by propertyName already exists. If NOT, it tries to extract it using the given pattern that produces the property in the given group.

Parameters:

context - are the properties with the collected metadata.

line - is a single line read from the text.

pattern - is the regular expression pattern.

propertyName - is the name of the property to extract.

group - is the group number of the property in the pattern.

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.

parseLine

protected void parseLine(MutableGenericContext context,
                         String line)

This method may be overridden to parse additional metadata from the content.

Parameters:

context - are the properties with the collected metadata.

line - is a single line read from the text.

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.