org.topbraid.shacl.validation

Class ValidationEngine

java.lang.Object

org.topbraid.shacl.validation.ValidationEngine

All Implemented Interfaces:

NodeExpressionContext

public class ValidationEngine
extends Object
implements NodeExpressionContext

A ValidationEngine uses a given shapes graph (represented via an instance of VShapesGraph) and performs SHACL validation on a given Dataset. Instances of this class should be created via the ValidatorFactory.

Author:

Holger Knublauch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValidationEngine(org.apache.jena.query.Dataset dataset, URI shapesGraphURI, ShapesGraph shapesGraph, org.apache.jena.rdf.model.Resource report) Constructs a new ValidationEngine.

Method Summary

Modifier and Type	Method and Description
void	addResultMessage(org.apache.jena.rdf.model.Resource result, org.apache.jena.rdf.model.Literal message, org.apache.jena.query.QuerySolution bindings)
void	applyEntailments() Ensures that the data graph includes any entailed triples inferred by the regime specified using sh:entailment in the shapes graph.
org.apache.jena.rdf.model.Resource	createResult(org.apache.jena.rdf.model.Resource type, Constraint constraint, org.apache.jena.rdf.model.RDFNode focusNode)
org.apache.jena.query.Dataset	getDataset()
Function<org.apache.jena.rdf.model.RDFNode,String>	getLabelFunction()
ProgressMonitor	getProgressMonitor()
org.apache.jena.rdf.model.Resource	getReport() Gets the validation report as a Resource in the report Model.
ShapesGraph	getShapesGraph()
URI	getShapesGraphURI()
List<org.apache.jena.rdf.model.RDFNode>	getValueNodes(Constraint constraint, org.apache.jena.rdf.model.RDFNode focusNode)
void	setFocusNodeFilter(Predicate<org.apache.jena.rdf.model.RDFNode> value) Sets a filter that can be used to skip certain focus node from validation.
void	setLabelFunction(Function<org.apache.jena.rdf.model.RDFNode,String> value)
void	setProgressMonitor(ProgressMonitor value)
void	updateConforms()
org.apache.jena.rdf.model.Resource	validateAll() Validates all target nodes against all of their shapes.
org.apache.jena.rdf.model.Resource	validateNode(org.apache.jena.graph.Node focusNode) Validates a given focus node against all of the shapes that have matching targets.
org.apache.jena.rdf.model.Resource	validateNodesAgainstShape(List<org.apache.jena.rdf.model.RDFNode> focusNodes, org.apache.jena.graph.Node shape) Validates a given list of focus node against a given Shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationEngine

protected ValidationEngine(org.apache.jena.query.Dataset dataset,
                           URI shapesGraphURI,
                           ShapesGraph shapesGraph,
                           org.apache.jena.rdf.model.Resource report)

Constructs a new ValidationEngine.

Parameters:

dataset - the Dataset to operate on

shapesGraphURI - the URI of the shapes graph (must be in the dataset)

shapesGraph - the ShapesGraph with the shapes to validate against

report - the sh:ValidationReport object in the results Model, or null to create a new one

Method Detail

applyEntailments

public void applyEntailments()
                      throws InterruptedException

Ensures that the data graph includes any entailed triples inferred by the regime specified using sh:entailment in the shapes graph. Should be called prior to validation. Throws an Exception if unsupported entailments are found. If multiple sh:entailments are present then their order is undefined but they all get applied.

Throws:

InterruptedException

getDataset

public org.apache.jena.query.Dataset getDataset()

Specified by:

getDataset in interface NodeExpressionContext

getLabelFunction

public Function<org.apache.jena.rdf.model.RDFNode,String> getLabelFunction()

setLabelFunction

public void setLabelFunction(Function<org.apache.jena.rdf.model.RDFNode,String> value)

getProgressMonitor

public ProgressMonitor getProgressMonitor()

setProgressMonitor

public void setProgressMonitor(ProgressMonitor value)

addResultMessage

public void addResultMessage(org.apache.jena.rdf.model.Resource result,
                             org.apache.jena.rdf.model.Literal message,
                             org.apache.jena.query.QuerySolution bindings)

createResult

public org.apache.jena.rdf.model.Resource createResult(org.apache.jena.rdf.model.Resource type,
                                                       Constraint constraint,
                                                       org.apache.jena.rdf.model.RDFNode focusNode)

getShapesGraph

public ShapesGraph getShapesGraph()

Specified by:

getShapesGraph in interface NodeExpressionContext

getShapesGraphURI

public URI getShapesGraphURI()

Specified by:

getShapesGraphURI in interface NodeExpressionContext

getReport

public org.apache.jena.rdf.model.Resource getReport()

Gets the validation report as a Resource in the report Model.

Returns:

the report Resource

getValueNodes

public List<org.apache.jena.rdf.model.RDFNode> getValueNodes(Constraint constraint,
                                                             org.apache.jena.rdf.model.RDFNode focusNode)

setFocusNodeFilter

public void setFocusNodeFilter(Predicate<org.apache.jena.rdf.model.RDFNode> value)

Sets a filter that can be used to skip certain focus node from validation. The filter must return true if the given candidate focus node shall be validated, and false to skip it.

Parameters:

value - the new filter

updateConforms

public void updateConforms()

validateAll

public org.apache.jena.rdf.model.Resource validateAll()
                                               throws InterruptedException

Validates all target nodes against all of their shapes. To further narrow down which nodes to validate, use {setFocusNodeFilter(Predicate).

Returns:

an instance of sh:ValidationReport in the results Model

Throws:

InterruptedException

validateNode

public org.apache.jena.rdf.model.Resource validateNode(org.apache.jena.graph.Node focusNode)
                                                throws InterruptedException

Validates a given focus node against all of the shapes that have matching targets.

Parameters:

focusNode - the node to validate

Returns:

an instance of sh:ValidationReport in the results Model

Throws:

InterruptedException

validateNodesAgainstShape

public org.apache.jena.rdf.model.Resource validateNodesAgainstShape(List<org.apache.jena.rdf.model.RDFNode> focusNodes,
                                                                    org.apache.jena.graph.Node shape)

Validates a given list of focus node against a given Shape.

Parameters:

focusNodes - the nodes to validate

shape - the sh:Shape to validate against

Returns:

an instance of sh:ValidationReport in the results Model