Package org.apache.tika.parser.mbox

Class MboxParser

java.lang.Object

org.apache.tika.parser.mbox.MboxParser

All Implemented Interfaces:

Serializable, Parser

public class MboxParser
extends Object
implements Parser

Mbox (mailbox) parser. This version extracts each mail from Mbox and uses the DelegatingParser to process each mail.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAIL_MAX_SIZE
static String	MBOX_MIME_TYPE
static String	MBOX_RECORD_DIVIDER

Constructor Summary

Constructors

Constructor	Description
MboxParser()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
Map<Integer,Metadata>	getTrackingMetadata()
boolean	isTracking()
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.
void	setTracking(boolean tracking)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MBOX_MIME_TYPE

public static final String MBOX_MIME_TYPE

See Also:

Constant Field Values

MBOX_RECORD_DIVIDER

public static final String MBOX_RECORD_DIVIDER

See Also:

Constant Field Values

MAIL_MAX_SIZE

public static final int MAIL_MAX_SIZE

See Also:

Constant Field Values

Constructor Detail

MboxParser

public MboxParser()

Method Detail

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(InputStream stream,
                  ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws IOException,
                  TikaException,
                  SAXException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

Parameters:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

IOException - if the document stream could not be read

TikaException - if the document could not be parsed

SAXException - if the SAX events could not be processed

isTracking

public boolean isTracking()

setTracking

public void setTracking(boolean tracking)

getTrackingMetadata

public Map<Integer,Metadata> getTrackingMetadata()