<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Soprano: Soprano::Inference::InferenceModel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Soprano <span id="projectnumber">2.6.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceSoprano.html">Soprano</a> </li>
<li class="navelem"><a class="el" href="namespaceSoprano_1_1Inference.html">Inference</a> </li>
<li class="navelem"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html">InferenceModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-slots">Public Slots</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Soprano::Inference::InferenceModel Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::Inference::InferenceModel" --><!-- doxytag: inherits="Soprano::FilterModel" -->
<p>The <a class="el" href="namespaceSoprano.html">Soprano</a> <a class="el" href="namespaceSoprano_1_1Inference.html">Inference</a> <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> provides a simple forward chaining inference engine which uses the underlying parent model itself to store status information.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="inferencemodel_8h_source.html">Soprano/Inference/InferenceModel</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for Soprano::Inference::InferenceModel:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classSoprano_1_1Inference_1_1InferenceModel__inherit__graph.png" border="0" usemap="#Soprano_1_1Inference_1_1InferenceModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Soprano_1_1Inference_1_1InferenceModel_inherit__map" id="Soprano_1_1Inference_1_1InferenceModel_inherit__map">
<area shape="rect" id="node2" href="classSoprano_1_1FilterModel.html" title="A FilterModel is a virtual model that wraps another Model." alt="" coords="49,160,191,189"/><area shape="rect" id="node4" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements." alt="" coords="64,83,176,112"/><area shape="rect" id="node6" href="qobject.html" title="QObject" alt="" coords="12,5,81,35"/><area shape="rect" id="node8" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="105,5,284,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classSoprano_1_1Inference_1_1InferenceModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a36fb5c16346fccfc8a1b3c24ccd4e903">performInference</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a48728092845a498394608e3d3a74304b">clearInference</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#aaee60abf620606dd470911c50f57a47c">setCompressedSourceStatements</a> (bool b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a0cd232b1191bb46d271bf2e8a195b945">setOptimizedQueriesEnabled</a> (bool b)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a91771535874f0749c5fe74bc3ea69c7f">InferenceModel</a> (<a class="el" href="classSoprano_1_1Model.html">Model</a> *<a class="elRef" href="qobject.html#parent">parent</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a296cdaefac209bb54e4425c54ba4e089">~InferenceModel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a74db154412f02bc5e237ec7838eecd4e">addStatement</a> (const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a2f87ee6724513469afa5f0a00415bc15">removeStatement</a> (const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a4233075b129ffebd04478598e7a5172e">removeAllStatements</a> (const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a187bf33ac4490d33b286d017d98fc0b3">addRule</a> (const <a class="el" href="classSoprano_1_1Inference_1_1Rule.html">Rule</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#aea29e5222c062035fed02307170d0ec0">setRules</a> (const <a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1Inference_1_1Rule.html">Rule</a> > &rules)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="namespaceSoprano.html">Soprano</a> <a class="el" href="namespaceSoprano_1_1Inference.html">Inference</a> <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> provides a simple forward chaining inference engine which uses the underlying parent model itself to store status information. </p>
<p>The <a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html" title="The Soprano Inference Model provides a simple forward chaining inference engine which uses the underl...">InferenceModel</a> does perfect inference which means that removing of statements is supported and results in a perfect update of the infered statements. There is only one exception: If a model contains two statements in different named graphs that both have the same subject, predicate, and object and trigger one rule then if one of these statements is removed the infered statements are removed, too, although the second statement would still make the infered one valid. This situation gets resolved once the same rule is triggered again by some other added statement or performInference gets called.</p>
<p>The inference is performed based on rules which are stored in <a class="el" href="classSoprano_1_1Inference_1_1Rule.html" title="A rule used by the InferenceModel to generate inferenced statements.">Rule</a> instances. Rules can be created manually or parsed using a <a class="el" href="classSoprano_1_1Inference_1_1RuleParser.html" title="The RuleParser can be used to parse Soprano rule files.">RuleParser</a>.</p>
<p><b>The inference engine works roughly as follows:</b></p>
<p>Whenever a new statement is added it is compared to each rule to check if it could trigger this rule. Then if it could trigger a rule this rule is applied to the whole model.</p>
<p>If a rule produces a new infered statement the following data is created: </p>
<ul>
<li>named graph A containing the infered statements </li>
<li>the statements that triggered the rule are stored in named graph sil:InferenceMetadata as source statements of A (sil:sourceStatement). The inference model supports two ways of storing source statements: plain and compressed (see setCompressedSourceStatements).</li>
</ul>
<p>Thus, when removing a statement it can easily be checked if this statement had been used to infer another one by querying all named graphs that have this statement as a source statement.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="inferencemodel_8h_source.html#l00071">71</a> of file <a class="el" href="inferencemodel_8h_source.html">inferencemodel.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a91771535874f0749c5fe74bc3ea69c7f"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::InferenceModel" ref="a91771535874f0749c5fe74bc3ea69c7f" args="(Model *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Inference::InferenceModel::InferenceModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSoprano_1_1Model.html">Model</a> * </td>
<td class="paramname"><em>parent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a296cdaefac209bb54e4425c54ba4e089"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::~InferenceModel" ref="a296cdaefac209bb54e4425c54ba4e089" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Inference::InferenceModel::~InferenceModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a74db154412f02bc5e237ec7838eecd4e"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::addStatement" ref="a74db154412f02bc5e237ec7838eecd4e" args="(const Statement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> Soprano::Inference::InferenceModel::addStatement </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a new statement to the model. Inferencing will be done directly. Inferenced statements are stored in additional named graphs. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#a1994117b73985823f12cb76192fdcda1">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a2f87ee6724513469afa5f0a00415bc15"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::removeStatement" ref="a2f87ee6724513469afa5f0a00415bc15" args="(const Statement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> Soprano::Inference::InferenceModel::removeStatement </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove one statement from the model. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#af6bf72a84ffb0fe92c2470eeb0eb8b4e">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a4233075b129ffebd04478598e7a5172e"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::removeAllStatements" ref="a4233075b129ffebd04478598e7a5172e" args="(const Statement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Error::ErrorCode</a> Soprano::Inference::InferenceModel::removeAllStatements </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Statement</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove statements from the model. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#ab5bf9cad97a0426e6dcf9fba65228911">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a187bf33ac4490d33b286d017d98fc0b3"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::addRule" ref="a187bf33ac4490d33b286d017d98fc0b3" args="(const Rule &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::addRule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Inference_1_1Rule.html">Rule</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an inference rule to the set of rules. This method will not trigger any inference action. If inference is necessary call <a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a36fb5c16346fccfc8a1b3c24ccd4e903">performInference()</a> after adding the new rules. </p>
</div>
</div>
<a class="anchor" id="aea29e5222c062035fed02307170d0ec0"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::setRules" ref="aea29e5222c062035fed02307170d0ec0" args="(const QList< Rule > &rules)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::setRules </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1Inference_1_1Rule.html">Rule</a> > & </td>
<td class="paramname"><em>rules</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the inference rules to be used. This method will not trigger any inference action. If inference is necessary call <a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a36fb5c16346fccfc8a1b3c24ccd4e903">performInference()</a> after adding the new rules. </p>
</div>
</div>
<a class="anchor" id="a36fb5c16346fccfc8a1b3c24ccd4e903"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::performInference" ref="a36fb5c16346fccfc8a1b3c24ccd4e903" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::performInference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Normally inferencing is done once new statements are added to the model or statements are removed. This method performs inferencing on the whole model. It is useful for initializing a model that already contains statements or update the model if it has been modified bypassing this filter model.</p>
<p>Tha latter can easily be done by connecting the <a class="el" href="classSoprano_1_1Model.html#a75af3d05854d07b802082e38afea050b">Model::statementsAdded</a> and <a class="el" href="classSoprano_1_1Model.html#ada3d38b1cb9edef8d76aebcb7314de4e">Model::statementsRemoved</a> signals to this slot. </p>
</div>
</div>
<a class="anchor" id="a48728092845a498394608e3d3a74304b"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::clearInference" ref="a48728092845a498394608e3d3a74304b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::clearInference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes all statements infered by this model. This can be useful if the parent model has been changed without informing the inference model and statements have been removed. </p>
</div>
</div>
<a class="anchor" id="aaee60abf620606dd470911c50f57a47c"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::setCompressedSourceStatements" ref="aaee60abf620606dd470911c50f57a47c" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::setCompressedSourceStatements </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If compressed statements are enabled source statements are stored compressed in one literal value. Otherwise source statements are stored using rdf:subject, rdf:predicate, rdf:object, and sil:context. Non-compressed statements are much cleaner from an ontology design point of view while compressed statements take much less space.</p>
<p>By default comressed source statements are enabled.</p>
<p>This method exists mainly for historical reasons and there normally is no need to call it. Compressed statements should work well for most users.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>If true compressed source statements are enabled (the default). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0cd232b1191bb46d271bf2e8a195b945"></a><!-- doxytag: member="Soprano::Inference::InferenceModel::setOptimizedQueriesEnabled" ref="a0cd232b1191bb46d271bf2e8a195b945" args="(bool b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Inference::InferenceModel::setOptimizedQueriesEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the storage backend supports joined SPARQL queries via UNION it makes sense to enable this.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>If true <a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html" title="The Soprano Inference Model provides a simple forward chaining inference engine which uses the underl...">InferenceModel</a> will use optimized queries for the inference during addStatement. This will speed up the process quite a lot as matching rules are only applied to the new statement. This flag has no influcence on <a class="el" href="classSoprano_1_1Inference_1_1InferenceModel.html#a36fb5c16346fccfc8a1b3c24ccd4e903">performInference()</a> though.</td></tr>
</table>
</dd>
</dl>
<p>The default is to disable the optimized queries since the default soprano redland backend does not support UNION. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builddir/build/BUILD/soprano-2.6.0/soprano/inference/<a class="el" href="inferencemodel_8h_source.html">inferencemodel.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Mar 11 2011 for Soprano by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
