eu.fbk.rdfpro

Class Ruleset

java.lang.Object

eu.fbk.rdfpro.Ruleset

public final class Ruleset
extends Object

A set of rules, with associated optional meta-vocabulary.

Field Summary

Fields

Modifier and Type	Field and Description
static Ruleset	OWL2RL
static Ruleset	RDFS
static Ruleset	RHODF

Constructor Summary

Constructors

Constructor and Description
Ruleset(Iterable<Rule> rules, Iterable<org.openrdf.model.URI> metaVocabularyTerms) Creates a new ruleset with the rules and meta-vocabulary terms supplied.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Two rulesets are equal if they have the same rules and meta-vocabulary terms.
static Ruleset	fromRDF(Iterable<org.openrdf.model.Statement> model) Parses a ruleset from the supplied RDF statements.
static Ruleset	fromRDF(String location) Parses a ruleset from the RDF located at the specified location.
Ruleset	getABoxRuleset(QuadModel tboxData) Returns the ruleset with the ABox rules obtained from the rules of this ruleset and the TBox data specified.
Set<org.openrdf.model.URI>	getMetaVocabularyTerms() Returns the meta-vocabulary terms associated to this ruleset.
Rule	getRule(org.openrdf.model.URI ruleID) Returns the rule with the ID specified, or null if there is no rule for that ID.
Set<Rule>	getRules() Returns the rules in this ruleset.
int	hashCode() The returned hash code depends on all the rules and meta-vocabulary terms in this ruleset.
boolean	isDeletePossible() Returns true if the evaluation of the ruleset may cause some statements to be deleted.
boolean	isInsertPossible() Returs true if the evaluation of the ruleset may cause some statements to be inserted.
boolean	isMatchable(org.openrdf.model.Statement stmt) Returns true if the supplied statement can be matched by a pattern in a WHERE or DELETE expression of some rule in this ruleset.
static Ruleset	merge(Ruleset... rulesets) Merges multiple rulesets in a single ruleset.
Ruleset	mergeSameWhereExpr() Returns the ruleset obtained by merging the rules in this ruleset with the same WHERE expression, priority and fixpoint flag.
Ruleset	rewriteGlobalGM(org.openrdf.model.URI globalGraph) Returns the ruleset obtained by rewriting the rules of this ruleset according to the GLOBAL graph inference mode, using the global graph URI specified.
Ruleset	rewriteSeparateGM() Returns the ruleset obtained by rewriting the rules of this ruleset according to the SEPARATE graph inference mode.
Ruleset	rewriteStarGM(org.openrdf.model.URI globalGraph) Returns the ruleset obtained by rewriting the rules of this ruleset according to the STAR graph inference mode, using the global graph URI supplied.
Ruleset	rewriteVariables(org.openrdf.query.BindingSet bindings) Returns the ruleset obtained by replacing selected variables in the rules of this ruleset with the constant values dictated by the supplied bindings.
<T extends Collection<? super org.openrdf.model.Statement>> T	toRDF(T output) Emits the RDF serialization of the ruleset.
String	toString() The returned string lists, on multiple lines, all the meta-vocabulary terms and rules in this ruleset.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RHODF

public static final Ruleset RHODF

RDFS

public static final Ruleset RDFS

OWL2RL

public static final Ruleset OWL2RL

Constructor Detail

Ruleset

public Ruleset(Iterable<Rule> rules,
               @Nullable
               Iterable<org.openrdf.model.URI> metaVocabularyTerms)

Creates a new ruleset with the rules and meta-vocabulary terms supplied.

Parameters:

rules - the rules

metaVocabularyTerms - the meta-vocabulary terms

Method Detail

getRules

public Set<Rule> getRules()

Returns the rules in this ruleset.

Returns:

a set of rules sorted by phase index, fixpoint flag and rule URI.

getRule

@Nullable
public Rule getRule(org.openrdf.model.URI ruleID)

Returns the rule with the ID specified, or null if there is no rule for that ID.

Parameters:

ruleID - the rule ID

Returns:

the rule for the ID specified, or null if it does not exist

getMetaVocabularyTerms

public Set<org.openrdf.model.URI> getMetaVocabularyTerms()

Returns the meta-vocabulary terms associated to this ruleset.

Returns:

a set of term URIs, sorted by URI

isDeletePossible

public boolean isDeletePossible()

Returns true if the evaluation of the ruleset may cause some statements to be deleted. This happens if the ruleset contains at least a rule with a non-null DELETE expression.

Returns:

true, if statement deletion is possible with this ruleset

isInsertPossible

public boolean isInsertPossible()

Returs true if the evaluation of the ruleset may cause some statements to be inserted. This happens if the ruleset contains at least a rule with a non-null INSERT expression.

Returns:

true, if statement insertion is possible with this ruleset

isMatchable

public boolean isMatchable(org.openrdf.model.Statement stmt)

Returns true if the supplied statement can be matched by a pattern in a WHERE or DELETE expression of some rule in this ruleset. Matchable statements (as defined before) are able to affect the rule evaluation process, whereas non-matchable statements can be safely removed with no effect on rule evaluation (i.e., no effect on the sets of statements deleted or inserted by the engine where evaluating this ruleset on some input data).

Parameters:

stmt - the statement to test

Returns:

true, if the statement is matchable by some WHERE or DELETE rule expression

getABoxRuleset

public Ruleset getABoxRuleset(QuadModel tboxData)

Returns the ruleset with the ABox rules obtained from the rules of this ruleset and the TBox data specified. The method split the DELETE, INSERT and WHERE expressions of rules into TBox and ABox parts. Rules with only TBox parts are discarded. Rules with only ABox parts are included as is in the returned ruleset. Rules with both ABox part (in DELETE and/or INSERT expressions) and TBox part (in WHERE expression) are instead 'exploded' by computing all the possible bindings of the TBox part w.r.t. the supplied TBox data, adding to the resulting ruleset all the rules obtained by injecting those bindings. Note: this method does not modify in any way the supplied TBox data. In general, it is necessary to close it w.r.t. relevant inference rules (which can be the same rules of this ruleset) before computing the ABox ruleset. In this case, the closure should be computed manually before calling this method.

Parameters:

tboxData - the TBox data

Returns:

the resulting ruleset

rewriteGlobalGM

public Ruleset rewriteGlobalGM(@Nullable
                               org.openrdf.model.URI globalGraph)

Returns the ruleset obtained by rewriting the rules of this ruleset according to the GLOBAL graph inference mode, using the global graph URI specified. Meta-vocabulary terms are not affected.

Parameters:

globalGraph - the URI of the global graph where to insert new quads; if null, quads will be inserted in the default graph sesame:nil

Returns:

a ruleset with the rewritten rules and the same meta-vocabulary terms of this ruleset

See Also:

Rule.rewriteGlobalGM(URI)

rewriteSeparateGM

public Ruleset rewriteSeparateGM()

Returns the ruleset obtained by rewriting the rules of this ruleset according to the SEPARATE graph inference mode. Meta-vocabulary terms are not affected.

Returns:

a ruleset with the rewritten rules and the same meta-vocabulary terms of this ruleset

See Also:

Rule.rewriteSeparateGM()

rewriteStarGM

public Ruleset rewriteStarGM(@Nullable
                             org.openrdf.model.URI globalGraph)

Returns the ruleset obtained by rewriting the rules of this ruleset according to the STAR graph inference mode, using the global graph URI supplied. Meta-vocabulary terms are not affected.

Parameters:

globalGraph - the URI of the global graph whose quads are 'imported' in other graphs; if null, the default graph sesame:nil will be used

Returns:

a ruleset with the rewritten rules and the same meta-vocabulary terms of this ruleset

See Also:

Rule.rewriteStarGM(URI)

rewriteVariables

public Ruleset rewriteVariables(@Nullable
                                org.openrdf.query.BindingSet bindings)

Returns the ruleset obtained by replacing selected variables in the rules of this ruleset with the constant values dictated by the supplied bindings. Meta-vocabulary terms are not affected.

Parameters:

bindings - the variable = value bindings to use for rewriting rules; if null or empty, no rewriting will take place

Returns:

a ruleset with the rewritten rules and the same meta-vocabulary terms of this ruleset

See Also:

Rule.rewriteVariables(BindingSet)

mergeSameWhereExpr

public Ruleset mergeSameWhereExpr()

Returns the ruleset obtained by merging the rules in this ruleset with the same WHERE expression, priority and fixpoint flag. Meta-vocabulary terms are not affected.

Returns:

a ruleset with the merged rules and the same meta-vocabulary terms of this ruleset

See Also:

Rule.mergeSameWhereExpr(Iterable)

equals

public boolean equals(Object object)

Two rulesets are equal if they have the same rules and meta-vocabulary terms.

Overrides:

equals in class Object

hashCode

public int hashCode()

The returned hash code depends on all the rules and meta-vocabulary terms in this ruleset.

Overrides:

hashCode in class Object

toString

public String toString()

The returned string lists, on multiple lines, all the meta-vocabulary terms and rules in this ruleset.

Overrides:

toString in class Object

toRDF

public <T extends Collection<? super org.openrdf.model.Statement>> T toRDF(T output)

Emits the RDF serialization of the ruleset. Emitted triples are placed in the default graph.

Parameters:

output - the collection where to add emitted RDF statements, not null

Returns:

the supplied collection

fromRDF

public static Ruleset fromRDF(Iterable<org.openrdf.model.Statement> model)

Parses a ruleset from the supplied RDF statements. The method extracts all the rules and the meta-vocabulary terms defined by supplied statements, and collects them in a new ruleset.

Parameters:

model - the RDF statements, not null

Returns:

the parsed ruleset

fromRDF

public static Ruleset fromRDF(String location)

Parses a ruleset from the RDF located at the specified location. The method extracts all the rules and the meta-vocabulary terms defined in the RDF, and collects them in a new ruleset.

Parameters:

location - the location where to load RDF data, not null

Returns:

the parsed ruleset

merge

public static Ruleset merge(Ruleset... rulesets)

Merges multiple rulesets in a single ruleset. The method collects all the rules and meta-vocabulary terms in the specified rulesets, and creates a new ruleset (if necessary) containing the resulting rules and terms.

Parameters:

rulesets - the rulesets to merge

Returns:

the merged ruleset (possibly one of the input rulesets)