Soprano::Inference::Rule Class Reference

A rule used by the InferenceModel to generate inferenced statements. More...

#include <Soprano/Inference/Rule>

List of all members.

Public Member Functions
	Rule (const Rule &other)
	Rule ()
	~Rule ()
void	addPrecondition (const StatementPattern &)
Statement	bindEffect (const BindingSet &bindings) const
QList< Statement >	bindPreconditions (const BindingSet &bindings) const
void	bindToStatement (const Statement &statement)
Statement	boundToStatement () const
QString	createSparqlQuery (bool bindVariables=false) const
StatementPattern	effect () const
bool	isValid () const
bool	match (const Statement &statement) const
Rule &	operator= (const Rule &other)
QList< StatementPattern >	preconditions () const
void	setEffect (const StatementPattern &)

---

Detailed Description

A rule used by the InferenceModel to generate inferenced statements.

Rules can be created manually by adding preconditions and the effect via addPrecondition() and setEffect() or from a rules file through the RuleParser.

Author:

Sebastian Trueg <trueg@kde.org>

Definition at line 49 of file inferencerule.h.

---

Constructor & Destructor Documentation

Soprano::Inference::Rule::Rule

(

)

Constructs an invalid rule.

Soprano::Inference::Rule::Rule

(

const Rule &

other

)

Copy constructor.

Creates a shallow copy of other.

Soprano::Inference::Rule::~Rule

(

)

Destructor.

---

Member Function Documentation

void Soprano::Inference::Rule::addPrecondition

(

const StatementPattern &

)

Add a precondition.

Statement Soprano::Inference::Rule::bindEffect

(

const BindingSet &

bindings

)

const

Bind the rule's effect to a set of bindings as reveived from a query.

If the bindings do not contain all variables the bound statement is used as backup.

Parameters:

bindings

The bindings to apply to this rule.

Returns:

The statement infered by this rule under the application of bindings.

See also:

bindToStatement, bindPreconditions

QList<Statement> Soprano::Inference::Rule::bindPreconditions

(

const BindingSet &

bindings

)

const

Bind the rule's preconditions to a set of bindings as reveived from a query.

If the bindings do not contain all variables the bound statement is used as backup.

Parameters:

bindings

The bindings to apply to this rule.

Returns:

The statements that have to be valid in order for this rule to infer the statement returned by bindEffect under the same bindings.

See also:

bindToStatement, bindEffect

void Soprano::Inference::Rule::bindToStatement

(

const Statement &

statement

)

Bind this rule to a specific Statement.

The purpose of this method is to allow retricting the application of a rule to one statement, i.e. a newly added one.

Parameters:

statement

The Statement to bind this rule to.

See also:

createSparqlQuery, bindEffect, bindPreconditions

Statement Soprano::Inference::Rule::boundToStatement

(

)

const

Returns:

The statement set ia bindToStatement() or an invalid one if none was set.

QString Soprano::Inference::Rule::createSparqlQuery

(

bool

bindVariables = false

)

const

Create a SPARQL query that retrieves all resources matching this rule.

Parameters:

bindVariables

If true and a valid binding statement is set the query will be bound to this statement resulting in a UNION query of all possible bindings.

Returns:

A full SPARQL query or an empty string if this rule does not apply to the statement set via bindToStatement.

See also:

bindToStatement

StatementPattern Soprano::Inference::Rule::effect

(

)

const

The effect of a rule is a pattern that repeats variables from the preconditions and thus, identifies the statements that are to be infered from the preconditions.

bool Soprano::Inference::Rule::isValid

(

)

const

Check if a rule is valid.

Returns:

true if the rule is valid and can be used with the InferenceModel, false otherwise.

Since:

2.3

bool Soprano::Inference::Rule::match

(

const Statement &

statement

)

const

Check if a statement matches any of the statement patterns in this rule.

Returns:

true if statement matches any of the patterns, false otherwise. Be aware that createSparqlQuery() might still return an empty string since it does perform some aditional optimization checks based on the bound statement.

Rule& Soprano::Inference::Rule::operator=

(

const Rule &

other

)

Assignment operator.

Creates a shallow copy of other.

QList<StatementPattern> Soprano::Inference::Rule::preconditions

(

)

const

The list of preconditions for the rule.

Each condition is a StatementPattern which can contain variables. These variables are identified by their name and matched accordingly.

void Soprano::Inference::Rule::setEffect

(

const StatementPattern &

)

Set the effect of the rule.

---

The documentation for this class was generated from the following file:

• inferencerule.h