<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en" xml:lang="en">
<head>
<title>Soprano.StatementIterator</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.4 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>StatementIterator Class Reference</h1>
<code>from PyKDE4.soprano import *</code>
<p>
Subclasses: <a href="../soprano/Soprano.Client.DBusStatementIterator.html">Soprano.Client.DBusStatementIterator</a>, <a href="../soprano/Soprano.Util.SimpleStatementIterator.html">Soprano.Util.SimpleStatementIterator</a><br />
Namespace: Soprano.StatementIterator<br />
<h2>Detailed Description</h2>
<p>\class StatementIterator statementiterator.h Soprano/StatementIterator
</p>
<p>
An iterator that provides a stream of Statements.
</p>
<p>
The most common use of StatementIterator is through Model.listStatements().
</p>
<p>
Many backends do lock the underlying Model 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>
<p>
<pre class="fragment">
Soprano.StatementIterator it = model->listStatements();
QList<Statement> allStatements = it.allElements();
Q_FOREACH( Soprano.Statement s, allStatements ) {
modifyTheModel( model, s );
}
</pre>
</p>
<p>
Iterators have to be closed.
This can either be achieved by deleting the iterator, finishing it (next() does return <b>false),</b>
or calling close(). Before that other operations on the Model 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>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> Be aware that iterators in Soprano are shared objects which means
that copies of one iterator object work on the same data.
</dd></dl> </p>
<p>
For further details on %Soprano iterators see Iterator.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Daniele Galdi <daniele.galdi@gmail.com><br>Sebastian Trueg <trueg@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#StatementIterator">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#StatementIterator">__init__</a> (self, <a href="../soprano/Soprano.StatementIterator.html">Soprano.StatementIterator</a> sti)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../soprano/Soprano.Statement.html">Soprano.Statement</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#allElements">allElements</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../soprano/Soprano.Statement.html">Soprano.Statement</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#allStatements">allStatements</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#close">close</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.Statement.html">Soprano.Statement</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#current">current</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isValid">isValid</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#iterateContexts">iterateContexts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#iterateObjects">iterateObjects</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#iteratePredicates">iteratePredicates</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#iterateSubjects">iterateSubjects</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#next">next</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="StatementIterator"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Creates and empty, invalid iterator.
</p></div></div><a class="anchor" name="StatementIterator"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../soprano/Soprano.StatementIterator.html">Soprano.StatementIterator</a> </td>
<td class="paramname"><em>sti</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a new StatementIterator instance that uses sti as backend.
StatementIterator will take ownership of the backend.
</p></div></div><a class="anchor" name="allElements"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../soprano/Soprano.Statement.html">Soprano.Statement</a>] allElements</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="allStatements"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../soprano/Soprano.Statement.html">Soprano.Statement</a>] allStatements</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </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>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A list of all statements that rest in the iterator.
</dd></dl>
</p></div></div><a class="anchor" name="close"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> close</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="current"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.Statement.html">Soprano.Statement</a> current</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="isValid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isValid</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="iterateContexts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> iterateContexts</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </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>
<p>
<dl class="warning" compact><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> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A wrapper iterator over the context nodes.
</dd></dl>
</p></div></div><a class="anchor" name="iterateObjects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> iterateObjects</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </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>
<p>
<dl class="warning" compact><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> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A wrapper iterator over the object nodes.
</dd></dl>
</p></div></div><a class="anchor" name="iteratePredicates"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> iteratePredicates</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </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>
<p>
<dl class="warning" compact><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> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A wrapper iterator over the predicate nodes.
</dd></dl>
</p></div></div><a class="anchor" name="iterateSubjects"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.NodeIterator.html">Soprano.NodeIterator</a> iterateSubjects</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </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>
<p>
<dl class="warning" compact><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> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A wrapper iterator over the subject nodes.
</dd></dl>
</p></div></div><a class="anchor" name="next"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool next</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
1178
