org.topbraid.spin.util

Class SPINUtil

java.lang.Object

org.topbraid.spin.util.SPINUtil

public class SPINUtil
extends Object

Some static util methods for SPIN that don't fit anywhere else.

Author:

Holger Knublauch

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_CLASS_VAR_NAME The name of the variable that will be used in type binding triple patterns (?this rdf:type ?TYPE_CLASS)

Constructor Summary

Constructors

Constructor and Description
SPINUtil()

Method Summary

Modifier and Type	Method and Description
static void	addQueryOrTemplateCalls(org.apache.jena.rdf.model.Resource cls, org.apache.jena.rdf.model.Property predicate, List<QueryOrTemplateCall> results) Collects all queries or template calls at a given class.
static String	addThisTypeClause(String str) Inserts a statement ?this a ?TYPE_CLASS .
static void	applyBindings(Map<org.apache.jena.rdf.model.Property,org.apache.jena.rdf.model.RDFNode> map, Map<String,org.apache.jena.rdf.model.RDFNode> bindings) Applies variable bindings, replacing the values of one map with the values from a given variables map.
static void	bindThis(org.apache.jena.query.QueryExecution qexec, org.apache.jena.rdf.model.RDFNode value) Binds the variable ?this with a given value.
static boolean	containsThis(CommandWithWhere command) Checks whether a given query mentions the variable ?this anywhere.
static org.apache.jena.rdf.model.RDFNode	getFirstResult(org.apache.jena.query.QueryExecution qexec) Executes a given SELECT query and returns the first value of the first result variable, if any exists.
static String	getQueryString(org.apache.jena.rdf.model.RDFNode node, boolean usePrefixes) Deprecated. for the same reason as TemplateCall.getQueryString()
static Map<org.apache.jena.rdf.model.Statement,String>	getQueryStringMap(org.apache.jena.rdf.model.Resource subject, org.apache.jena.rdf.model.Property property) Gets a Map of all query strings defined as values of a given property.
static Collection<String>	getQueryStrings(org.apache.jena.rdf.model.Resource subject, org.apache.jena.rdf.model.Property property) Deprecated. for the same reasons as TemplateCall.getQueryString()
static Set<org.apache.jena.rdf.model.Resource>	getURIResources(Printable query)
static boolean	isLibraryOntology(org.apache.jena.graph.Graph graph, URI baseURI) Checks whether a given Graph is a spin:LibraryOntology.
static boolean	isRootClass(org.apache.jena.rdf.model.Resource cls)
static Map<String,org.apache.jena.rdf.model.RDFNode>	mapProperty2VarNames(Map<org.apache.jena.rdf.model.Property,org.apache.jena.rdf.model.RDFNode> map) Converts a map from Properties to RDFNode values to a Map from variable names (Strings) to those values, for quicker look up.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_CLASS_VAR_NAME

public static final String TYPE_CLASS_VAR_NAME

The name of the variable that will be used in type binding triple patterns (?this rdf:type ?TYPE_CLASS)

See Also:

Constant Field Values

Constructor Detail

SPINUtil

public SPINUtil()

Method Detail

addQueryOrTemplateCalls

public static void addQueryOrTemplateCalls(org.apache.jena.rdf.model.Resource cls,
                                           org.apache.jena.rdf.model.Property predicate,
                                           List<QueryOrTemplateCall> results)

Collects all queries or template calls at a given class.

Parameters:

cls - the class to get the queries at

predicate - the predicate such as spin:rule

results - the List to add the results to

addThisTypeClause

public static String addThisTypeClause(String str)

Inserts a statement ?this a ?TYPE_CLASS . after the WHERE { keyword. The current implementation is not 100% correct - it is based on a simple regex matching and somebody could put a WHERE { into a comment to break it.

Parameters:

str - the input String

applyBindings

public static void applyBindings(Map<org.apache.jena.rdf.model.Property,org.apache.jena.rdf.model.RDFNode> map,
                                 Map<String,org.apache.jena.rdf.model.RDFNode> bindings)

Applies variable bindings, replacing the values of one map with the values from a given variables map.

Parameters:

map - the Map to modify

bindings - the current variable bindings

bindThis

public static void bindThis(org.apache.jena.query.QueryExecution qexec,
                            org.apache.jena.rdf.model.RDFNode value)

Binds the variable ?this with a given value.

Parameters:

qexec - the QueryExecution to modify

value - the value to bind ?this with

containsThis

public static boolean containsThis(CommandWithWhere command)

Checks whether a given query mentions the variable ?this anywhere. This can be used to check whether ?this needs to be bound before execution, etc. The current implementation is very primitive in that it only checks for the string "?this" anywhere in the query, so this method should only be used if a false positive does not cause problems.

Parameters:

command - the query to test

Returns:

true if it was found

getFirstResult

public static org.apache.jena.rdf.model.RDFNode getFirstResult(org.apache.jena.query.QueryExecution qexec)

Executes a given SELECT query and returns the first value of the first result variable, if any exists. The QueryExecution is closed at the end.

Parameters:

qexec - the QueryExecution to execute

Returns:

the first result or null

getQueryString

public static String getQueryString(org.apache.jena.rdf.model.RDFNode node,
                                    boolean usePrefixes)

Deprecated. for the same reason as TemplateCall.getQueryString()

Attempts to convert a given RDFNode to a String so that it can be parsed into a Jena query object. The node must be either a string Literal, or a sp:Query node or a template call. If it's a template call then the resulting query string will "hard-bind" the template variables.

Parameters:

node - the RDFNode to convert

usePrefixes - true to use qname abbreviations

Returns:

the String representation of node

Throws:

IllegalArgumentException - if the node is not a valid SPIN Query or a String

getQueryStrings

public static Collection<String> getQueryStrings(org.apache.jena.rdf.model.Resource subject,
                                                 org.apache.jena.rdf.model.Property property)

Deprecated. for the same reasons as TemplateCall.getQueryString()

Gets a Collection of all query strings defined as values of a given property. This will accept strings or SPIN expressions (including template calls). The query model is the subject's getModel(). All sub-properties of property from the query model will also be queried.

Parameters:

subject - the subject to get the values of

property - the property to query

Returns:

a Set of query strings

getQueryStringMap

public static Map<org.apache.jena.rdf.model.Statement,String> getQueryStringMap(org.apache.jena.rdf.model.Resource subject,
                                                                                org.apache.jena.rdf.model.Property property)

Gets a Map of all query strings defined as values of a given property. This will accept strings or SPIN expressions (including template calls). The query model is the subject's getModel(). All sub-properties of property from the query model will also be queried. The resulting Map will associate each query String with the Statement that has created it.

Parameters:

subject - the subject to get the values of

property - the property to query

Returns:

a Map of Statements to query strings

getURIResources

public static Set<org.apache.jena.rdf.model.Resource> getURIResources(Printable query)

isLibraryOntology

public static boolean isLibraryOntology(org.apache.jena.graph.Graph graph,
                                        URI baseURI)

Checks whether a given Graph is a spin:LibraryOntology. This is true for the SP and SPIN namespaces, as well as any Graph that has [baseURI] rdf:type spin:LibraryOntology.

Parameters:

graph - the Graph to test

baseURI - the base URI of the Graph (to find the library ontology)

Returns:

true if graph is a library ontology

isRootClass

public static boolean isRootClass(org.apache.jena.rdf.model.Resource cls)

mapProperty2VarNames

public static Map<String,org.apache.jena.rdf.model.RDFNode> mapProperty2VarNames(Map<org.apache.jena.rdf.model.Property,org.apache.jena.rdf.model.RDFNode> map)

Converts a map from Properties to RDFNode values to a Map from variable names (Strings) to those values, for quicker look up.

Parameters:

map - the old Map

Returns:

the new Map