com.compomics.util.pride.validation

Class XMLValidationErrorHandler

java.lang.Object

com.compomics.util.pride.validation.XMLValidationErrorHandler

All Implemented Interfaces:

ErrorHandler

public class XMLValidationErrorHandler
extends Object
implements ErrorHandler

Edited using IntelliJ IDEA Date: 16-Sep-2005 Time: 15:26:12

Author:

Phil Jones

Constructor Summary

Constructors

Constructor and Description
XMLValidationErrorHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
void	error(SAXParseException exception) Receive notification of a recoverable error.
void	fatalError(IOException exception) This is a extension method to the #fatalError(SAXParseException) method to allow the handling of IOExceptions.
void	fatalError(SAXParseException exception) Receive notification of a non-recoverable error.
List<String>	getErrorsAsList() Returns the errors as a list.
String	getErrorsFormattedAsHTML() Returns the errors formatted as HTML.
String	getErrorsFormattedAsPlainText() Returns the errors formatted as plain text.
boolean	noErrors() Returns true of there were no errors.
void	warning(SAXParseException exception) 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

XMLValidationErrorHandler

public XMLValidationErrorHandler()

Constructor.

Method Detail

noErrors

public boolean noErrors()

Returns true of there were no errors.

Returns:

true of there were no errors

getErrorsFormattedAsPlainText

public String getErrorsFormattedAsPlainText()

Returns the errors formatted as plain text.

Returns:

the errors formatted as plain text

getErrorsFormattedAsHTML

public String getErrorsFormattedAsHTML()

Returns the errors formatted as HTML.

Returns:

the errors formatted as HTML

getErrorsAsList

public List<String> getErrorsAsList()

Returns the errors as a list.

Returns:

the errors as a list

error

public void error(SAXParseException exception)
           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 behavior 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 1.0 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:

exception - 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 exception)
                throws SAXException

Receive notification of a non-recoverable error.

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 addition 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:

exception - 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(IOException exception)

This is a extension method to the #fatalError(SAXParseException) method to allow the handling of IOExceptions. Example: An FileNotFoundException is thrown by the validate method if the file to be validated contains a local reference to a DTD (which can not be found on the server).

Parameters:

exception - the IOException

warning

public void warning(SAXParseException exception)
             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 1.0 recommendation. The default behavior 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:

exception - The warning information encapsulated in a SAX parse exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

SAXParseException