sirius.kernel.xml

Class XMLReader

java.lang.Object

org.xml.sax.helpers.DefaultHandler

sirius.kernel.xml.XMLReader

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XMLReader
extends DefaultHandler

A combination of DOM and SAX parser which permits to parse very large XML files while conveniently handling sub tree using a DOM and xpath api.

Used SAX to parse a given XML file. A set of NodeHandler objects can be given, which get notified if a sub-tree below a given tag was parsed. This sub-tree is available as DOM and can conveniently be processed using xpath.

Constructor Summary

Constructors

Constructor and Description
XMLReader() Creates a new XMLReader.

Method Summary

Modifier and Type	Method and Description
void	addHandler(String name, NodeHandler handler) Registers a new handler for a qualified name of a node.
void	characters(char[] ch, int start, int length)
InputSource	emptyResource()
void	endDocument()
void	endElement(String uri, String localName, String name)
void	parse(InputStream stream) Parses the given stream.
void	parse(InputStream stream, Function<String,InputStream> resourceLocator) Parses the given stream using the given locator and interrupt signal.
void	processingInstruction(String target, String data)
void	startElement(String uri, String localName, String name, Attributes attributes)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLReader

public XMLReader()

Creates a new XMLReader.

Use addHandler(String, NodeHandler) tobind handlers to tags and then call one of the parse methods to process the XML file.

To interrupt processing use TaskContext.cancel().

Method Detail

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String localName,
                         String name,
                         Attributes attributes)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

addHandler

public void addHandler(String name,
                       NodeHandler handler)

Registers a new handler for a qualified name of a node.

Handlers are invoked after the complete node was read. Namespaces are ignored for now which eases the processing a lot (especially for xpath related tasks). Namespaces however could be easily added by replacing String with QName here.

Parameters:

name - the qualified name of the tag which should be parsed and processed

handler - the NodeHandler used to process the parsed DOM sub-tree

parse

public void parse(InputStream stream)
           throws IOException

Parses the given stream.

Parameters:

stream - the stream to parse

Throws:

IOException - if parsing the XML fails either due to an IO error or due to an SAXException (when processing a malformed XML).

parse

public void parse(InputStream stream,
                  Function<String,InputStream> resourceLocator)
           throws IOException

Parses the given stream using the given locator and interrupt signal.

Parameters:

stream - the stream containing the XML data

resourceLocator - the resource locator used to discover dependent resources

Throws:

IOException - if parsing the XML fails either due to an IO error or due to an SAXException (when processing a malformed XML).

emptyResource

public InputSource emptyResource()