<!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::IteratorBackend< T > Class Template 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_1IteratorBackend.html">Soprano::IteratorBackend< T ></a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <h1>Soprano::IteratorBackend< T > Class Template Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="Soprano::IteratorBackend" --><!-- doxytag: inherits="Soprano::Error::ErrorCache" --> <p>The actual work in a <a class="el" href="classSoprano_1_1Iterator.html" title="The basic Soprano iterator class.">Iterator</a> instance is done by an <a class="el" href="classSoprano_1_1IteratorBackend.html" title="The actual work in a Iterator instance is done by an IteratorBackend.">IteratorBackend</a>. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="iteratorbackend_8h_source.html">Soprano/IteratorBackend</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::IteratorBackend< T >:</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_1IteratorBackend__inherit__graph.png" border="0" usemap="#Soprano_1_1IteratorBackend_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="Soprano_1_1IteratorBackend_3_01T_01_4_inherit__map" id="Soprano_1_1IteratorBackend_3_01T_01_4_inherit__map"> <area shape="rect" id="node5" href="classSoprano_1_1IteratorBackend.html" title="Soprano::IteratorBackend\< BindingSet \>" alt="" coords="5,181,261,211"/><area shape="rect" id="node2" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="44,5,223,35"/><area shape="rect" id="node7" href="classSoprano_1_1QueryResultIteratorBackend.html" title="QueryResultIteratorBackend is the actual working horse behind QueryResultIterator." alt="" coords="12,261,255,291"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classSoprano_1_1IteratorBackend-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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1IteratorBackend.html#a072814b3fc8382c3ccb4da11ce8ebc3c">~IteratorBackend</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1IteratorBackend.html#a4aeac0d9b6ef74e61d45982a49a69644">next</a> ()=0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual T </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1IteratorBackend.html#a6913fdfd489c0e4e0978f59a466732f2">current</a> () const =0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1IteratorBackend.html#a019516ce69cc7e52623ec22fd4aa4a57">close</a> ()=0</td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected 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_1IteratorBackend.html#a4248a39694eccaa6007259010c57bd25">IteratorBackend</a> ()</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class T><br/> class Soprano::IteratorBackend< T ></h3> <p>The actual work in a <a class="el" href="classSoprano_1_1Iterator.html" title="The basic Soprano iterator class.">Iterator</a> instance is done by an <a class="el" href="classSoprano_1_1IteratorBackend.html" title="The actual work in a Iterator instance is done by an IteratorBackend.">IteratorBackend</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="iteratorbackend_8h_source.html#l00039">39</a> of file <a class="el" href="iteratorbackend_8h_source.html">iteratorbackend.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a072814b3fc8382c3ccb4da11ce8ebc3c"></a><!-- doxytag: member="Soprano::IteratorBackend::~IteratorBackend" ref="a072814b3fc8382c3ccb4da11ce8ebc3c" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classSoprano_1_1IteratorBackend.html">Soprano::IteratorBackend</a>< T >::~<a class="el" href="classSoprano_1_1IteratorBackend.html">IteratorBackend</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="iteratorbackend_8h_source.html#l00042">42</a> of file <a class="el" href="iteratorbackend_8h_source.html">iteratorbackend.h</a>.</p> </div> </div> <a class="anchor" id="a4248a39694eccaa6007259010c57bd25"></a><!-- doxytag: member="Soprano::IteratorBackend::IteratorBackend" ref="a4248a39694eccaa6007259010c57bd25" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classSoprano_1_1IteratorBackend.html">Soprano::IteratorBackend</a>< T >::<a class="el" href="classSoprano_1_1IteratorBackend.html">IteratorBackend</a> </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="iteratorbackend_8h_source.html#l00079">79</a> of file <a class="el" href="iteratorbackend_8h_source.html">iteratorbackend.h</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4aeac0d9b6ef74e61d45982a49a69644"></a><!-- doxytag: member="Soprano::IteratorBackend::next" ref="a4aeac0d9b6ef74e61d45982a49a69644" args="()=0" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">virtual bool <a class="el" href="classSoprano_1_1IteratorBackend.html">Soprano::IteratorBackend</a>< T >::next </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Advance to the next element in the iterator.</p> <p>Implementations of this method should reset the error by eith calling <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a65f952db676de0a6a186ea872fca18b8">clearError()</a> or <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#afd1a1eccaa2af733601eab1f019a8553">setError()</a>.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if there is another and false if the end has been reached.</dd></dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Iterator.html#a1ba632f6f015242ab9441da77d48415b">Iterator::next()</a> </dd></dl> <p>Implemented in <a class="el" href="classSoprano_1_1QueryResultIteratorBackend.html#ac5c79bbec64ff3eea6c28b4d93812aae">Soprano::QueryResultIteratorBackend</a>.</p> </div> </div> <a class="anchor" id="a6913fdfd489c0e4e0978f59a466732f2"></a><!-- doxytag: member="Soprano::IteratorBackend::current" ref="a6913fdfd489c0e4e0978f59a466732f2" args="() const =0" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">virtual T <a class="el" href="classSoprano_1_1IteratorBackend.html">Soprano::IteratorBackend</a>< T >::current </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the element the iterator currently points to.</p> <p>Implementations of this method should reset the error by eith calling <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a65f952db676de0a6a186ea872fca18b8">clearError()</a> or <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#afd1a1eccaa2af733601eab1f019a8553">setError()</a>.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>the current element.</dd></dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Iterator.html#a7060834a96aced1bba25e760474ac22e">Iterator::current()</a> </dd></dl> <p>Implemented in <a class="el" href="classSoprano_1_1QueryResultIteratorBackend.html#a04dad4d72a46f927d749c1c381c03ede">Soprano::QueryResultIteratorBackend</a>.</p> </div> </div> <a class="anchor" id="a019516ce69cc7e52623ec22fd4aa4a57"></a><!-- doxytag: member="Soprano::IteratorBackend::close" ref="a019516ce69cc7e52623ec22fd4aa4a57" args="()=0" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T> </div> <table class="memname"> <tr> <td class="memname">virtual void <a class="el" href="classSoprano_1_1IteratorBackend.html">Soprano::IteratorBackend</a>< T >::close </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Close the iterator and release any locks on 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>.</p> <p>Implementations of this method should reset the error by eith calling <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a65f952db676de0a6a186ea872fca18b8">clearError()</a> or <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#afd1a1eccaa2af733601eab1f019a8553">setError()</a>.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classSoprano_1_1Iterator.html#a623fb6440a6cfadbb560bd7738c01871">Iterator::close()</a> </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="iteratorbackend_8h_source.html">iteratorbackend.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>