org.apache.tika.parser.xml
Class XMLParser

java.lang.Object
  org.apache.tika.parser.xml.XMLParser

All Implemented Interfaces:

Parser

Direct Known Subclasses:

DcXMLParser

public class XMLParser
extends java.lang.Object
implements Parser

XML parser.

This class uses the following parsing context entries:

javax.xml.parsers.SAXParser

The SAX parser (SAXParser instance) to be used for parsing the XML input documents. Optional.

javax.xml.parsers.SAXParserFactory

The SAX parser factory (SAXParserFactory instance) used to create a SAX parser if one has not been explicitly specified. Optional.

Constructor Summary

XMLParser()

Method Summary

protected org.xml.sax.ContentHandler	getContentHandler(org.xml.sax.ContentHandler handler, Metadata metadata)
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata) Deprecated. This method will be removed in Apache Tika 1.0.
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context) Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLParser

public XMLParser()

Method Detail

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.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.

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:

java.io.IOException - if the document stream could not be read

org.xml.sax.SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

Deprecated. This method will be removed in Apache Tika 1.0.

Description copied from interface: Parser

The parse() method from Tika 0.4 and earlier. Please use the #parse(InputStream, ContentHandler, Metadata, Map) method instead in new code. Calls to this backwards compatibility method are forwarded to the new parse() method with an empty parse context.

Specified by:

parse in interface Parser

Throws:

java.io.IOException

org.xml.sax.SAXException

TikaException

getContentHandler

protected org.xml.sax.ContentHandler getContentHandler(org.xml.sax.ContentHandler handler,
                                                       Metadata metadata)