org.opengis.cite.validation

Class ValidationErrorHandler

java.lang.Object

org.opengis.cite.validation.ValidationErrorHandler

All Implemented Interfaces:

Iterable<ValidationError>, DOMErrorHandler, ErrorHandler

public class ValidationErrorHandler
extends Object
implements ErrorHandler, DOMErrorHandler, Iterable<ValidationError>

A SAX and DOM error handler that collects validation errors raised while verifying the structure and content of XML entities.

Constructor Summary

Constructors

Constructor and Description
ValidationErrorHandler()

Method Summary

Modifier and Type	Method and Description
void	addError(ErrorSeverity severity, String msg, ErrorLocator locator) Adds a general validation error.
void	addError(ErrorSeverity severity, String msg, String diag, ErrorLocator locator) Adds a general validation error with diagnostic information.
void	addErrors(Collection<ValidationError> errors) Adds the given collection of validation errors to this handler.
void	error(SAXParseException spex) Receives notification of a recoverable error.
boolean	errorsDetected() Indicates whether any validation errors have been detected.
void	fatalError(SAXParseException spex) Receives notification of a non-recoverable error, such as non-XML content, XML that is not well-formed, or an incorrect encoding declaration.
int	getErrorCount() Reports the number of errors detected during a validation episode.
List<ValidationError>	getErrors() Gets the errors reported to this handler.
String	getSchemaLanguage()
boolean	handleError(DOMError error)
Iterator<ValidationError>	iterator() Returns an iterator over the validation errors collected by this handler.
void	reset() Clears all errors and messages.
void	setSchemaLanguage(String schemaLanguage)
String	toString() Returns a concatenation of the summaries of all received errors.
String	toXml() Returns a simple XML representation of all received errors.
void	warning(SAXParseException spex) Receives notification of a warning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ValidationErrorHandler

public ValidationErrorHandler()

Method Detail

errorsDetected

public boolean errorsDetected()

Indicates whether any validation errors have been detected.

Returns:

true if validation errors were detected; false otherwise.

getErrorCount

public int getErrorCount()

Reports the number of errors detected during a validation episode.

Returns:

the number of errors.

warning

public void warning(SAXParseException spex)

Receives notification of a warning.

Specified by:

warning in interface ErrorHandler

Parameters:

spex - a non-error condition reported by the parser

See Also:

ErrorHandler.warning(org.xml.sax.SAXParseException)

error

public void error(SAXParseException spex)

Receives notification of a recoverable error. Typically this indicates that a validation constraint has been violated.

Specified by:

error in interface ErrorHandler

Parameters:

spex - a non-fatal error condition reported by the parser

See Also:

ErrorHandler.error(org.xml.sax.SAXParseException)

fatalError

public void fatalError(SAXParseException spex)

Receives notification of a non-recoverable error, such as non-XML content, XML that is not well-formed, or an incorrect encoding declaration.

Specified by:

fatalError in interface ErrorHandler

Parameters:

spex - A fatal error condition reported by the parser.

See Also:

ErrorHandler.fatalError(org.xml.sax.SAXParseException), XML 1.0 (Fourth Edition)

handleError

public boolean handleError(DOMError error)

Specified by:

handleError in interface DOMErrorHandler

addError

public void addError(ErrorSeverity severity,
                     String msg,
                     ErrorLocator locator)

Adds a general validation error.

Parameters:

severity - The severity of the error.

msg - The error message.

locator - An ErrorLocator instance that provides information regarding the location of the error.

addError

public void addError(ErrorSeverity severity,
                     String msg,
                     String diag,
                     ErrorLocator locator)

Adds a general validation error with diagnostic information.

Parameters:

severity - The severity of the error.

msg - The error message.

diag - Supplementary diagnostic information about the error.

locator - An ErrorLocator instance that provides information regarding the location of the error.

addErrors

public void addErrors(Collection<ValidationError> errors)

Adds the given collection of validation errors to this handler.

Parameters:

errors - A collection of ValidationError objects, each of which encapsulates information about some constraint violation (which are not necessarily related).

getErrors

public List<ValidationError> getErrors()

Gets the errors reported to this handler.

Returns:

A list containing error descriptions.

toString

public String toString()

Returns a concatenation of the summaries of all received errors.

Overrides:

toString in class Object

Returns:

A consolidated error message.

toXml

public String toXml()

Returns a simple XML representation of all received errors. The structure is shown below:

   <errors xmlns='http://www.galdosinc.com/arbitron'>
     <error /> 1..*
   </errors>
 

Returns:

A String containing an XML summary (in no namespace) of all error descriptions.

iterator

public Iterator<ValidationError> iterator()

Returns an iterator over the validation errors collected by this handler.

Specified by:

iterator in interface Iterable<ValidationError>

Returns:

a read-only error Iterator for this handler.

reset

public void reset()

Clears all errors and messages.

getSchemaLanguage

public String getSchemaLanguage()

setSchemaLanguage

public void setSchemaLanguage(String schemaLanguage)