org.mdiutil.xml.tree

Class XMLTreeHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.xml.sax.ext.DefaultHandler2

org.mdiutil.xml.ResolverSAXHandler

org.mdiutil.xml.tree.XMLTreeHandler

All Implemented Interfaces:

InputSourceCaching, LSResourceResolver, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

public class XMLTreeHandler
extends ResolverSAXHandler

Parse an XML File and return the associated tree of Nodes.

Nested Class Summary

Nested classes/interfaces inherited from class org.mdiutil.xml.ResolverSAXHandler

ResolverSAXHandler.ExceptionResult, ResolverSAXHandler.InformationResult, ResolverSAXHandler.SourceWrapper

Field Summary

Fields inherited from class org.mdiutil.xml.ResolverSAXHandler

CACHE_DEFAULT, dtd, ERRORS, FATAL, INFO, locator, NO_ERRORS, publicDTD, resolver, results, status, WARNINGS

Fields inherited from interface org.mdiutil.xml.InputSourceCaching

CACHING_DEFAULT, CACHING_SOURCES, NOT_CACHING_SOURCES

Constructor Summary

Constructors

Constructor and Description
XMLTreeHandler() Constructor.
XMLTreeHandler(boolean asRoot) Constructor.
XMLTreeHandler(String encoding) Constructor.
XMLTreeHandler(String encoding, boolean asRoot) Constructor.
XMLTreeHandler(String encoding, boolean asRoot, String comment) Constructor.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] chararacters, int start, int length)
protected XMLNode	createNodeImpl(QName qname, Attributes attr) Create a node.
void	endElement(String uri, String localname, String qname)
void	endPrefixMapping(String prefix)
protected void	errorImpl(SAXParseException e) Do nothing by default.
protected void	fatalErrorImpl(SAXParseException e) Do nothing.
protected XMLNode	getCurrentNode() Return the current node.
ErrorHandler	getErrorHandler() Return the error handler wich will be fired for parsing errors detected by the parser. null by default.
XMLRoot	getRoot() Return the root node, as a XMLRoot.
XMLNode	getRootNode() Return the root node.
boolean	isKeepingLineNumbers() Return true if line numbers in the XML File are kept.
boolean	isPreservingSpace() Return true if space characters must be preserved.
void	preserveSpace(boolean preserveSpace) Set if space characters must be preserved.
void	setErrorHandler(ErrorHandler errorHandler) Set an error handler wich will be fired for parsing errors detected by the parser.
void	setKeepLineNumbers(boolean keepLineNumbers) Set if line numbers in the XML File are kept.
void	startElement(String uri, String localname, String qname, Attributes attr) Receive notification of the beginning of an element.
void	startPrefixMapping(String prefix, String uri)
protected void	warningImpl(SAXParseException e) Do nothing.

Methods inherited from class org.mdiutil.xml.ResolverSAXHandler

endDocument, endDTD, error, error, fatalError, fatalError, getDocumentLocator, getDTD, getEntityResolver, getExceptionResults, getExceptions, getExceptionsResultsByLine, getExternalSubset, getFirstException, getInputSourceCaching, getStatus, hasErrors, hasParserExceptions, hasStartedElements, info, info, isDocumentStarted, isElementStarted, reset, resolveEntity, resolveEntity, resolveResource, restart, setDocumentLocator, setDTD, setEntityResolver, setInputSourceCaching, setStatus, startDocument, warning, warning

Methods inherited from class org.xml.sax.ext.DefaultHandler2

attributeDecl, comment, elementDecl, endCDATA, endEntity, externalEntityDecl, internalEntityDecl, startCDATA, startDTD, startEntity

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

ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTreeHandler

public XMLTreeHandler()

Constructor.

XMLTreeHandler

public XMLTreeHandler(boolean asRoot)

Constructor.

Parameters:

asRoot - true if the root node must be a XMLRoot.

XMLTreeHandler

public XMLTreeHandler(String encoding)

Constructor.

Parameters:

encoding - the encoding of the XML file

XMLTreeHandler

public XMLTreeHandler(String encoding,
                      boolean asRoot)

Constructor.

Parameters:

encoding - the encoding of the XML file

asRoot - true if the root node must be a XMLRoot.

XMLTreeHandler

public XMLTreeHandler(String encoding,
                      boolean asRoot,
                      String comment)

Constructor.

Parameters:

encoding - the encoding of the XML file

asRoot - true if the root node must be a XMLRoot.

comment - the comment to add for the root node

Method Detail

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set an error handler wich will be fired for parsing errors detected by the parser.

Parameters:

errorHandler - the error handler

getErrorHandler

public ErrorHandler getErrorHandler()

Return the error handler wich will be fired for parsing errors detected by the parser. null by default.

Returns:

the error handler

preserveSpace

public void preserveSpace(boolean preserveSpace)

Set if space characters must be preserved.

Parameters:

preserveSpace - true if space characters must be preserved

isPreservingSpace

public boolean isPreservingSpace()

Return true if space characters must be preserved.

Returns:

true if space characters must be preserved

setKeepLineNumbers

public void setKeepLineNumbers(boolean keepLineNumbers)

Set if line numbers in the XML File are kept.

Parameters:

keepLineNumbers - true if line numbers in the XML File are kept

isKeepingLineNumbers

public boolean isKeepingLineNumbers()

Return true if line numbers in the XML File are kept.

Returns:

true if line numbers in the XML File are kept

getRootNode

public XMLNode getRootNode()

Return the root node.

Returns:

the root node

getRoot

public XMLRoot getRoot()

Return the root node, as a XMLRoot.

Returns:

the root node

startElement

public void startElement(String uri,
                         String localname,
                         String qname,
                         Attributes attr)
                  throws SAXException

Receive notification of the beginning of an element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class ResolverSAXHandler

Parameters:

uri - the Namespace URI

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

attr - the specified or defaulted attributes

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localname,
                       String qname)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

characters

public void characters(char[] chararacters,
                       int start,
                       int length)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

getCurrentNode

protected XMLNode getCurrentNode()

Return the current node.

Returns:

the node

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

endPrefixMapping

public void endPrefixMapping(String prefix)

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

createNodeImpl

protected XMLNode createNodeImpl(QName qname,
                                 Attributes attr)

Create a node.

Parameters:

qname - the qualified name of the node

attr - the node attributes

Returns:

the node

fatalErrorImpl

protected void fatalErrorImpl(SAXParseException e)

Do nothing. This will only effectively be called if a fatal error has been acknowledged in ResolverSAXHandler.fatalError(org.xml.sax.SAXParseException).

Overrides:

fatalErrorImpl in class ResolverSAXHandler

Parameters:

e - the SAXParseException

errorImpl

protected void errorImpl(SAXParseException e)

Do nothing by default. This will only effectively be called if an error has been acknowledged in ResolverSAXHandler.error(org.xml.sax.SAXParseException).

Overrides:

errorImpl in class ResolverSAXHandler

Parameters:

e - the SAXParseException

warningImpl

protected void warningImpl(SAXParseException e)

Do nothing. This will only effectively be called if a warning has been acknowledged in ResolverSAXHandler.warning(org.xml.sax.SAXParseException).

Overrides:

warningImpl in class ResolverSAXHandler

Parameters:

e - the SAXParseException