org.dom4j.util
Class XMLErrorHandler

java.lang.Object
  extended byorg.dom4j.util.XMLErrorHandler
All Implemented Interfaces:
ErrorHandler

public class XMLErrorHandler
extends java.lang.Object
implements ErrorHandler

XMLErrorHandler is a SAX ErrorHandler which turns the SAX parsing errors into XML so that the output can be formatted using XSLT or the errors can be included in a SOAP message.

Version:
$Revision: 1.5 $
Author:
James Strachan

Field Summary
protected static QName ERROR_QNAME
           
protected static QName FATALERROR_QNAME
           
protected static QName WARNING_QNAME
           
 
Constructor Summary
XMLErrorHandler()
           
XMLErrorHandler(Element errors)
           
 
Method Summary
protected  void addException(Element element, SAXParseException e)
          Adds the given parse exception information to the given element instance
 void error(SAXParseException e)
          Receive notification of a recoverable error.
 void fatalError(SAXParseException e)
          Receive notification of a non-recoverable error.
 QName getErrorQName()
           
 Element getErrors()
           
 QName getFatalErrorQName()
           
 QName getWarningQName()
           
 void setErrorQName(QName errorQName)
           
 void setErrors(Element errors)
           
 void setFatalErrorQName(QName fatalErrorQName)
           
 void setWarningQName(QName warningQName)
           
 void warning(SAXParseException e)
          Receive notification of a warning.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ERROR_QNAME

protected static final QName ERROR_QNAME

FATALERROR_QNAME

protected static final QName FATALERROR_QNAME

WARNING_QNAME

protected static final QName WARNING_QNAME
Constructor Detail

XMLErrorHandler

public XMLErrorHandler()

XMLErrorHandler

public XMLErrorHandler(Element errors)
Method Detail

error

public void error(SAXParseException e)
Description copied from interface: ErrorHandler
Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Specified by:
error in interface ErrorHandler
Parameters:
e - The error information encapsulated in a SAX parse exception.
See Also:
SAXParseException

fatalError

public void fatalError(SAXParseException e)
Description copied from interface: ErrorHandler
Receive notification of a non-recoverable error.

There is an apparent contradiction between the documentation for this method and the documentation for ContentHandler.endDocument(). Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether endDocument() will or will not be invoked when the parser has reported a fatalError() or thrown an exception.

This corresponds to the definition of "fatal error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a parser would use this callback to report the violation of a well-formedness constraint.

The application must assume that the document is unusable after the parser has invoked this method, and should continue (if at all) only for the sake of collecting additional error messages: in fact, SAX parsers are free to stop reporting any other events once this method has been invoked.

Specified by:
fatalError in interface ErrorHandler
Parameters:
e - The error information encapsulated in a SAX parse exception.
See Also:
SAXParseException

warning

public void warning(SAXParseException e)
Description copied from interface: ErrorHandler
Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Specified by:
warning in interface ErrorHandler
Parameters:
e - The warning information encapsulated in a SAX parse exception.
See Also:
SAXParseException

getErrors

public Element getErrors()

setErrors

public void setErrors(Element errors)

getErrorQName

public QName getErrorQName()

setErrorQName

public void setErrorQName(QName errorQName)

getFatalErrorQName

public QName getFatalErrorQName()

setFatalErrorQName

public void setFatalErrorQName(QName fatalErrorQName)

getWarningQName

public QName getWarningQName()

setWarningQName

public void setWarningQName(QName warningQName)

addException

protected void addException(Element element,
                            SAXParseException e)
Adds the given parse exception information to the given element instance



Copyright © 2004 MetaStuff Ltd. All Rights Reserved. Hosted by

SourceForge Logo