org.pentaho.reporting.libraries.xmlns.parser
Class LoggingErrorHandler

java.lang.Object
  extended by org.pentaho.reporting.libraries.xmlns.parser.LoggingErrorHandler
All Implemented Interfaces:
org.xml.sax.ErrorHandler

public class LoggingErrorHandler
extends java.lang.Object
implements org.xml.sax.ErrorHandler

A SAX-Error handler that logs all incomming errors to the given log context.

Author:
Thomas Morgner

Constructor Summary
LoggingErrorHandler()
          Default-Constructor.
LoggingErrorHandler(org.apache.commons.logging.Log logContext)
          Creates a new LoggingErrorHandler with the given (non-null) logcontext as log-target.
 
Method Summary
 void error(org.xml.sax.SAXParseException exception)
          Receive notification of a recoverable error.
 void fatalError(org.xml.sax.SAXParseException exception)
          Receive notification of a non-recoverable error.
 void warning(org.xml.sax.SAXParseException exception)
          Receive notification of a warning.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LoggingErrorHandler

public LoggingErrorHandler()
Default-Constructor. Logs to a logger configured with this class name as category.


LoggingErrorHandler

public LoggingErrorHandler(org.apache.commons.logging.Log logContext)
Creates a new LoggingErrorHandler with the given (non-null) logcontext as log-target.

Parameters:
logContext - the logger that should receive the messages.
Method Detail

warning

public void warning(org.xml.sax.SAXParseException exception)
             throws org.xml.sax.SAXException
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 org.xml.sax.ErrorHandler
Parameters:
exception - The warning information encapsulated in a SAX parse exception.
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
SAXParseException

error

public void error(org.xml.sax.SAXParseException exception)
           throws org.xml.sax.SAXException
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 org.xml.sax.ErrorHandler
Parameters:
exception - The error information encapsulated in a SAX parse exception.
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
SAXParseException

fatalError

public void fatalError(org.xml.sax.SAXParseException exception)
                throws org.xml.sax.SAXException
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 org.xml.sax.ErrorHandler
Parameters:
exception - The error information encapsulated in a SAX parse exception.
Throws:
org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
See Also:
SAXParseException