<!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::StatementIterator 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.1 -->
<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 class="navigation" id="top">
<div 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 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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceSoprano.html">Soprano</a> </li>
<li><a class="el" href="classSoprano_1_1StatementIterator.html">Soprano::StatementIterator</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Soprano::StatementIterator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::StatementIterator" --><!-- doxytag: inherits="Iterator< Statement >" -->
<p>An iterator that provides a stream of Statements.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="statementiterator_8h_source.html">Soprano/StatementIterator</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::StatementIterator:</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_1StatementIterator__inherit__graph.png" border="0" usemap="#Soprano_1_1StatementIterator_inherit__map" alt="Inheritance graph"/></div>
<map name="Soprano_1_1StatementIterator_inherit__map" id="Soprano_1_1StatementIterator_inherit__map">
<area shape="rect" id="node10" href="classSoprano_1_1Client_1_1DBusStatementIterator.html" title="Interface to a DBus server statement iterator." alt="" coords="5,341,259,371"/><area shape="rect" id="node12" href="classSoprano_1_1Util_1_1SimpleStatementIterator.html" title="The most simple version of a StatementIterator simply iterates over a list of Statements." alt="" coords="283,341,528,371"/><area shape="rect" id="node2" href="classSoprano_1_1Iterator.html" title="Soprano::Iterator\< Statement \>" alt="" coords="167,181,369,211"/><area shape="rect" id="node4" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="193,5,372,35"/><area shape="rect" id="node6" href="classSoprano_1_1Iterator.html" title="The basic Soprano iterator class." alt="" coords="284,85,433,115"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classSoprano_1_1StatementIterator-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_1StatementIterator.html#aca6a294f91feb77dbacd0ca337f915f4">StatementIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#ae2b700fd3dba8c9a8a1a262a73ea0b82">StatementIterator</a> (<a class="el" href="classSoprano_1_1IteratorBackend.html">IteratorBackend</a>< <a class="el" href="classSoprano_1_1Statement.html">Statement</a> > *sti)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#ae6bbe92ea9565127807dc3b9c1d4eda6">StatementIterator</a> (const <a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> &sti)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#a0849e91a19bcf15ef50031196b5c2754">~StatementIterator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#a81c127ef6b8b8386685bc3d78f15807d">operator=</a> (const <a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1Statement.html">Statement</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#a4039049344e3c6df3d5693fdc9a3a931">allStatements</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#ada3b8bb4591cca13301360534cdce5bc">iterateSubjects</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#ad8ed2483e8686fd1ebd13fab65198e07">iteratePredicates</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#aa1a2b78a09546615f68e37628d79a8a9">iterateObjects</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1StatementIterator.html#ade5e701de737fb42deb787dfd50989fd">iterateContexts</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An iterator that provides a stream of Statements. </p>
<p>The most common use of <a class="el" href="classSoprano_1_1StatementIterator.html" title="An iterator that provides a stream of Statements.">StatementIterator</a> is through <a class="el" href="classSoprano_1_1Model.html#a7f50dc6483e0bed7830877182c7906ac">Model::listStatements()</a>.</p>
<p>Many backends do lock 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> during iteration. Thus, it is always a good idea to cache the results if they are to be used to modify the model to prevent a deadlock:</p>
<div class="fragment"><pre class="fragment"> <a class="code" href="classSoprano_1_1StatementIterator.html" title="An iterator that provides a stream of Statements.">Soprano::StatementIterator</a> it = model-><a class="code" href="classSoprano_1_1Model.html#a7f50dc6483e0bed7830877182c7906ac">listStatements</a>();
<a class="codeRef" href="qlist.html">QList<Statement></a> allStatements = it.<a class="code" href="classSoprano_1_1Iterator.html#ab8f53c8b02072c3e688ee62e5f318b46">allElements</a>();
Q_FOREACH( <a class="code" href="classSoprano_1_1Statement.html" title="A Statement instance represents one RDF quadruple.">Soprano::Statement</a> s, allStatements ) {
modifyTheModel( model, s );
}
</pre></div><p>Iterators have to be closed. This can either be achieved by deleting the iterator, finishing it (<a class="el" href="classSoprano_1_1Iterator.html#a1ba632f6f015242ab9441da77d48415b">next()</a> does return <code>false</code>), or calling <a class="el" href="classSoprano_1_1Iterator.html#a623fb6440a6cfadbb560bd7738c01871">close()</a>. Before that other operations on 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> may block.</p>
<p>Iterators are not thread-safe. Two threads using the same iterator may result in undefined behaviour and even crashes. An iterator needs to be closed by the same thread that opened it (except if the iterator contains special code to handle such a situation.)</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Be aware that iterators in <a class="el" href="namespaceSoprano.html">Soprano</a> are shared objects which means that copies of one iterator object work on the same data.</dd></dl>
<p>For further details on Soprano iterators see <a class="el" href="classSoprano_1_1Iterator.html" title="The basic Soprano iterator class.">Iterator</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Daniele Galdi <<a href="mailto:daniele.galdi@gmail.com">daniele.galdi@gmail.com</a>><br/>
Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="statementiterator_8h_source.html#l00075">75</a> of file <a class="el" href="statementiterator_8h_source.html">statementiterator.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aca6a294f91feb77dbacd0ca337f915f4"></a><!-- doxytag: member="Soprano::StatementIterator::StatementIterator" ref="aca6a294f91feb77dbacd0ca337f915f4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::StatementIterator::StatementIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates and empty, invalid iterator. </p>
</div>
</div>
<a class="anchor" id="ae2b700fd3dba8c9a8a1a262a73ea0b82"></a><!-- doxytag: member="Soprano::StatementIterator::StatementIterator" ref="ae2b700fd3dba8c9a8a1a262a73ea0b82" args="(IteratorBackend< Statement > *sti)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::StatementIterator::StatementIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSoprano_1_1IteratorBackend.html">IteratorBackend</a>< <a class="el" href="classSoprano_1_1Statement.html">Statement</a> > * </td>
<td class="paramname"> <em>sti</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classSoprano_1_1StatementIterator.html" title="An iterator that provides a stream of Statements.">StatementIterator</a> instance that uses sti as backend. <a class="el" href="classSoprano_1_1StatementIterator.html" title="An iterator that provides a stream of Statements.">StatementIterator</a> will take ownership of the backend. </p>
</div>
</div>
<a class="anchor" id="ae6bbe92ea9565127807dc3b9c1d4eda6"></a><!-- doxytag: member="Soprano::StatementIterator::StatementIterator" ref="ae6bbe92ea9565127807dc3b9c1d4eda6" args="(const StatementIterator &sti)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::StatementIterator::StatementIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> & </td>
<td class="paramname"> <em>sti</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0849e91a19bcf15ef50031196b5c2754"></a><!-- doxytag: member="Soprano::StatementIterator::~StatementIterator" ref="a0849e91a19bcf15ef50031196b5c2754" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Soprano::StatementIterator::~StatementIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a81c127ef6b8b8386685bc3d78f15807d"></a><!-- doxytag: member="Soprano::StatementIterator::operator=" ref="a81c127ef6b8b8386685bc3d78f15807d" args="(const StatementIterator &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a>& Soprano::StatementIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSoprano_1_1StatementIterator.html">StatementIterator</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4039049344e3c6df3d5693fdc9a3a931"></a><!-- doxytag: member="Soprano::StatementIterator::allStatements" ref="a4039049344e3c6df3d5693fdc9a3a931" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qlist.html">QList</a><<a class="el" href="classSoprano_1_1Statement.html">Statement</a>> Soprano::StatementIterator::allStatements </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method which extracts all statements (this does not include the statements that have already been read from the iterator) from the iterator and returns them in a list.</p>
<p>Be aware that after calling this method the iterator will be invalid.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of all statements that rest in the iterator. </dd></dl>
<p>Definition at line <a class="el" href="statementiterator_8h_source.html#l00104">104</a> of file <a class="el" href="statementiterator_8h_source.html">statementiterator.h</a>.</p>
</div>
</div>
<a class="anchor" id="ada3b8bb4591cca13301360534cdce5bc"></a><!-- doxytag: member="Soprano::StatementIterator::iterateSubjects" ref="ada3b8bb4591cca13301360534cdce5bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> Soprano::StatementIterator::iterateSubjects </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method that creates an iterator over the subject nodes of the statements in this iterator.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The new iterator is just a wrapper around this one. Thus, changing it will also change this one.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A wrapper iterator over the subject nodes. </dd></dl>
</div>
</div>
<a class="anchor" id="ad8ed2483e8686fd1ebd13fab65198e07"></a><!-- doxytag: member="Soprano::StatementIterator::iteratePredicates" ref="ad8ed2483e8686fd1ebd13fab65198e07" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> Soprano::StatementIterator::iteratePredicates </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method that creates an iterator over the predicate nodes of the statements in this iterator.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The new iterator is just a wrapper around this one. Thus, changing it will also change this one.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A wrapper iterator over the predicate nodes. </dd></dl>
</div>
</div>
<a class="anchor" id="aa1a2b78a09546615f68e37628d79a8a9"></a><!-- doxytag: member="Soprano::StatementIterator::iterateObjects" ref="aa1a2b78a09546615f68e37628d79a8a9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> Soprano::StatementIterator::iterateObjects </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method that creates an iterator over the object nodes of the statements in this iterator.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The new iterator is just a wrapper around this one. Thus, changing it will also change this one.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A wrapper iterator over the object nodes. </dd></dl>
</div>
</div>
<a class="anchor" id="ade5e701de737fb42deb787dfd50989fd"></a><!-- doxytag: member="Soprano::StatementIterator::iterateContexts" ref="ade5e701de737fb42deb787dfd50989fd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1NodeIterator.html">NodeIterator</a> Soprano::StatementIterator::iterateContexts </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience method that creates an iterator over the context nodes of the statements in this iterator.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The new iterator is just a wrapper around this one. Thus, changing it will also change this one.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A wrapper iterator over the context nodes. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builddir/build/BUILD/soprano-2.5.2/soprano/<a class="el" href="statementiterator_8h_source.html">statementiterator.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Oct 21 2010 for Soprano by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
x86_64
>
media
>
updates
>
by-pkgid
>
fc669c0115c2f74e1d26807f2cb98f7a
>
files
>
233
