Top Description Fields Constructors Methods
org.dom4j.util

public Class XMLErrorHandler

extends Object
implements ErrorHandler
Class Inheritance
All Implemented Interfaces
org.xml.sax.ErrorHandler
Imports
org.dom4j.DocumentHelper, .Element, .QName, org.xml.sax.ErrorHandler, .SAXParseException

XMLErrorHandler is a SAX ErrorHandlerwhich 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.
Author
James Strachan
Version
$Revision: 1.7 $

Field Summary

Modifier and TypeField and Description
protected static final QName
private QName
errorQName

QName used for error elements

private Element
errors

Stores the errors that occur during a SAX parse

protected static final QName
private QName
fatalErrorQName

QName used for fatalerror elements

protected static final QName
private QName
warningQName

QName used for warning elements

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
protected void
addException(Element
DOCUMENT ME!
element
,
SAXParseException
DOCUMENT ME!
e
)

Adds the given parse exception information to the given element instance

public void
error(SAXParseException
The error information encapsulated in a SAX parse exception.
e
)

Implements org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.
public void
fatalError(SAXParseException
The error information encapsulated in a SAXParseException.
e
)

Implements org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.
public QName
public Element
public QName
public QName
public void
setErrorQName(QName errorQName)

public void
public void
setFatalErrorQName(QName fatalErrorQName)

public void
setWarningQName(QName warningQName)

public void
warning(SAXParseException
The warning information encapsulated in a SAX parse exception.
e
)

Implements org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ERROR_QNAMEback to summary
protected static final QName ERROR_QNAME
errorQNameback to summary
private QName errorQName

QName used for error elements

errorsback to summary
private Element errors

Stores the errors that occur during a SAX parse

FATALERROR_QNAMEback to summary
protected static final QName FATALERROR_QNAME
fatalErrorQNameback to summary
private QName fatalErrorQName

QName used for fatalerror elements

WARNING_QNAMEback to summary
protected static final QName WARNING_QNAME
warningQNameback to summary
private QName warningQName

QName used for warning elements

Constructor Detail

XMLErrorHandlerback to summary
public XMLErrorHandler()
XMLErrorHandlerback to summary
public XMLErrorHandler(Element errors)

Method Detail

addExceptionback to summary
protected void addException(Element element, SAXParseException e)

Adds the given parse exception information to the given element instance

Parameters
element:Element

DOCUMENT ME!

e:SAXParseException

DOCUMENT ME!

errorback to summary
public void error(SAXParseException e)

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.ErrorHandler.error.

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.

Parameters
e:SAXParseException

The error information encapsulated in a SAX parse exception.

fatalErrorback to summary
public void fatalError(SAXParseException e)

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Parameters
e:SAXParseException

The error information encapsulated in a SAXParseException.

getErrorQNameback to summary
public QName getErrorQName()
getErrorsback to summary
public Element getErrors()
getFatalErrorQNameback to summary
public QName getFatalErrorQName()
getWarningQNameback to summary
public QName getWarningQName()
setErrorQNameback to summary
public void setErrorQName(QName errorQName)
setErrorsback to summary
public void setErrors(Element errors)
setFatalErrorQNameback to summary
public void setFatalErrorQName(QName fatalErrorQName)
setWarningQNameback to summary
public void setWarningQName(QName warningQName)
warningback to summary
public void warning(SAXParseException e)

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.ErrorHandler.warning.

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.

Parameters
e:SAXParseException

The warning information encapsulated in a SAX parse exception.