Module dev.metaschema.core

Package dev.metaschema.core.model.validation

Class XmlSchemaContentValidator.XmlValidationFinding

java.lang.Object

dev.metaschema.core.model.validation.XmlSchemaContentValidator.XmlValidationFinding

All Implemented Interfaces:

IResourceLocation, IValidationFinding

Enclosing class:

XmlSchemaContentValidator

public static class XmlSchemaContentValidator.XmlValidationFinding
extends Object
implements IValidationFinding, IResourceLocation

Records an identified individual validation result found during XML schema validation.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.metaschema.core.model.validation.IValidationFinding

IValidationFinding.Kind

Constructor Summary

Constructors

Constructor	Description
XmlValidationFinding(IConstraint.Level severity, SAXParseException exception, URI resourceUri)	Construct a new XML schema validation finding, which represents an issue identified during XML schema validation.

Method Summary

Modifier and Type	Method	Description
long	getByteOffset()	Get the zero-based byte offset for a location within a resource.
SAXParseException	getCause()	Get the exception associated with the finding.
long	getCharOffset()	Get the zero-based character offset for a location within a resource.
int	getColumn()	Get the line column for a location within a resource.
URI	getDocumentUri()	Get the document's URI.
String	getIdentifier()	Get the unique identifier for the finding.
IValidationFinding.Kind	getKind()	Get the finding type.
int	getLine()	Get the line for a location within a resource.
IResourceLocation	getLocation()	Get the location in the associated resource associated with the finding.
String	getMessage()	Get the finding message.
String	getPath()	A format specific path to the finding in the source document.
String	getPathKind()	Get the path expression type provided by the IValidationFinding.getPath() method.
IConstraint.Level	getSeverity()	Get the finding's severity.

Methods inherited from class java.lang.Object

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

Constructor Details

XmlValidationFinding

public XmlValidationFinding(@NonNull
 IConstraint.Level severity,
 @NonNull
 SAXParseException exception,
 @NonNull
 URI resourceUri)

Construct a new XML schema validation finding, which represents an issue identified during XML schema validation.

Parameters:

severity - the finding significance

exception - the XML schema validation exception generated during schema validation representing the issue

resourceUri - the resource the issue was found in

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: IValidationFinding

Get the unique identifier for the finding.

Specified by:

getIdentifier in interface IValidationFinding

Returns:

the identifier

getKind

public IValidationFinding.Kind getKind()

Description copied from interface: IValidationFinding

Get the finding type.

Specified by:

getKind in interface IValidationFinding

Returns:

the finding type

getSeverity

public IConstraint.Level getSeverity()

Description copied from interface: IValidationFinding

Get the finding's severity.

Specified by:

getSeverity in interface IValidationFinding

Returns:

the severity

getDocumentUri

public URI getDocumentUri()

Description copied from interface: IValidationFinding

Get the document's URI.

Specified by:

getDocumentUri in interface IValidationFinding

Returns:

the document's URI or null if it is not known

getLine

public int getLine()

Description copied from interface: IResourceLocation

Get the line for a location within a resource.

Specified by:

getLine in interface IResourceLocation

Returns:

the line number or -1 if unknown

getColumn

public int getColumn()

Description copied from interface: IResourceLocation

Get the line column for a location within a resource.

Specified by:

getColumn in interface IResourceLocation

Returns:

the column number or -1 if unknown

getCharOffset

public long getCharOffset()

Description copied from interface: IResourceLocation

Get the zero-based character offset for a location within a resource.

Specified by:

getCharOffset in interface IResourceLocation

Returns:

the character offset or -1 if unknown

getByteOffset

public long getByteOffset()

Description copied from interface: IResourceLocation

Get the zero-based byte offset for a location within a resource.

Specified by:

getByteOffset in interface IResourceLocation

Returns:

the byte offset or -1 if unknown

getLocation

public IResourceLocation getLocation()

Description copied from interface: IValidationFinding

Get the location in the associated resource associated with the finding.

Specified by:

getLocation in interface IValidationFinding

Returns:

the location or null if no location is known

getPathKind

public String getPathKind()

Description copied from interface: IValidationFinding

Get the path expression type provided by the IValidationFinding.getPath() method.

Specified by:

getPathKind in interface IValidationFinding

Returns:

the path type identifier or null if unknown

getPath

public String getPath()

Description copied from interface: IValidationFinding

A format specific path to the finding in the source document.

Specified by:

getPath in interface IValidationFinding

Returns:

the path or null if unknown

getMessage

public String getMessage()

Description copied from interface: IValidationFinding

Get the finding message.

Specified by:

getMessage in interface IValidationFinding

Returns:

the message or null if there is no message

getCause

@NonNull
public SAXParseException getCause()

Description copied from interface: IValidationFinding

Get the exception associated with the finding.

Specified by:

getCause in interface IValidationFinding

Returns:

the Throwable or null if no thowable is associated with the finding