<!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>Kyoto Cabinet: kyotocabinet::PolyDB::Cursor 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.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</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="tabs"> <ul> <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"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1PolyDB.html">PolyDB</a>::<a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html">Cursor</a> </div> </div> <div class="contents"> <h1>kyotocabinet::PolyDB::Cursor Class Reference</h1><!-- doxytag: class="kyotocabinet::PolyDB::Cursor" --><!-- doxytag: inherits="kyotocabinet::BasicDB::Cursor" --> <p><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. <a href="#_details">More...</a></p> <p><code>#include <kcpolydb.h></code></p> <p><a href="classkyotocabinet_1_1PolyDB_1_1Cursor-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a37c6ba8b79d5b3d121cdb57586062234">Cursor</a> (<a class="el" href="classkyotocabinet_1_1PolyDB.html">PolyDB</a> *db)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a37c6ba8b79d5b3d121cdb57586062234"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#af937f24b8e80a33a5766f82cf4711aff">~Cursor</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#af937f24b8e80a33a5766f82cf4711aff"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#af6b39a3fef57170ddd67f32073406878">accept</a> (<a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> *visitor, bool writable=true, bool step=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a visitor to the current record. <a href="#af6b39a3fef57170ddd67f32073406878"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a118a79dd4d4e89cf146cfb14907f60ec">jump</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the first record for forward scan. <a href="#a118a79dd4d4e89cf146cfb14907f60ec"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a169e9d0c536fe894f980be8aaf6ffe41">jump</a> (const char *kbuf, size_t ksiz)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for forward scan. <a href="#a169e9d0c536fe894f980be8aaf6ffe41"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a68d2a137e3119605ec11c42f1e54b19f">jump</a> (const std::string &key)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for forward scan. <a href="#a68d2a137e3119605ec11c42f1e54b19f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#aa3952d6531123faf14555c0b7d6f00df">jump_back</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the last record for backward scan. <a href="#aa3952d6531123faf14555c0b7d6f00df"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a0af9b7a86df7cb095816118e18365d7f">jump_back</a> (const char *kbuf, size_t ksiz)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for backward scan. <a href="#a0af9b7a86df7cb095816118e18365d7f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#af4d7755d11f0210ee7c0f747868dec65">jump_back</a> (const std::string &key)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for backward scan. <a href="#af4d7755d11f0210ee7c0f747868dec65"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a1ee17261d64b6833d6c6f8c1bb56cbd5">step</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the next record. <a href="#a1ee17261d64b6833d6c6f8c1bb56cbd5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#ae157c64d32a9d271cc8f3211d0410abf">step_back</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the previous record. <a href="#ae157c64d32a9d271cc8f3211d0410abf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classkyotocabinet_1_1PolyDB.html">PolyDB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a9adb3e84f317deba37effc1ddc6bf9fd">db</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the database object. <a href="#a9adb3e84f317deba37effc1ddc6bf9fd"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36e52300aa1e5b9f1adee4fd06024a0c"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::PolyDB" ref="a36e52300aa1e5b9f1adee4fd06024a0c" args="" --> class </td><td class="memItemRight" valign="bottom"><b>PolyDB</b></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html" title="Cursor to indicate a record.">Cursor</a> to indicate a record. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a37c6ba8b79d5b3d121cdb57586062234"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::Cursor" ref="a37c6ba8b79d5b3d121cdb57586062234" args="(PolyDB *db)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">kyotocabinet::PolyDB::Cursor::Cursor </td> <td>(</td> <td class="paramtype"><a class="el" href="classkyotocabinet_1_1PolyDB.html">PolyDB</a> * </td> <td class="paramname"> <em>db</em></td> <td> ) </td> <td><code> [explicit]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>the container database object. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="af937f24b8e80a33a5766f82cf4711aff"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::~Cursor" ref="af937f24b8e80a33a5766f82cf4711aff" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual kyotocabinet::PolyDB::Cursor::~Cursor </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> <p>Reimplemented from <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Cursor.html#a0e93160f1599c0063b6db4226216cfb3">kyotocabinet::BasicDB::Cursor</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="af6b39a3fef57170ddd67f32073406878"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::accept" ref="af6b39a3fef57170ddd67f32073406878" args="(Visitor *visitor, bool writable=true, bool step=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::accept </td> <td>(</td> <td class="paramtype"><a class="el" href="classkyotocabinet_1_1DB_1_1Visitor.html">Visitor</a> * </td> <td class="paramname"> <em>visitor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>writable</em> = <code>true</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>step</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Accept a visitor to the current record. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>visitor</em> </td><td>a visitor object. </td></tr> <tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr> <tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>The operation for each record is performed atomically and other threads accessing the same record are blocked. To avoid deadlock, any database operation must not be performed in this function. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#af19b3472aeec03686a074dae416c8ed3">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a118a79dd4d4e89cf146cfb14907f60ec"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump" ref="a118a79dd4d4e89cf146cfb14907f60ec" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to the first record for forward scan. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a9b7e9982b948d66a4d2a0295229ac4c1">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a169e9d0c536fe894f980be8aaf6ffe41"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump" ref="a169e9d0c536fe894f980be8aaf6ffe41" args="(const char *kbuf, size_t ksiz)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>kbuf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>ksiz</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to a record for forward scan. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr> <tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#af5ce800de2275a5e912265fd9afc896d">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a68d2a137e3119605ec11c42f1e54b19f"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump" ref="a68d2a137e3119605ec11c42f1e54b19f" args="(const std::string &key)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>key</em></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to a record for forward scan. </p> <dl class="note"><dt><b>Note:</b></dt><dd>Equal to the original <a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#a118a79dd4d4e89cf146cfb14907f60ec" title="Jump the cursor to the first record for forward scan.">Cursor::jump</a> method except that the parameter is std::string. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a3b38a11631f37d104209e5feade154b4">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="aa3952d6531123faf14555c0b7d6f00df"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump_back" ref="aa3952d6531123faf14555c0b7d6f00df" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump_back </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to the last record for backward scan. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, may provide a dummy implementation. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a65452f182db3cd688885c460a761fa9c">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a0af9b7a86df7cb095816118e18365d7f"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump_back" ref="a0af9b7a86df7cb095816118e18365d7f" args="(const char *kbuf, size_t ksiz)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump_back </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>kbuf</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>ksiz</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to a record for backward scan. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr> <tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, will provide a dummy implementation. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a4456015ac4c0248aebcabb03e195e860">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="af4d7755d11f0210ee7c0f747868dec65"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::jump_back" ref="af4d7755d11f0210ee7c0f747868dec65" args="(const std::string &key)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::jump_back </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>key</em></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Jump the cursor to a record for backward scan. </p> <dl class="note"><dt><b>Note:</b></dt><dd>Equal to the original <a class="el" href="classkyotocabinet_1_1PolyDB_1_1Cursor.html#aa3952d6531123faf14555c0b7d6f00df" title="Jump the cursor to the last record for backward scan.">Cursor::jump_back</a> method except that the parameter is std::string. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a9d392717ad801064a36220a91f907c1d">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a1ee17261d64b6833d6c6f8c1bb56cbd5"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::step" ref="a1ee17261d64b6833d6c6f8c1bb56cbd5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::step </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Step the cursor to the next record. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a312228bd858d3091e32b65f1128faab4">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="ae157c64d32a9d271cc8f3211d0410abf"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::step_back" ref="ae157c64d32a9d271cc8f3211d0410abf" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool kyotocabinet::PolyDB::Cursor::step_back </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Step the cursor to the previous record. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl> <dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, may provide a dummy implementation. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1DB_1_1Cursor.html#a1eb720a41b9bad81f3dd6621870133d5">kyotocabinet::DB::Cursor</a>.</p> </div> </div> <a class="anchor" id="a9adb3e84f317deba37effc1ddc6bf9fd"></a><!-- doxytag: member="kyotocabinet::PolyDB::Cursor::db" ref="a9adb3e84f317deba37effc1ddc6bf9fd" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classkyotocabinet_1_1PolyDB.html">PolyDB</a>* kyotocabinet::PolyDB::Cursor::db </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the database object. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>the database object. </dd></dl> <p>Implements <a class="el" href="classkyotocabinet_1_1BasicDB_1_1Cursor.html#a79e3904e5b10ed3d356545ed4259160e">kyotocabinet::BasicDB::Cursor</a>.</p> </div> </div> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>