Soprano  2.7.6
Public Member Functions
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 ()
 Rule (const Rule &other)
 ~Rule ()
Ruleoperator= (const Rule &other)
QList< StatementPatternpreconditions () const
void addPrecondition (const StatementPattern &)
StatementPattern effect () const
void setEffect (const StatementPattern &)
bool match (const Statement &statement) const
void bindToStatement (const Statement &statement)
Statement boundToStatement () const
QString createSparqlQuery (bool bindVariables=false) const
Statement bindEffect (const BindingSet &bindings) const
QList< StatementbindPreconditions (const BindingSet &bindings) const
bool isValid () const

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.nosp@m.@kde.nosp@m..org

Definition at line 49 of file inferencerule.h.


Constructor & Destructor Documentation

Constructs an invalid rule

Copy constructor. Creates a shallow copy of other.

Destructor


Member Function Documentation

Rule& Soprano::Inference::Rule::operator= ( const Rule other)

Assignment operator. Creates a shallow copy of other.

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.

Add a precondition

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.

Set the effect of the rule.

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.

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:
statementThe Statement to bind this rule to.
See also:
createSparqlQuery, bindEffect, bindPreconditions
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:
bindVariablesIf 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

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:
bindingsThe bindings to apply to this rule.
Returns:
The statement infered by this rule under the application of bindings.
See also:
bindToStatement, bindPreconditions

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:
bindingsThe 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

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

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