<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3.1"/> <title>Soprano: /builddir/build/BUILD/soprano-2.9.4/index/indexfiltermodel.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <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.9.4</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3.1 --> <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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_d65448580e9217255cc008a16a3f25d3.html">index</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">indexfiltermodel.h</div> </div> </div><!--header--> <div class="contents"> <a href="indexfiltermodel_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * This file is part of Soprano Project.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Copyright (C) 2007-2008 Sebastian Trueg <trueg@kde.org></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * This library is free software; you can redistribute it and/or</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * modify it under the terms of the GNU Library General Public</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * License as published by the Free Software Foundation; either</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * version 2 of the License, or (at your option) any later version.</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * This library is distributed in the hope that it will be useful,</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Library General Public License for more details.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU Library General Public License</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with this library; see the file COPYING.LIB. If not, write to</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef _SOPRANO_INDEX_MODEL_FILTER_H_</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"></span><span class="preprocessor">#define _SOPRANO_INDEX_MODEL_FILTER_H_</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="filtermodel_8h.html">filtermodel.h</a>"</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="soprano__export_8h.html">soprano_export.h</a>"</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>Soprano {</div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">namespace </span>Query {</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">class </span>Query;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="namespaceSoprano_1_1Index.html"> 44</a></span>  <span class="keyword">namespace </span>Index {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">class </span><a class="code" href="classSoprano_1_1Index_1_1CLuceneIndex.html" title="The CLuceneIndex provides a wrapper around a CLucene index which stores RDF statements.">CLuceneIndex</a>;</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">class </span>QueryResult;</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">class </span>IndexFilterModelPrivate;</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html"> 61</a></span>  <span class="keyword">class </span><a class="code" href="soprano__export_8h.html#a504ba79679d63bb260b784a0af09471a">SOPRANO_INDEX_EXPORT</a> <a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a> : <span class="keyword">public</span> <a class="code" href="classSoprano_1_1FilterModel.html" title="A FilterModel is a virtual model that wraps another Model.">Soprano::FilterModel</a></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a>( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a>& indexDir, <a class="code" 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.">Soprano::Model</a>* model = 0 );</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a>( <a class="code" href="classSoprano_1_1Index_1_1CLuceneIndex.html" title="The CLuceneIndex provides a wrapper around a CLucene index which stores RDF statements.">CLuceneIndex</a>* index, <a class="code" 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.">Soprano::Model</a>* model = 0 );</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  ~<a class="code" href="classSoprano_1_1Index_1_1IndexFilterModel.html" title="The IndexFilterModel provides a full text index around any Soprano Model.">IndexFilterModel</a>();</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classSoprano_1_1Index_1_1CLuceneIndex.html" title="The CLuceneIndex provides a wrapper around a CLucene index which stores RDF statements.">CLuceneIndex</a>* index() <span class="keyword">const</span>;</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> addStatement( <span class="keyword">const</span> <a class="code" href="classSoprano_1_1Statement.html" title="A Statement instance represents one RDF quadruple.">Soprano::Statement</a> &statement );</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> removeStatement( <span class="keyword">const</span> <a class="code" href="classSoprano_1_1Statement.html" title="A Statement instance represents one RDF quadruple.">Soprano::Statement</a> &statement );</div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <a class="code" href="namespaceSoprano_1_1Error.html#aef1bd25c5b6705951735e0fb5c5ff525">Soprano::Error::ErrorCode</a> removeAllStatements( <span class="keyword">const</span> <a class="code" href="classSoprano_1_1Statement.html" title="A Statement instance represents one RDF quadruple.">Soprano::Statement</a> &statement );</div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div> <div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="classSoprano_1_1QueryResultIterator.html" title="An iterator for query results.">QueryResultIterator</a> executeQuery( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a>& query, <a class="code" href="namespaceSoprano_1_1Query.html#ab568869993a9d6c452c8e5a34d5ac26c">Query::QueryLanguage</a> <a class="code" href="namespaceSoprano_1_1Vocabulary_1_1Xesam.html#a24eb968dfba3510cc343904910f0059d">language</a>, <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a>& userQueryLanguage = <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a>() ) <span class="keyword">const</span>;</div> <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div> <div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">/*</span></div> <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * Extract full text matching parts of a %query and replace them with</span></div> <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * results from an index %query.</span></div> <div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> *</span></div> <div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * \param query The query to rewrite.</span></div> <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> *</span></div> <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * \return A rewritten query stripped of all full test and regexp matching parts</span></div> <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * and replaced by results from an index query.</span></div> <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> */</span></div> <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">// Query::Query evaluateAndRewriteQuery( const Query::Query& query ) const;</span></div> <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div> <div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">void</span> setTransactionCacheSize( <span class="keywordtype">int</span> <a class="code" href="namespaceSoprano_1_1Vocabulary_1_1Xesam.html#aa264123a7a7488fa84d690eabdda737c">size</a> );</div> <div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="keywordtype">int</span> transactionCacheSize() <span class="keyword">const</span>;</div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div> <div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  <span class="keywordtype">void</span> rebuildIndex();</div> <div class="line"><a name="l00183"></a><span class="lineno"> 183</span> </div> <div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">void</span> optimizeIndex();</div> <div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordtype">void</span> addIndexOnlyPredicate( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qurl.html">QUrl</a>& <a class="code" href="namespaceSoprano_1_1Vocabulary_1_1RDF.html#a58fc26cecb8631102c8e45296d3305db">predicate</a> );</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div> <div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">void</span> setIndexOnlyPredicates( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qlist.html">QList<QUrl></a>& predicates );</div> <div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div> <div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qlist.html">QList<QUrl></a> indexOnlyPredicates() <span class="keyword">const</span>;</div> <div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div> <div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  <span class="keywordtype">void</span> addForceIndexPredicate( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qurl.html">QUrl</a>& predicate );</div> <div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div> <div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordtype">void</span> setForceIndexPredicates( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qlist.html">QList<QUrl></a>& predicates );</div> <div class="line"><a name="l00280"></a><span class="lineno"> 280</span> </div> <div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qlist.html">QList<QUrl></a> forceIndexPredicates() <span class="keyword">const</span>;</div> <div class="line"><a name="l00292"></a><span class="lineno"> 292</span> </div> <div class="line"><a name="l00310"></a><span class="lineno"> 310</span>  <span class="keyword">static</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a> encodeStringForLuceneQuery( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a>& <a class="code" href="namespaceSoprano_1_1Vocabulary_1_1RDF.html#a0e57b07dcc5317ad7925ebdb466528c0">value</a> );</div> <div class="line"><a name="l00311"></a><span class="lineno"> 311</span> </div> <div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  <span class="keyword">static</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qstring.html">QString</a> encodeUriForLuceneQuery( <span class="keyword">const</span> <a class="codeRef" doxygen="qt4.tag:/usr/share/doc/qt4/html/" href="/usr/share/doc/qt4/html/qurl.html">QUrl</a>& uri );</div> <div class="line"><a name="l00330"></a><span class="lineno"> 330</span> </div> <div class="line"><a name="l00331"></a><span class="lineno"> 331</span>  <span class="keyword">using</span> <a class="code" href="classSoprano_1_1FilterModel.html#a1994117b73985823f12cb76192fdcda1">FilterModel::addStatement</a>;</div> <div class="line"><a name="l00332"></a><span class="lineno"> 332</span>  <span class="keyword">using</span> <a class="code" href="classSoprano_1_1FilterModel.html#af6bf72a84ffb0fe92c2470eeb0eb8b4e">FilterModel::removeStatement</a>;</div> <div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  <span class="keyword">using</span> <a class="code" href="classSoprano_1_1Model.html#ad24bce8972e94eeaa15d811131204394">FilterModel::removeAllStatements</a>;</div> <div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div> <div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  IndexFilterModelPrivate* <span class="keyword">const</span> d;</div> <div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  };</div> <div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  }</div> <div class="line"><a name="l00339"></a><span class="lineno"> 339</span> }</div> <div class="line"><a name="l00340"></a><span class="lineno"> 340</span> </div> <div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3.1 </small></address> </body> </html>