Module dev.metaschema.core

Package dev.metaschema.core.model.constraint

Class ConstraintValidationFinding

java.lang.Object

dev.metaschema.core.model.constraint.ConstraintValidationFinding

All Implemented Interfaces:

IValidationFinding

public class ConstraintValidationFinding
extends Object
implements IValidationFinding

Represents an individual constraint validation issue.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConstraintValidationFinding.Builder	Implements a builder pattern for creating constraint findings.

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

IValidationFinding.Kind

Method Summary

Modifier and Type	Method	Description
static ConstraintValidationFinding.Builder	builder(IConstraint constraint, INodeItem node)	Construct a new finding builder.
static ConstraintValidationFinding.Builder	builder(List<? extends IConstraint> constraints, INodeItem node)	Construct a new finding builder.
Throwable	getCause()	Get the exception associated with the finding.
List<? extends IConstraint>	getConstraints()	Get the constraints associated with the finding.
URI	getDocumentUri()	Get the document's URI.
String	getIdentifier()	Get the unique identifier for the finding.
IValidationFinding.Kind	getKind()	Get the finding type.
IResourceLocation	getLocation()	Get the location in the associated resource associated with the finding.
String	getMessage()	Get the finding message.
INodeItem	getNode()	Get the context node used to evaluate the constraints.
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.
List<? extends INodeItem>	getSubjects()	Get the subjects of the finding, which are resolved by evaluating the constraint target expression.
INodeItem	getTarget()	Get the target of the finding.

Methods inherited from class java.lang.Object

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

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

getConstraints

@NonNull
public List<? extends IConstraint> getConstraints()

Get the constraints associated with the finding.

Returns:

the constraints

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

getNode

@NonNull
public INodeItem getNode()

Get the context node used to evaluate the constraints.

Returns:

the context node

getTarget

@NonNull
public INodeItem getTarget()

Get the target of the finding.

Returns:

the target node

getSubjects

@NonNull
public List<? extends INodeItem> getSubjects()

Get the subjects of the finding, which are resolved by evaluating the constraint target expression.

Returns:

the subject nodes

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

getCause

public Throwable 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

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

builder

@NonNull
public static ConstraintValidationFinding.Builder builder(@NonNull
 List<? extends IConstraint> constraints,
 @NonNull
 INodeItem node)

Construct a new finding builder.

Parameters:

constraints - the constraints associated with this finding

node - the context node used to evaluate the constraints

Returns:

a new builder

builder

@NonNull
public static ConstraintValidationFinding.Builder builder(@NonNull
 IConstraint constraint,
 @NonNull
 INodeItem node)

Construct a new finding builder.

Parameters:

constraint - the constraint associated with this finding

node - the context node used to evaluate the constraints

Returns:

a new builder