Package org.apache.tika.parser.mp3

Class Mp3Parser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.parser.mp3.Mp3Parser

All Implemented Interfaces:

Serializable, Parser

public class Mp3Parser
extends AbstractParser

The Mp3Parser is used to parse ID3 Version 1 Tag information from an MP3 file, if available.

See Also:

MP3 ID3 Version 1 specification, MP3 ID3 Version 2.4 Structure Specification, MP3 ID3 Version 2.4 Frames Specification, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Mp3Parser.ID3TagsAndAudio

Constructor Summary

Constructors

Constructor	Description
Mp3Parser()

Method Summary

Modifier and Type	Method	Description
protected static Mp3Parser.ID3TagsAndAudio	getAllTagHandlers(InputStream stream, ContentHandler handler)	Scans the MP3 frames for ID3 tags, and creates ID3Tag Handlers for each supported set of tags.
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

Mp3Parser

public Mp3Parser()

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.

Parameters:

context - parse context

Returns:

immutable set of media types

parse

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

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.

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

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

getAllTagHandlers

protected static Mp3Parser.ID3TagsAndAudio getAllTagHandlers(InputStream stream,
                                                             ContentHandler handler)
                                                      throws IOException,
                                                             SAXException,
                                                             TikaException

Scans the MP3 frames for ID3 tags, and creates ID3Tag Handlers for each supported set of tags.

Throws:

IOException

SAXException

TikaException