/usr/share/qdbm/plus/xapidoc/classqdbm_1_1ADBM.html is in libxqdbm3c2 1.8.78-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 | <!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>QDBM for C++: qdbm::ADBM 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="main.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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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="namespaceqdbm.html">qdbm</a>::<a class="el" href="classqdbm_1_1ADBM.html">ADBM</a>
</div>
</div>
<div class="contents">
<h1>qdbm::ADBM Class Reference</h1><!-- doxytag: class="qdbm::ADBM" -->
<p>Aabstraction for database managers compatible with DBM.
<a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for qdbm::ADBM:</div>
<div class="dynsection">
<div class="center">
<img src="classqdbm_1_1ADBM.png" usemap="#qdbm::ADBM_map" alt=""/>
<map id="qdbm::ADBM_map" name="qdbm::ADBM_map">
<area href="classqdbm_1_1Curia.html" alt="qdbm::Curia" shape="rect" coords="0,56,84,80"/>
<area href="classqdbm_1_1Depot.html" alt="qdbm::Depot" shape="rect" coords="94,56,178,80"/>
<area href="classqdbm_1_1Villa.html" alt="qdbm::Villa" shape="rect" coords="188,56,272,80"/>
</map>
</div>
</div>
<p><a href="classqdbm_1_1ADBM-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"><a class="anchor" id="adbc9e89a92410442f26a20b1fc415d40"></a><!-- doxytag: member="qdbm::ADBM::~ADBM" ref="adbc9e89a92410442f26a20b1fc415d40" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#adbc9e89a92410442f26a20b1fc415d40">~ADBM</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release resources of the instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#afe282ce1168c9a437b74e6f90e21db3d">close</a> ()=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the database connection. <a href="#afe282ce1168c9a437b74e6f90e21db3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#aeb819b3cf03cf0aa2924665c73b04481">storerec</a> (const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> &key, const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> &val, bool replace=true)=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Store a record. <a href="#aeb819b3cf03cf0aa2924665c73b04481"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#aacf9ce119ffd2f3da213cdffd2428ac6">deleterec</a> (const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> &key)=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a record. <a href="#aacf9ce119ffd2f3da213cdffd2428ac6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#a2ed1c91281ac685374082639369dc7b1">fetchrec</a> (const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> &key)=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch a record. <a href="#a2ed1c91281ac685374082639369dc7b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#a457f066a06a8e2c7bdcced9c3a83bc86">firstkey</a> ()=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first key. <a href="#a457f066a06a8e2c7bdcced9c3a83bc86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#ae14701fd3087fe35f6c83802cc217bec">nextkey</a> ()=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next key. <a href="#ae14701fd3087fe35f6c83802cc217bec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqdbm_1_1ADBM.html#abbd9f01defd662ef69c706b6b5d7bb54">error</a> ()=0 throw (DBM_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check whether a fatal error occured or not. <a href="#abbd9f01defd662ef69c706b6b5d7bb54"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Aabstraction for database managers compatible with DBM. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afe282ce1168c9a437b74e6f90e21db3d"></a><!-- doxytag: member="qdbm::ADBM::close" ref="afe282ce1168c9a437b74e6f90e21db3d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void qdbm::ADBM::close </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the database connection. </p>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#a4832ef51c2b16dde2d0c588c698ecb82">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#a4a236445aff6ecbff75e17c2810647d3">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a9a8998bd4e2278cd6a4175ba20216de0">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="aacf9ce119ffd2f3da213cdffd2428ac6"></a><!-- doxytag: member="qdbm::ADBM::deleterec" ref="aacf9ce119ffd2f3da213cdffd2428ac6" args="(const Datum &key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void qdbm::ADBM::deleterec </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> & </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete a 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>key</em> </td><td>reference to a key object. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs or no record corresponds. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#a76f84ca2271fda527946881a19f80374">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#a6f1a874cfc409cb2ac60449eb8d75183">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a882fa32b1717020f71887dc3755974f4">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="abbd9f01defd662ef69c706b6b5d7bb54"></a><!-- doxytag: member="qdbm::ADBM::error" ref="abbd9f01defd662ef69c706b6b5d7bb54" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool qdbm::ADBM::error </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check whether a fatal error occured or not. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the database has a fatal error, false if not. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#af7df4381a4eaefbf39ab7889eb2d49fb">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#a376c2d8ca7c30715b07b1110b4128055">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#ad47f50bc42329b5eba5ecd48ff0b7466">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="a2ed1c91281ac685374082639369dc7b1"></a><!-- doxytag: member="qdbm::ADBM::fetchrec" ref="a2ed1c91281ac685374082639369dc7b1" args="(const Datum &key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> qdbm::ADBM::fetchrec </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> & </td>
<td class="paramname"> <em>key</em></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fetch a 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>key</em> </td><td>reference to a key object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a temporary instance of the value of the corresponding record. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs or no record corresponds. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#a207e94c4a4f011c642ed61977526ece5">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#a00c7cf35fd226cb6184ccaa59c4626e7">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a802ec4bded4a2c7c82f92135dc06eaee">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="a457f066a06a8e2c7bdcced9c3a83bc86"></a><!-- doxytag: member="qdbm::ADBM::firstkey" ref="a457f066a06a8e2c7bdcced9c3a83bc86" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> qdbm::ADBM::firstkey </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the first key. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a temporary instance of the key of the first record. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs or no record corresponds. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#a7f7d67383bde2c7d41d33972ad11528a">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#acbf7fbc4afa0e971a92a503549a01ef1">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a0ae0c58823d32ce6b4d14b1ab13730dc">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="ae14701fd3087fe35f6c83802cc217bec"></a><!-- doxytag: member="qdbm::ADBM::nextkey" ref="ae14701fd3087fe35f6c83802cc217bec" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classqdbm_1_1Datum.html">Datum</a> qdbm::ADBM::nextkey </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the next key. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a temporary instance of the key of the next record. </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs or no record corresponds. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#a7b42b5340f1d3306e5a6ba5a21c9abe9">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#a1c953f0c612ea7665e5634c8b230cc62">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a3af1120e3735b90c6d81954a8b96b42e">qdbm::Villa</a>.</p>
</div>
</div>
<a class="anchor" id="aeb819b3cf03cf0aa2924665c73b04481"></a><!-- doxytag: member="qdbm::ADBM::storerec" ref="aeb819b3cf03cf0aa2924665c73b04481" args="(const Datum &key, const Datum &val, bool replace=true)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void qdbm::ADBM::storerec </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classqdbm_1_1Datum.html">Datum</a> & </td>
<td class="paramname"> <em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>replace</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw (<a class="el" href="classqdbm_1_1DBM__error.html">DBM_error</a>)<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Store a 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>key</em> </td><td>reference to a key object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>reference to a value object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>replace</em> </td><td>whether the existing value is to be overwritten or not. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classqdbm_1_1DBM__error.html" title="Error container for ADBM.">DBM_error</a></em> </td><td>if an error occurs or replace is cancelled. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classqdbm_1_1Curia.html#ac185f3f75e90a889a2e6b6756f73c620">qdbm::Curia</a>, <a class="el" href="classqdbm_1_1Depot.html#ad1c017447ccb152ca6aa3d525eb877e6">qdbm::Depot</a>, and <a class="el" href="classqdbm_1_1Villa.html#a54ce0c14d1404f6e94eb1014eaa39983">qdbm::Villa</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xadbm.h</li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Aug 5 02:15:30 2010 for QDBM for C++ 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>
|