org.yawlfoundation.yawl.schema
Class ErrorHandler

java.lang.Object
  extended by org.yawlfoundation.yawl.schema.ErrorHandler
All Implemented Interfaces:
ErrorHandler

public class ErrorHandler
extends Object
implements ErrorHandler

This class implements the SAX ErrorHandler interface allowing customised handling of all validation errors in an XML document. This handler only terminates at the end of the document or a fatal error. All other errors are recorded for future retrieval to allow complete parsing of the XML document.

Author:
Mike Fowler Date: 04-Jul-2006

Constructor Summary
ErrorHandler()
           
 
Method Summary
 void error(SAXParseException e)
          Receive notification of a recoverable error.
 void fatalError(SAXParseException e)
          Receive notification of a non-recoverable error.
 Vector<String> getErrors()
           
 Vector<String> getWarnings()
           
 boolean isValid()
           
 void reset()
          Clear the error handler from any previous run
 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
 

Constructor Detail

ErrorHandler

public ErrorHandler()
Method Detail

reset

public void reset()
Clear the error handler from any previous run


getWarnings

public Vector<String> getWarnings()
Returns:
String list of all warnings contained in the parsed document.

getErrors

public Vector<String> getErrors()
Returns:
String list of all errors contained in the parsed document.

isValid

public boolean isValid()
Returns:
true if there were no errors, false otherwise

warning

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

error

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

fatalError

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


Copyright © 2004-2012 The YAWL Foundation.