com.tridion.util.xml

Class XMLParser

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.tridion.util.xml.XMLParser

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XMLParser
extends DefaultHandler

Handles the parsing of XML files and data, also acts as an event handler for SAX2 in order to build up a custom document model.

Constructor Summary

Constructors

Constructor and Description
XMLParser() Creates a new instance of XMLParser.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] chars, int start, int length) Handle character data.
void	endElement(String namespaceURI, String localName, String qName) Handle the end of an element.
XMLParseResult	parse(File xmlFile) Parses the passed XML file.
XMLParseResult	parse(InputSource source) Parses the passed XML input source.
XMLParseResult	parse(String xml) Parses the passed XML string.
void	startElement(String namespaceURI, String localName, String qName, Attributes attrs) Handle the start of an element.

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

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, 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

XMLParser

public XMLParser()

Creates a new instance of XMLParser.

Method Detail

parse

public XMLParseResult parse(String xml)
                     throws IOException,
                            SAXException

Parses the passed XML string.

Parameters:

xml - XML string to parse.

Returns:

An XMLParseResult representing the XML data.

Throws:

IOException - If something goes wrong reading the XML input data.

SAXException - If something goes wrong creating a parser or parsing the XML.

parse

public XMLParseResult parse(File xmlFile)
                     throws IOException,
                            SAXException

Parses the passed XML file. Assumes UTF-8 encoding.

Parameters:

xmlFile - XML file to parse.

Returns:

An XMLParseResult representing the XML data.

Throws:

IOException - If something goes wrong reading the XML input data.

SAXException - If something goes wrong creating a parser or parsing the XML.

parse

public XMLParseResult parse(InputSource source)
                     throws IOException,
                            SAXException

Parses the passed XML input source.

Parameters:

source - XML input source to parse.

Returns:

An XMLParseResult representing the XML data.

Throws:

IOException - If something goes wrong reading the XML input data.

SAXException - If something goes wrong creating a parser or parsing the XML.

startElement

public void startElement(String namespaceURI,
                         String localName,
                         String qName,
                         Attributes attrs)
                  throws SAXException

Handle the start of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

attrs - The attributes attached to the element. If there are no attributes, this will be empty.

Throws:

SAXException - If something goes wrong processing the start of an element.

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String qName)
                throws SAXException

Handle the end of an element.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

namespaceURI - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed.

localName - The local name (without prefix), or the empty string if Namespace processing is not being performed.

qName - The qualified name (with prefix), or the empty string if qualified names are not available.

Throws:

SAXException - If something goes wrong processing the end of an element.

characters

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

Handle character data.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

chars - The characters from the XML document.

start - The start position in the array.

length - The number of characters to read from the array.

Throws:

SAXException - If something goes wrong processing the characters.