org.opengis.cite.validation

Class ValidationError

java.lang.Object

org.opengis.cite.validation.ValidationError

public class ValidationError
extends Object

Provides information pertaining to a validation error. Instances of this class are immutable.

Constructor Summary

Constructors

Constructor and Description
ValidationError(ErrorSeverity severity, String message, int lineNum, int columnNum, String pointer) Constructs an immutable validation error object from SAX or DOM error information.
ValidationError(ErrorSeverity severity, String message, String diagnostics, ErrorLocator locator) Constructs an immutable validation error.
ValidationError(ErrorSeverity severity, String message, String diagnostics, int lineNum, int columnNum, String pointer) Constructs an immutable validation error object from SAX or DOM error information.

Method Summary

Modifier and Type	Method and Description
int	getColumnNumber() Returns the column number where the error is located.
String	getDiagnostics() Returns additional diagnostic information about this error.
int	getLineNumber() Returns the line number where the error is located.
String	getMessage() Returns the message describing this error.
String	getPointer() Returns a fragment identifier that identifies the invalid part of some resource representation.
ErrorSeverity	getSeverity() Returns the severity of this error.
String	toString() Returns information about the error.
String	toXml() Returns an XML representation of the validation error.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationError

public ValidationError(ErrorSeverity severity,
                       String message,
                       int lineNum,
                       int columnNum,
                       String pointer)

Constructs an immutable validation error object from SAX or DOM error information.

Parameters:

severity - The severity level (WARNING, ERROR, CRITICAL).

message - A brief description of the error.

lineNum - The line number where the error occurs (-1 if unknown).

columnNum - The column number where the error occurs (-1 if unknown).

pointer - A fragment identifier (pointer) that locates the error in the invalid representation.

ValidationError

public ValidationError(ErrorSeverity severity,
                       String message,
                       String diagnostics,
                       int lineNum,
                       int columnNum,
                       String pointer)

Constructs an immutable validation error object from SAX or DOM error information.

Parameters:

severity - The severity level (WARNING, ERROR, CRITICAL).

message - A brief description of the error.

diagnostics - Supplementary diagnostic information about the error.

lineNum - The line number where the error occurs (-1 if unknown).

columnNum - The column number where the error occurs (-1 if unknown).

pointer - A fragment identifier (pointer) that locates the error in the invalid representation.

ValidationError

public ValidationError(ErrorSeverity severity,
                       String message,
                       String diagnostics,
                       ErrorLocator locator)

Constructs an immutable validation error.

Parameters:

severity - The severity level (WARNING, ERROR, CRITICAL).

message - A brief description of the error.

diagnostics - Supplementary diagnostic information about the error.

locator - Provides information about the location of the error.

Method Detail

getMessage

public String getMessage()

Returns the message describing this error.

Returns:

the error description.

getDiagnostics

public String getDiagnostics()

Returns additional diagnostic information about this error.

Returns:

supplementary details about this error.

getSeverity

public ErrorSeverity getSeverity()

Returns the severity of this error.

Returns:

The severity value for this error.

getLineNumber

public int getLineNumber()

Returns the line number where the error is located.

Returns:

An integer value greater than zero, or -1 if no value is available;

getColumnNumber

public int getColumnNumber()

Returns the column number where the error is located.

Returns:

An integer value greater than zero, or -1 if no value is available.

getPointer

public String getPointer()

Returns a fragment identifier that identifies the invalid part of some resource representation. For XML-based representations, such pointers are based on the W3C XPointer framework.

Returns:

A String that conforms to the applicable pointer syntax.

toXml

public String toXml()

Returns an XML representation of the validation error. The structure is as shown in the example below:

   <error>
     <severity>ERROR</severity>
     <message>Error details</message>
     <diagnosticInfo>Error details</diagnosticInfo>
     <location>
       <lineNumber>5</lineNumber>
       <columnNumber>4</columnNumber>
       <pointer>xmlns(tns=http://www.example.org)xpointer(//tns:foo[1])
     </pointer>
     </location>
   </error>
 

Returns:

A string containing XML elements in no namespace.

toString

public String toString()

Returns information about the error.

Overrides:

toString in class Object

Returns:

A string containing error details.