org.topbraid.shacl.validation

Class ValidationEngine

java.lang.Object

org.topbraid.shacl.engine.AbstractEngine

org.topbraid.shacl.validation.ValidationEngine

All Implemented Interfaces:

ConfigurableEngine, NodeExpressionContext

public class ValidationEngine
extends AbstractEngine
implements ConfigurableEngine

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

Field Summary

Fields inherited from class org.topbraid.shacl.engine.AbstractEngine

dataset, monitor, shapesGraph, shapesGraphURI

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)
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.rdf.model.Resource	createValidationResult(Constraint constraint, org.apache.jena.rdf.model.RDFNode focusNode, org.apache.jena.rdf.model.RDFNode value, Supplier<String> defaultMessage)
ClassesCache	getClassesCache()
ValidationEngineConfiguration	getConfiguration()
static ValidationEngine	getCurrent()
String	getLabel(org.apache.jena.rdf.model.RDFNode node)
Function<org.apache.jena.rdf.model.RDFNode,String>	getLabelFunction()
org.apache.jena.rdf.model.Resource	getReport() Gets the validation report as a Resource in the report Model.
ValidationReport	getValidationReport()
Collection<org.apache.jena.rdf.model.RDFNode>	getValueNodes(Constraint constraint, org.apache.jena.rdf.model.RDFNode focusNode)
boolean	nodesConformToShape(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, and stops as soon as one validation result is reported.
void	setClassesCache(ClassesCache value)
void	setConfiguration(ValidationEngineConfiguration configuration)
static void	setCurrent(ValidationEngine value)
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	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.
protected void	validateNodesAgainstConstraint(Collection<org.apache.jena.rdf.model.RDFNode> focusNodes, Constraint constraint)
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 org.topbraid.shacl.engine.AbstractEngine

applyEntailments, checkCanceled, getDataset, getProgressMonitor, getShapesGraph, getShapesGraphURI, getShapesModel, setProgressMonitor

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

getCurrent

public static ValidationEngine getCurrent()

setCurrent

public static void setCurrent(ValidationEngine value)

getLabelFunction

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

setLabelFunction

public void setLabelFunction(Function<org.apache.jena.rdf.model.RDFNode,String> 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)

createValidationResult

public org.apache.jena.rdf.model.Resource createValidationResult(Constraint constraint,
                                                                 org.apache.jena.rdf.model.RDFNode focusNode,
                                                                 org.apache.jena.rdf.model.RDFNode value,
                                                                 Supplier<String> defaultMessage)

getClassesCache

public ClassesCache getClassesCache()

getLabel

public String getLabel(org.apache.jena.rdf.model.RDFNode node)

getReport

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

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

Returns:

the report Resource

getValidationReport

public ValidationReport getValidationReport()

getValueNodes

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

setClassesCache

public void setClassesCache(ClassesCache value)

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 - if the monitor has canceled this

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 - if the monitor has canceled this

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

nodesConformToShape

public boolean nodesConformToShape(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, and stops as soon as one validation result is reported. No results are recorded.

Parameters:

focusNodes - the nodes to validate

shape - the sh:Shape to validate against

Returns:

true if there were no validation results, false for violations

validateNodesAgainstConstraint

protected void validateNodesAgainstConstraint(Collection<org.apache.jena.rdf.model.RDFNode> focusNodes,
                                              Constraint constraint)

getConfiguration

public ValidationEngineConfiguration getConfiguration()

Specified by:

getConfiguration in interface ConfigurableEngine

setConfiguration

public void setConfiguration(ValidationEngineConfiguration configuration)

Specified by:

setConfiguration in interface ConfigurableEngine