<!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::Index::IndexFilterModel 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_1Index.html">Index</a> </li>
<li class="navelem"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html">IndexFilterModel</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>Soprano::Index::IndexFilterModel Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::Index::IndexFilterModel" --><!-- doxytag: inherits="Soprano::FilterModel" -->
<p>The <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a> provides a full text index around any <a class="el" href="namespaceSoprano.html">Soprano</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>.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="indexfiltermodel_8h_source.html">Soprano/Index/IndexFilterModel</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::Index::IndexFilterModel:</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_1Index_1_1IndexFilterModel__inherit__graph.png" border="0" usemap="#Soprano_1_1Index_1_1IndexFilterModel_inherit__map" alt="Inheritance graph"/></div>
<map name="Soprano_1_1Index_1_1IndexFilterModel_inherit__map" id="Soprano_1_1Index_1_1IndexFilterModel_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="43,160,184,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="57,83,169,112"/><area shape="rect" id="node6" href="qobject.html" title="QObject" alt="" coords="5,5,75,35"/><area shape="rect" id="node8" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="99,5,277,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classSoprano_1_1Index_1_1IndexFilterModel-members.html">List of all members.</a></p>
<table class="memberdecls">
<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_1Index_1_1IndexFilterModel.html#ad0fd67d4f58efc6eff366d6539ec134c">IndexFilterModel</a> (const <a class="elRef" href="qstring.html">QString</a> &indexDir, <a class="el" href="classSoprano_1_1Model.html">Soprano::Model</a> *model=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#ac9ddbfced4b3b92dacb02e84e1196ca8">IndexFilterModel</a> (<a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html">CLuceneIndex</a> *index, <a class="el" href="classSoprano_1_1Model.html">Soprano::Model</a> *model=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#adf2b340d1557b078f04e107758c7b49e">~IndexFilterModel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html">CLuceneIndex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#ade7d5eb6eee6c7a4be9872fcfe2a792e">index</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a858fea29158897e1d67273548aa359e6">addStatement</a> (const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> &statement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a42da38dc7619b3bfe894dcdd006b05da">removeStatement</a> (const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> &statement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#ad8d37102c79a1f4e8d197806163d3d43">removeAllStatements</a> (const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> &statement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1QueryResultIterator.html">QueryResultIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a09ae3a8005c3692dc3d452816f689a44">executeQuery</a> (const <a class="elRef" href="qstring.html">QString</a> &query, <a class="el" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26c">Query::QueryLanguage</a> language, const <a class="elRef" href="qstring.html">QString</a> &userQueryLanguage=<a class="elRef" href="qstring.html">QString</a>()) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a523f94a289f3950c6f728957df0712a0">setTransactionCacheSize</a> (int size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a755c0ddaf84af30e4d6948ac38d459de">transactionCacheSize</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a91d09816f453d1421c1d28273a16e1c3">rebuildIndex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#ac29b76a4d49c216797ae9e8ddda5fcc5">optimizeIndex</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a7071d78dc19c0278cc8c339381e6f72f">addIndexOnlyPredicate</a> (const <a class="elRef" href="qurl.html">QUrl</a> &predicate)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a3750a42a72218a7197224b65ff5357d2">setIndexOnlyPredicates</a> (const <a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > &predicates)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a65b1866e75a3679ccdfe6b600456688b">indexOnlyPredicates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a859fc4ab22313c5d63681f67c5c0cf6e">addForceIndexPredicate</a> (const <a class="elRef" href="qurl.html">QUrl</a> &predicate)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#aef3ee1800ae77e8a889812e63c475f64">setForceIndexPredicates</a> (const <a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > &predicates)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#afb6e5b05816baaa9c91658bd57a25621">forceIndexPredicates</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#aaeac3c1263376d7af32dd22e13f89f61">encodeStringForLuceneQuery</a> (const <a class="elRef" href="qstring.html">QString</a> &value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a017c4b9b4cc5b7ebccfc5d6d0de9aba1">encodeUriForLuceneQuery</a> (const <a class="elRef" href="qurl.html">QUrl</a> &uri)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a> provides a full text index around any <a class="el" href="namespaceSoprano.html">Soprano</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>. </p>
<p>All statements with a literal object will be indexed. The literals can then be searched with CLucene queries. More details regarding queries can be found in the documentation fo <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a09ae3a8005c3692dc3d452816f689a44">executeQuery()</a>.</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="indexfiltermodel_8h_source.html#l00061">61</a> of file <a class="el" href="indexfiltermodel_8h_source.html">indexfiltermodel.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad0fd67d4f58efc6eff366d6539ec134c"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::IndexFilterModel" ref="ad0fd67d4f58efc6eff366d6539ec134c" args="(const QString &indexDir, Soprano::Model *model=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Index::IndexFilterModel::IndexFilterModel </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>indexDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classSoprano_1_1Model.html">Soprano::Model</a> * </td>
<td class="paramname"><em>model</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new index model.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">indexDir</td><td>The directory where the index should be stored. If the directory already contains an index, it will be used. Otherwise a new one will be created. </td></tr>
<tr><td class="paramname">model</td><td>The parent model to forward the calls to. If 0 the <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> has to be set later on with <a class="el" href="classSoprano_1_1FilterModel.html#a175bf899c75344b7c4567583f1c8f464">FilterModel::setParentModel</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac9ddbfced4b3b92dacb02e84e1196ca8"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::IndexFilterModel" ref="ac9ddbfced4b3b92dacb02e84e1196ca8" args="(CLuceneIndex *index, Soprano::Model *model=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Index::IndexFilterModel::IndexFilterModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html">CLuceneIndex</a> * </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classSoprano_1_1Model.html">Soprano::Model</a> * </td>
<td class="paramname"><em>model</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new index model.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The index to be used. The filter model will NOT take ownership of the index. The caller has to take care of deleting the index. </td></tr>
<tr><td class="paramname">model</td><td>The parent model to forward the calls to. If 0 the <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> has to be set later on with <a class="el" href="classSoprano_1_1FilterModel.html#a175bf899c75344b7c4567583f1c8f464">FilterModel::setParentModel</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adf2b340d1557b078f04e107758c7b49e"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::~IndexFilterModel" ref="adf2b340d1557b078f04e107758c7b49e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Index::IndexFilterModel::~IndexFilterModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ade7d5eb6eee6c7a4be9872fcfe2a792e"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::index" ref="ade7d5eb6eee6c7a4be9872fcfe2a792e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html">CLuceneIndex</a>* Soprano::Index::IndexFilterModel::index </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the index used by this index model. </p>
</div>
</div>
<a class="anchor" id="a858fea29158897e1d67273548aa359e6"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::addStatement" ref="a858fea29158897e1d67273548aa359e6" args="(const Soprano::Statement &statement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> Soprano::Index::IndexFilterModel::addStatement </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> & </td>
<td class="paramname"><em>statement</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a new statement.</p>
<p>This will index the statement and then forward the call to the parent model. Normally only statements with literal objects are indexed. An exception are those statements with predicates that are set via setForceIndexPredicates. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#a1994117b73985823f12cb76192fdcda1">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a42da38dc7619b3bfe894dcdd006b05da"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::removeStatement" ref="a42da38dc7619b3bfe894dcdd006b05da" args="(const Soprano::Statement &statement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> Soprano::Index::IndexFilterModel::removeStatement </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> & </td>
<td class="paramname"><em>statement</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes a statement.</p>
<p>This will remove the statement from the index and then forward the call to the parent model. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#af6bf72a84ffb0fe92c2470eeb0eb8b4e">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="ad8d37102c79a1f4e8d197806163d3d43"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::removeAllStatements" ref="ad8d37102c79a1f4e8d197806163d3d43" args="(const Soprano::Statement &statement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> Soprano::Index::IndexFilterModel::removeAllStatements </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1Statement.html">Soprano::Statement</a> & </td>
<td class="paramname"><em>statement</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes statements.</p>
<p>This will remove the statements from the index and then forward the call to the parent model. </p>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#ab5bf9cad97a0426e6dcf9fba65228911">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a09ae3a8005c3692dc3d452816f689a44"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::executeQuery" ref="a09ae3a8005c3692dc3d452816f689a44" args="(const QString &query, Query::QueryLanguage language, const QString &userQueryLanguage=QString()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1QueryResultIterator.html">QueryResultIterator</a> Soprano::Index::IndexFilterModel::executeQuery </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26c">Query::QueryLanguage</a> </td>
<td class="paramname"><em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>userQueryLanguage</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a> is currently based on CLucene. While the index itself is available via <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#ade7d5eb6eee6c7a4be9872fcfe2a792e">index()</a> and allows querying via CLucene queries it is not available over the <a class="el" href="namespaceSoprano_1_1Client.html">Soprano::Client</a> interface. Thus, CLucene queries are supported through this method and will return <a class="el" href="classSoprano_1_1Index_1_1QueryHit.html" title="QueryHit represents a hit from an IndexFilterModel query. It basically is an RDF resource combined wi...">QueryHit</a> objects wrapped in a <a class="el" href="classSoprano_1_1QueryResultIterator.html" title="An iterator for query results.">QueryResultIterator</a>.</p>
<p>Future versions of Soprano will support querying the index through the <a class="el" href="namespaceSoprano_1_1Query.html">Soprano::Query</a> API (still unfinished and unstable).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td>The query string. This can be a CLucene query in which case the query will be passed to <a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html" title="The CLuceneIndex provides a wrapper around a CLucene index which stores RDF statements.">CLuceneIndex</a>. </td></tr>
<tr><td class="paramname">language</td><td>The query language. Set to <a class="el" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26cac6b6f6a34d2d09221941d9a0ac522633">Soprano::Query::QueryLanguageUser</a> for CLucene queries. </td></tr>
<tr><td class="paramname">userQueryLanguage</td><td>If <code>language</code> equals <a class="el" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26cac6b6f6a34d2d09221941d9a0ac522633">Query::QueryLanguageUser</a> userQueryLanguage defines the language to use. Use <b>"lucene"</b> to perform CLucene queries.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An iterator over all results matching the query, on error an invalid iterator is returned. In case of a CLucene query the iterator will wrap a set of <a class="el" href="classSoprano_1_1Index_1_1QueryHit.html" title="QueryHit represents a hit from an IndexFilterModel query. It basically is an RDF resource combined wi...">QueryHit</a> objects through the bindings <b>"resource"</b> and <b>"score"</b>.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html#a940bbeca2c34eba3f4ed4fea6e612d3c">CLuceneIndex::search()</a> </dd></dl>
<p>Reimplemented from <a class="el" href="classSoprano_1_1FilterModel.html#a8d5189d772d22a7dd878bdc31cd01c18">Soprano::FilterModel</a>.</p>
</div>
</div>
<a class="anchor" id="a523f94a289f3950c6f728957df0712a0"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::setTransactionCacheSize" ref="a523f94a289f3950c6f728957df0712a0" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::setTransactionCacheSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the number or addStatement operations that are to be cached in the index. The default value is 1 which means that no caching occurs. Be aware that query operations will always close cached transactions.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The number of operations that should be handled in one transaction. Set to 1 to disable.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html#aa08293f5eedb824e3ca354530ea851a4">CLuceneIndex::startTransaction</a>, <a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html#ab8892943cfcec07d3c08c7b1dfb69c91">CLuceneIndex::closeTransaction</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a755c0ddaf84af30e4d6948ac38d459de"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::transactionCacheSize" ref="a755c0ddaf84af30e4d6948ac38d459de" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Soprano::Index::IndexFilterModel::transactionCacheSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The number of addStatement operations to cache in one transaction.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a523f94a289f3950c6f728957df0712a0">setTransactionCacheSize</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a91d09816f453d1421c1d28273a16e1c3"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::rebuildIndex" ref="a91d09816f453d1421c1d28273a16e1c3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::rebuildIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Rebuild the complete index. This means that the index will be cleared and all literal statements will be re-indexed.</p>
<p>This method is purely intended for maintenance.</p>
<dl class="since"><dt><b>Since:</b></dt><dd>2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="ac29b76a4d49c216797ae9e8ddda5fcc5"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::optimizeIndex" ref="ac29b76a4d49c216797ae9e8ddda5fcc5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::optimizeIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Optimize the index for search. This makes sense after adding or removing a large number of statements.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1CLuceneIndex.html#a590f9bc8879e847e95c5ee4c44299cc1">CLuceneIndex::optimize</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a7071d78dc19c0278cc8c339381e6f72f"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::addIndexOnlyPredicate" ref="a7071d78dc19c0278cc8c339381e6f72f" args="(const QUrl &predicate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::addIndexOnlyPredicate </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qurl.html">QUrl</a> & </td>
<td class="paramname"><em>predicate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a predicate which should only be indexed. This might be useful for very large literals whose value is of no interest but which should be searchable.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">predicate</td><td>The predicate that should only be indexed but not stored in the underlying <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>.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a65b1866e75a3679ccdfe6b600456688b">indexOnlyPredicates</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a3750a42a72218a7197224b65ff5357d2">setIndexOnlyPredicates</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="a3750a42a72218a7197224b65ff5357d2"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::setIndexOnlyPredicates" ref="a3750a42a72218a7197224b65ff5357d2" args="(const QList< QUrl > &predicates)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::setIndexOnlyPredicates </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > & </td>
<td class="paramname"><em>predicates</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the predicates that should only be indexed. This might be useful for very large literals whose value is of no interest but which should be searchable.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">predicates</td><td>A list of predicates that should only be indexed but not stored in the underlying <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>.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a65b1866e75a3679ccdfe6b600456688b">indexOnlyPredicates</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a7071d78dc19c0278cc8c339381e6f72f">addIndexOnlyPredicate</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="a65b1866e75a3679ccdfe6b600456688b"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::indexOnlyPredicates" ref="a65b1866e75a3679ccdfe6b600456688b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qlist.html">QList</a><<a class="elRef" href="qurl.html">QUrl</a>> Soprano::Index::IndexFilterModel::indexOnlyPredicates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a> supports to not forward certain predicates to the parent <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> but only index their value. This might be useful for very large literals whose value is of no interest but which should be searchable.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of predicates that will only be indexed but not stored in the underlying <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>.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a7071d78dc19c0278cc8c339381e6f72f">addIndexOnlyPredicate</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a3750a42a72218a7197224b65ff5357d2">setIndexOnlyPredicates</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="a859fc4ab22313c5d63681f67c5c0cf6e"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::addForceIndexPredicate" ref="a859fc4ab22313c5d63681f67c5c0cf6e" args="(const QUrl &predicate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::addForceIndexPredicate </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qurl.html">QUrl</a> & </td>
<td class="paramname"><em>predicate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a predicate which should be indexed even if the object is a resource. See setForceIndexPredicates for a detailed explanation.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">predicate</td><td>The predicate that should be indexed in any case.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#afb6e5b05816baaa9c91658bd57a25621">forceIndexPredicates</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#aef3ee1800ae77e8a889812e63c475f64">setForceIndexPredicates</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aef3ee1800ae77e8a889812e63c475f64"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::setForceIndexPredicates" ref="aef3ee1800ae77e8a889812e63c475f64" args="(const QList< QUrl > &predicates)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Index::IndexFilterModel::setForceIndexPredicates </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qlist.html">QList</a>< <a class="elRef" href="qurl.html">QUrl</a> > & </td>
<td class="paramname"><em>predicates</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Normally only statements with a literal object are indexed when added thorugh addStatement. In some cases however, it is useful to also index resource objects.</p>
<p><a class="el" href="classSoprano_1_1Statement.html" title="A Statement instance represents one RDF quadruple.">Statement</a> with a resource object (a URI) and a predicate that matches one of the force index predicates, are converted to strings using <a class="elRef" href="qurl.html#toEncoded">QUrl::toEncoded</a> and added to the index non-tokenized. Thus, the resources will be searchable directly via a 'field:uri' query but not via the default search field.</p>
<p>A typical and very useful predicate is <a class="el" href="namespaceSoprano_1_1Vocabulary_1_1RDF.html#a28ec91b268156971dedc36c027a023a6">Vocabulary::RDF::type()</a>. This allows to restrict the type of resources in lucene queries:</p>
<div class="fragment"><pre class="fragment"> model-><a class="code" href="classSoprano_1_1Model.html#a5157ca3996dea1e7a46947d41e530c51">executeQuery</a>( <a class="codeRef" href="qstring.html">QString</a>( <span class="stringliteral">"foobar AND %1:%2"</span> )
.arg( <a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a017c4b9b4cc5b7ebccfc5d6d0de9aba1">encodeUriForLuceneQuery</a>( <a class="code" href="namespaceSoprano_1_1Vocabulary_1_1RDF.html#a28ec91b268156971dedc36c027a023a6">RDF::type</a>() ) )
.arg( <a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a017c4b9b4cc5b7ebccfc5d6d0de9aba1">encodeUriForLuceneQuery</a>( myType ) ),
<a class="code" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26cac6b6f6a34d2d09221941d9a0ac522633">Query::QueryLanguageUser</a>,
<span class="stringliteral">"lucene"</span> );
</pre></div><dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">predicates</td><td>The predicates that should be indexed in any case.</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#afb6e5b05816baaa9c91658bd57a25621">forceIndexPredicates</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a859fc4ab22313c5d63681f67c5c0cf6e">addForceIndexPredicate</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="afb6e5b05816baaa9c91658bd57a25621"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::forceIndexPredicates" ref="afb6e5b05816baaa9c91658bd57a25621" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qlist.html">QList</a><<a class="elRef" href="qurl.html">QUrl</a>> Soprano::Index::IndexFilterModel::forceIndexPredicates </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See setForceIndexPredicates for a detailed explanation.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of predicates that will be indexed even if the object is not a literal.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a859fc4ab22313c5d63681f67c5c0cf6e">addForceIndexPredicate</a>, <a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#aef3ee1800ae77e8a889812e63c475f64">setForceIndexPredicates</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aaeac3c1263376d7af32dd22e13f89f61"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::encodeStringForLuceneQuery" ref="aaeac3c1263376d7af32dd22e13f89f61" args="(const QString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="qstring.html">QString</a> Soprano::Index::IndexFilterModel::encodeStringForLuceneQuery </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a string to be used in a lucene query. String values may contain characters that are reserved in lucene queries. These are property escaped by this method.</p>
<p>This method converts an arbitrary string into a string that can be used in a lucene query.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The string to be encoded.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An encoded and escaped string representation of the provided string.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#a017c4b9b4cc5b7ebccfc5d6d0de9aba1">encodeUriForLuceneQuery</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a017c4b9b4cc5b7ebccfc5d6d0de9aba1"></a><!-- doxytag: member="Soprano::Index::IndexFilterModel::encodeUriForLuceneQuery" ref="a017c4b9b4cc5b7ebccfc5d6d0de9aba1" args="(const QUrl &uri)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="qstring.html">QString</a> Soprano::Index::IndexFilterModel::encodeUriForLuceneQuery </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qurl.html">QUrl</a> & </td>
<td class="paramname"><em>uri</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encodes a URI to be used in a lucene query. URIs often contain characters that are reserved in lucene queries and, thus, need to be escaped. In addition, the URIs are encoded by the index model for storage in clucene.</p>
<p>This method converts a URI into a string that can be used in a lucene query.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">uri</td><td>The URI to be encoded.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>An encoded and escaped string representation of the URI.</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Index_1_1IndexFilterModel.html#aaeac3c1263376d7af32dd22e13f89f61">encodeStringForLuceneQuery</a></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.2 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builddir/build/BUILD/soprano-2.6.0/index/<a class="el" href="indexfiltermodel_8h_source.html">indexfiltermodel.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>
