org.topbraid.spin.inference

Class SPINInferences

java.lang.Object

org.topbraid.spin.inference.SPINInferences

public class SPINInferences
extends Object

A service to execute inference rules based on the spin:rule property.

Author:

Holger Knublauch

Constructor Summary

Constructors

Constructor and Description
SPINInferences()

Method Summary

Modifier and Type	Method and Description
static void	addOptimizer(SPINInferencesOptimizer optimizer)
static boolean	isRuleProperty(org.apache.jena.rdf.model.Property property) Checks if a given property is a SPIN rule property.
static void	removeOptimizer(SPINInferencesOptimizer optimizer)
static int	run(org.apache.jena.rdf.model.Model queryModel, org.apache.jena.rdf.model.Model newTriples, Map<org.apache.jena.rdf.model.Resource,List<CommandWrapper>> class2Query, Map<org.apache.jena.rdf.model.Resource,List<CommandWrapper>> class2Constructor, SPINExplanations explanations, List<SPINStatistics> statistics, boolean singlePass, org.apache.jena.rdf.model.Property rulePredicate, SPINRuleComparator comparator, ProgressMonitor monitor) Iterates over a provided collection of SPIN rules and adds all constructed triples to a given Model (newTriples) until no further changes have been made within one iteration.
static int	run(org.apache.jena.rdf.model.Model queryModel, org.apache.jena.rdf.model.Model newTriples, SPINExplanations explanations, List<SPINStatistics> statistics, boolean singlePass, ProgressMonitor monitor) See the other run method for help - this is using spin:rule as rulePredicate.
static int	run(org.apache.jena.rdf.model.Model queryModel, org.apache.jena.rdf.model.Property rulePredicate, org.apache.jena.rdf.model.Model newTriples, SPINExplanations explanations, List<SPINStatistics> statistics, boolean singlePass, ProgressMonitor monitor) Iterates over all SPIN rules in a (query) Model and adds all constructed triples to a given Model (newTriples) until no further changes have been made within one iteration.
static boolean	runQueryOnInstance(QueryWrapper queryWrapper, org.apache.jena.rdf.model.Model queryModel, org.apache.jena.rdf.model.Model newTriples, org.apache.jena.rdf.model.Resource instance, boolean checkContains) Runs a given Jena Query on a given instance and adds the inferred triples to a given Model.

Methods inherited from class java.lang.Object

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

Constructor Detail

SPINInferences

public SPINInferences()

Method Detail

addOptimizer

public static void addOptimizer(SPINInferencesOptimizer optimizer)

removeOptimizer

public static void removeOptimizer(SPINInferencesOptimizer optimizer)

isRuleProperty

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

Checks if a given property is a SPIN rule property. This is (currently) defined as a property that has type spin:RuleProperty or is a sub-property of spin:rule. The latter condition may be removed at some later stage after people have upgraded to SPIN 1.1 conventions.

Parameters:

property - the property to check

Returns:

true if property is a rule property

run

public static int run(org.apache.jena.rdf.model.Model queryModel,
                      org.apache.jena.rdf.model.Model newTriples,
                      SPINExplanations explanations,
                      List<SPINStatistics> statistics,
                      boolean singlePass,
                      ProgressMonitor monitor)

See the other run method for help - this is using spin:rule as rulePredicate.

Parameters:

queryModel - the Model to query

newTriples - the Model to add the new triples to

explanations - an optional object to write explanations to

statistics - optional list to add statistics about which queries were slow

singlePass - true to just do a single pass (don't iterate)

monitor - an optional ProgressMonitor

Returns:

the number of iterations (1 with singlePass)

See Also:

run(Model, Property, Model, SPINExplanations, List, boolean, ProgressMonitor)

run

public static int run(org.apache.jena.rdf.model.Model queryModel,
                      org.apache.jena.rdf.model.Property rulePredicate,
                      org.apache.jena.rdf.model.Model newTriples,
                      SPINExplanations explanations,
                      List<SPINStatistics> statistics,
                      boolean singlePass,
                      ProgressMonitor monitor)

Iterates over all SPIN rules in a (query) Model and adds all constructed triples to a given Model (newTriples) until no further changes have been made within one iteration. Note that in order to iterate more than single pass, the newTriples Model must be a sub-model of the queryModel (which likely has to be an OntModel). The supplied rulePredicate is usually spin:rule, but can also be a sub- property of spin:rule to exercise finer control over which rules to fire.

Parameters:

queryModel - the Model to query

rulePredicate - the rule predicate (spin:rule or a sub-property thereof)

newTriples - the Model to add the new triples to

explanations - an optional object to write explanations to

statistics - optional list to add statistics about which queries were slow

singlePass - true to just do a single pass (don't iterate)

monitor - an optional ProgressMonitor

Returns:

the number of iterations (1 with singlePass)

run

public static int run(org.apache.jena.rdf.model.Model queryModel,
                      org.apache.jena.rdf.model.Model newTriples,
                      Map<org.apache.jena.rdf.model.Resource,List<CommandWrapper>> class2Query,
                      Map<org.apache.jena.rdf.model.Resource,List<CommandWrapper>> class2Constructor,
                      SPINExplanations explanations,
                      List<SPINStatistics> statistics,
                      boolean singlePass,
                      org.apache.jena.rdf.model.Property rulePredicate,
                      SPINRuleComparator comparator,
                      ProgressMonitor monitor)

Iterates over a provided collection of SPIN rules and adds all constructed triples to a given Model (newTriples) until no further changes have been made within one iteration. Note that in order to iterate more than single pass, the newTriples Model must be a sub-model of the queryModel (which likely has to be an OntModel).

Parameters:

queryModel - the Model to query

newTriples - the Model to add the new triples to

class2Query - the map of queries to run (see SPINQueryFinder)

class2Constructor - the map of constructors to run

explanations - an optional object to write explanations to

statistics - optional list to add statistics about which queries were slow

singlePass - true to just do a single pass (don't iterate)

rulePredicate - the predicate used (e.g. spin:rule)

comparator - optional comparator to determine the order of rule execution

monitor - an optional ProgressMonitor

Returns:

the number of iterations (1 with singlePass)

runQueryOnInstance

public static boolean runQueryOnInstance(QueryWrapper queryWrapper,
                                         org.apache.jena.rdf.model.Model queryModel,
                                         org.apache.jena.rdf.model.Model newTriples,
                                         org.apache.jena.rdf.model.Resource instance,
                                         boolean checkContains)

Runs a given Jena Query on a given instance and adds the inferred triples to a given Model.

Parameters:

queryWrapper - the wrapper of the CONSTRUCT query to execute

queryModel - the query Model

newTriples - the Model to write the triples to

instance - the instance to run the inferences on

checkContains - true to only call add if a Triple wasn't there yet

Returns:

true if changes were done (only meaningful if checkContains == true)