org.topbraid.spin.constraints

Class SPINConstraints

java.lang.Object

org.topbraid.spin.constraints.SPINConstraints

public class SPINConstraints
extends Object

Performs SPIN constraint checking on one or more instances, based on the spin:constraints defined on the types of those instances.

Author:

Holger Knublauch

Constructor Summary

Constructors

Constructor and Description
SPINConstraints()

Method Summary

Modifier and Type	Method and Description
static void	addConstraintViolations(List<ConstraintViolation> results, SPINInstance instance, org.apache.jena.rdf.model.Property spinPredicate, boolean matchValue, org.apache.jena.rdf.model.Property onProperty, List<SPINStatistics> stats, ProgressMonitor monitor)
static void	addConstraintViolationsRDF(List<ConstraintViolation> cvs, org.apache.jena.rdf.model.Model result, boolean createSource) Creates an RDF representation (instances of spin:ConstraintViolation) from a collection of ConstraintViolation Java objects.
static void	addQueryResults(List<ConstraintViolation> results, QueryOrTemplateCall qot, org.apache.jena.rdf.model.Resource resource, boolean matchValue, List<SPINStatistics> stats, ProgressMonitor monitor)
static void	addTemplateCallResults(List<ConstraintViolation> results, QueryOrTemplateCall qot, org.apache.jena.rdf.model.Resource resource, boolean matchValue, ProgressMonitor monitor)
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Model model, ProgressMonitor monitor) Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Model model, org.apache.jena.rdf.model.Property predicate, List<SPINStatistics> stats, Predicate<org.apache.jena.rdf.model.Resource> filter, ProgressMonitor monitor) Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Model model, org.apache.jena.rdf.model.Property predicate, List<SPINStatistics> stats, ProgressMonitor monitor)
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Model model, org.apache.jena.rdf.model.Property predicate, ProgressMonitor monitor) Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Resource resource, ProgressMonitor monitor) Checks all spin:constraints for a given Resource.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Resource resource, org.apache.jena.rdf.model.Property spinPredicate, List<SPINStatistics> stats, ProgressMonitor monitor) Checks all spin:constraints for a given Resource.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Resource resource, org.apache.jena.rdf.model.Property spinPredicate, ProgressMonitor monitor) Checks all spin:constraints for a given Resource.
static List<ConstraintViolation>	check(org.apache.jena.rdf.model.Resource resource, org.apache.jena.rdf.model.Property spinPredicate, org.apache.jena.rdf.model.Property onProperty, List<SPINStatistics> stats, ProgressMonitor monitor)
static boolean	isConstraintProperty(org.apache.jena.rdf.model.Property property) Checks if a given property is a SPIN constraint property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPINConstraints

public SPINConstraints()

Method Detail

addConstraintViolations

public static void addConstraintViolations(List<ConstraintViolation> results,
                                           SPINInstance instance,
                                           org.apache.jena.rdf.model.Property spinPredicate,
                                           boolean matchValue,
                                           org.apache.jena.rdf.model.Property onProperty,
                                           List<SPINStatistics> stats,
                                           ProgressMonitor monitor)

addConstraintViolationsRDF

public static void addConstraintViolationsRDF(List<ConstraintViolation> cvs,
                                              org.apache.jena.rdf.model.Model result,
                                              boolean createSource)

Creates an RDF representation (instances of spin:ConstraintViolation) from a collection of ConstraintViolation Java objects.

Parameters:

cvs - the violation objects

result - the Model to add the results to

createSource - true to also create the spin:violationSource

addQueryResults

public static void addQueryResults(List<ConstraintViolation> results,
                                   QueryOrTemplateCall qot,
                                   org.apache.jena.rdf.model.Resource resource,
                                   boolean matchValue,
                                   List<SPINStatistics> stats,
                                   ProgressMonitor monitor)

addTemplateCallResults

public static void addTemplateCallResults(List<ConstraintViolation> results,
                                          QueryOrTemplateCall qot,
                                          org.apache.jena.rdf.model.Resource resource,
                                          boolean matchValue,
                                          ProgressMonitor monitor)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Resource resource,
                                              ProgressMonitor monitor)

Checks all spin:constraints for a given Resource.

Parameters:

resource - the instance to run constraint checks on

monitor - an (optional) progress monitor (currently ignored)

Returns:

a List of ConstraintViolations (empty if all is OK)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Resource resource,
                                              org.apache.jena.rdf.model.Property spinPredicate,
                                              ProgressMonitor monitor)

Checks all spin:constraints for a given Resource.

Parameters:

resource - the instance to run constraint checks on

spinPredicate - the system property, e.g. a sub-property of spin:constraint or null for the default (spin:constraint)

monitor - an (optional) progress monitor (currently ignored)

Returns:

a List of ConstraintViolations (empty if all is OK)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Resource resource,
                                              org.apache.jena.rdf.model.Property spinPredicate,
                                              List<SPINStatistics> stats,
                                              ProgressMonitor monitor)

Checks all spin:constraints for a given Resource.

Parameters:

resource - the instance to run constraint checks on

spinPredicate - the system property, i.e. spin:constraint or a sub-property thereof or null for the default (spin:constraint)

stats - an (optional) List to add statistics to

monitor - an (optional) progress monitor (currently ignored)

Returns:

a List of ConstraintViolations (empty if all is OK)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Resource resource,
                                              org.apache.jena.rdf.model.Property spinPredicate,
                                              org.apache.jena.rdf.model.Property onProperty,
                                              List<SPINStatistics> stats,
                                              ProgressMonitor monitor)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Model model,
                                              ProgressMonitor monitor)

Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations. A ProgressMonitor can be provided to enable the user to get intermediate status reports and to cancel the operation.

Parameters:

model - the Model to operate on

monitor - an optional ProgressMonitor

Returns:

a List of ConstraintViolations

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Model model,
                                              org.apache.jena.rdf.model.Property predicate,
                                              ProgressMonitor monitor)

Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations. A ProgressMonitor can be provided to enable the user to get intermediate status reports and to cancel the operation.

Parameters:

model - the Model to operate on

monitor - an optional ProgressMonitor

Returns:

a List of ConstraintViolations

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Model model,
                                              org.apache.jena.rdf.model.Property predicate,
                                              List<SPINStatistics> stats,
                                              ProgressMonitor monitor)

check

public static List<ConstraintViolation> check(org.apache.jena.rdf.model.Model model,
                                              org.apache.jena.rdf.model.Property predicate,
                                              List<SPINStatistics> stats,
                                              Predicate<org.apache.jena.rdf.model.Resource> filter,
                                              ProgressMonitor monitor)

Checks all instances in a given Model against all spin:constraints and returns a List of constraint violations. A ProgressMonitor can be provided to enable the user to get intermediate status reports and to cancel the operation.

Parameters:

model - the Model to operate on

predicate - the system property, e.g. a sub-property of spin:constraint

stats - an (optional) List to write statistics reports to

monitor - an optional ProgressMonitor

Returns:

a List of ConstraintViolations

isConstraintProperty

public static boolean isConstraintProperty(org.apache.jena.rdf.model.Property property)

Checks if a given property is a SPIN constraint property. This is defined as a property that is spin:constraint or a sub-property of it.

Parameters:

property - the property to check

Returns:

true if property is a constraint property