A C++ DAL / ORM code generation framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

199 lines
17 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>WORM: src/sql/drivers/wmysqlresult.h Source File</title>
  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="search/search.js"></script>
  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10. </head>
  11. <body onload='searchBox.OnSelectItem(0);'>
  12. <!-- Generated by Doxygen 1.7.3 -->
  13. <script type="text/javascript"><!--
  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15. --></script>
  16. <script type="text/javascript">
  17. function hasClass(ele,cls) {
  18. return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
  19. }
  20. function addClass(ele,cls) {
  21. if (!this.hasClass(ele,cls)) ele.className += " "+cls;
  22. }
  23. function removeClass(ele,cls) {
  24. if (hasClass(ele,cls)) {
  25. var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
  26. ele.className=ele.className.replace(reg,' ');
  27. }
  28. }
  29. function toggleVisibility(linkObj) {
  30. var base = linkObj.getAttribute('id');
  31. var summary = document.getElementById(base + '-summary');
  32. var content = document.getElementById(base + '-content');
  33. var trigger = document.getElementById(base + '-trigger');
  34. if ( hasClass(linkObj,'closed') ) {
  35. summary.style.display = 'none';
  36. content.style.display = 'block';
  37. trigger.src = 'open.png';
  38. removeClass(linkObj,'closed');
  39. addClass(linkObj,'opened');
  40. } else if ( hasClass(linkObj,'opened') ) {
  41. summary.style.display = 'block';
  42. content.style.display = 'none';
  43. trigger.src = 'closed.png';
  44. removeClass(linkObj,'opened');
  45. addClass(linkObj,'closed');
  46. }
  47. return false;
  48. }
  49. </script>
  50. <div id="top">
  51. <div id="titlearea">
  52. <table cellspacing="0" cellpadding="0">
  53. <tbody>
  54. <tr style="height: 56px;">
  55. <td id="projectlogo"><img alt="Logo" src="worm_sm.png"></td>
  56. <td style="padding-left: 0.5em;">
  57. <div id="projectname">WORM&#160;<span id="projectnumber">0.2</span></div>
  58. <div id="projectbrief">A C++ DAL/ORM code generation framework</div>
  59. </td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. </div>
  64. <div id="navrow1" class="tabs">
  65. <ul class="tablist">
  66. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  67. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  68. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  69. <li><a href="annotated.html"><span>Classes</span></a></li>
  70. <li class="current"><a href="files.html"><span>Files</span></a></li>
  71. <li id="searchli">
  72. <div id="MSearchBox" class="MSearchBoxInactive">
  73. <span class="left">
  74. <img id="MSearchSelect" src="search/mag_sel.png"
  75. onmouseover="return searchBox.OnSearchSelectShow()"
  76. onmouseout="return searchBox.OnSearchSelectHide()"
  77. alt=""/>
  78. <input type="text" id="MSearchField" value="Search" accesskey="S"
  79. onfocus="searchBox.OnSearchFieldFocus(true)"
  80. onblur="searchBox.OnSearchFieldFocus(false)"
  81. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  82. </span><span class="right">
  83. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  84. </span>
  85. </div>
  86. </li>
  87. </ul>
  88. </div>
  89. <div id="navrow2" class="tabs2">
  90. <ul class="tablist">
  91. <li><a href="files.html"><span>File&#160;List</span></a></li>
  92. <li><a href="globals.html"><span>File&#160;Members</span></a></li>
  93. </ul>
  94. </div>
  95. <div class="header">
  96. <div class="headertitle">
  97. <h1>src/sql/drivers/wmysqlresult.h</h1> </div>
  98. </div>
  99. <div class="contents">
  100. <a href="wmysqlresult_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
  101. <a name="l00002"></a>00002 <span class="comment"> WORM - a DAL/ORM code generation framework</span>
  102. <a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2011 Erik Winn &lt;erikwinnmail@yahoo.com&gt;</span>
  103. <a name="l00004"></a>00004 <span class="comment"></span>
  104. <a name="l00005"></a>00005 <span class="comment"> This program is free software: you can redistribute it and/or modify</span>
  105. <a name="l00006"></a>00006 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
  106. <a name="l00007"></a>00007 <span class="comment"> the Free Software Foundation, either version 3 of the License, or</span>
  107. <a name="l00008"></a>00008 <span class="comment"> (at your option) any later version.</span>
  108. <a name="l00009"></a>00009 <span class="comment"></span>
  109. <a name="l00010"></a>00010 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
  110. <a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  111. <a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
  112. <a name="l00013"></a>00013 <span class="comment"> GNU General Public License for more details.</span>
  113. <a name="l00014"></a>00014 <span class="comment"></span>
  114. <a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU General Public License</span>
  115. <a name="l00016"></a>00016 <span class="comment"> along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  116. <a name="l00017"></a>00017 <span class="comment">*/</span>
  117. <a name="l00018"></a>00018
  118. <a name="l00019"></a>00019
  119. <a name="l00020"></a>00020 <span class="preprocessor">#ifndef WMYSQLRESULT_H</span>
  120. <a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define WMYSQLRESULT_H</span>
  121. <a name="l00022"></a>00022 <span class="preprocessor"></span>
  122. <a name="l00023"></a>00023 <span class="preprocessor">#include &quot;wsqlresult.h&quot;</span>
  123. <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;mysql/mysql.h&gt;</span>
  124. <a name="l00025"></a>00025
  125. <a name="l00026"></a>00026 <span class="keyword">namespace </span>WSql
  126. <a name="l00027"></a>00027 {
  127. <a name="l00028"></a>00028
  128. <a name="l00029"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html">00029</a> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_mysql_result.html" title="WMysqlResult is the type of result set used by the MySQL driver.">WMysqlResult</a> : <span class="keyword">public</span> <a class="code" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a>
  129. <a name="l00030"></a>00030 {
  130. <a name="l00031"></a>00031
  131. <a name="l00032"></a>00032 <span class="keyword">public</span>:
  132. <a name="l00033"></a>00033 <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a50819110ac6eb61a483e9c02da446c40">WMysqlResult</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_driver.html" title="The WSqlDriver class is an abstract base class for database drivers.">WSql::WSqlDriver</a>* driver );
  133. <a name="l00034"></a>00034 <span class="comment">// WMysqlResult( const WMysqlResult&amp; other );</span>
  134. <a name="l00035"></a>00035 <a class="code" href="class_w_sql_1_1_w_mysql_result.html#af0e35fb6c3832c1b213b8729243728b7">~WMysqlResult</a>();
  135. <a name="l00036"></a>00036 <span class="comment">// WMysqlResult&amp; operator=( const WMysqlResult&amp; other );</span>
  136. <a name="l00037"></a>00037 <span class="comment">// bool operator==( const WMysqlResult&amp; other ) const;</span>
  137. <a name="l00038"></a>00038
  138. <a name="l00039"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#ad91ebf6e86efb036c2b89c7e2d9ddd1a">00039</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#ad91ebf6e86efb036c2b89c7e2d9ddd1a">addRecord</a>( <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a>&amp; r ) {<a class="code" href="class_w_sql_1_1_w_sql_result.html#a9e48004ab255ca6b35f6751079a04453">_records</a>.push_back( r );}
  139. <a name="l00040"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a1927c0982530fb9650a53f9e6bf6922b">00040</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a1927c0982530fb9650a53f9e6bf6922b">setIsCached</a>( <span class="keywordtype">bool</span> b ) { <a class="code" href="class_w_sql_1_1_w_sql_result.html#a32a8ae504d12027208ac94df55bfd1ba">_isCached</a> = b; }
  140. <a name="l00041"></a>00041
  141. <a name="l00042"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#ae1328bfd5511e5014c9463ad76582bf5">00042</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#ae1328bfd5511e5014c9463ad76582bf5">isCached</a>() {<span class="keywordflow">return</span> <a class="code" href="class_w_sql_1_1_w_sql_result.html#a32a8ae504d12027208ac94df55bfd1ba">_isCached</a>; }
  142. <a name="l00043"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a4ca94061dd5335a133616456375ad1ae">00043</a> <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a4ca94061dd5335a133616456375ad1ae">size</a>()<span class="keyword">const </span>{<span class="keywordflow">return</span> <a class="code" href="class_w_sql_1_1_w_sql_result.html#a9e48004ab255ca6b35f6751079a04453">_records</a>.size(); }
  143. <a name="l00044"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a640b459e1f1f7ce41ce8253a5444f6dc">00044</a> <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a640b459e1f1f7ce41ce8253a5444f6dc">count</a>()<span class="keyword">const </span>{<span class="keywordflow">return</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a4ca94061dd5335a133616456375ad1ae">size</a>(); }
  144. <a name="l00045"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a8d2b5e4696e0f67879af0163084d20ea">00045</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a8d2b5e4696e0f67879af0163084d20ea">empty</a>()<span class="keyword">const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_w_sql_1_1_w_sql_result.html#a9e48004ab255ca6b35f6751079a04453">_records</a>.empty();}
  145. <a name="l00046"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#ac1576697c668c7a9d7337a713a1e2e20">00046</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#ac1576697c668c7a9d7337a713a1e2e20">hasOutValues</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !<a class="code" href="class_w_sql_1_1_w_mysql_result.html#a8d2b5e4696e0f67879af0163084d20ea">empty</a>();}
  146. <a name="l00047"></a>00047
  147. <a name="l00048"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a7c7050b54b185efc1865eef100e26e50">00048</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a7c7050b54b185efc1865eef100e26e50">clear</a>() { <a class="code" href="class_w_sql_1_1_w_sql_result.html#a9e48004ab255ca6b35f6751079a04453">_records</a>.clear(); }
  148. <a name="l00049"></a>00049
  149. <a name="l00050"></a>00050 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a14de39aa126582637d65c552886d3ba1">current</a>();
  150. <a name="l00051"></a>00051 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#ab104356c08e57d9d2e1ffc42be68c3e9">fetch</a>( <span class="keywordtype">int</span> i = -1 );
  151. <a name="l00052"></a>00052 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a93a6b8a5fe6bfbff2167f7f76c8dd055">fetchFirst</a>();
  152. <a name="l00053"></a>00053 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#af69abe39ea3070c1a783f7770f7577e8">fetchLast</a>();
  153. <a name="l00054"></a>00054 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a943ce4c49b571273b10383160b266042">fetchNext</a>();
  154. <a name="l00055"></a>00055 <a class="code" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#aabc47f4795a71800a641b7bcadeb9a2f">fetchPrevious</a>();
  155. <a name="l00056"></a>00056
  156. <a name="l00057"></a>00057 <span class="keyword">protected</span>:
  157. <a name="l00058"></a>00058
  158. <a name="l00059"></a>00059 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#abb55d02a0c4afca5e43e55f5fed7f330">seek</a>( <span class="keywordtype">int</span> i, <span class="keywordtype">bool</span> relative = <span class="keyword">false</span> );
  159. <a name="l00060"></a>00060 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a9f316c9663216d0d47f517c6c20ae325">next</a>();
  160. <a name="l00061"></a>00061 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a5e41321acb206f2b3fc008e9a514047d">previous</a>();
  161. <a name="l00062"></a>00062 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a6a81af38dfc9df846ec1afe1a1ec5a0f">first</a>();
  162. <a name="l00063"></a>00063 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_mysql_result.html#a14301801bf390797a1a4bd55353c47b5">last</a>();
  163. <a name="l00064"></a>00064
  164. <a name="l00065"></a>00065
  165. <a name="l00066"></a>00066 <span class="keyword">private</span>:
  166. <a name="l00067"></a><a class="code" href="class_w_sql_1_1_w_mysql_result.html#a1cc3d6f1837c9d43abb38b07c26467d8">00067</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_mysql_driver.html" title="A driver for MySQL databases.">WMysqlDriver</a>;
  167. <a name="l00068"></a>00068 <span class="keywordtype">void</span> freegetResult();
  168. <a name="l00069"></a>00069 <span class="keywordtype">void</span> setResult(MYSQL_RES *res){_mysqlResult = res;}
  169. <a name="l00070"></a>00070 MYSQL_RES * getResult(){<span class="keywordflow">return</span> _mysqlResult;};
  170. <a name="l00071"></a>00071 MYSQL_RES *_mysqlResult;
  171. <a name="l00072"></a>00072 };
  172. <a name="l00073"></a>00073
  173. <a name="l00074"></a>00074 } <span class="comment">//namespace WSql</span>
  174. <a name="l00075"></a>00075
  175. <a name="l00076"></a>00076 <span class="preprocessor">#endif // WMYSQLRESULT_H</span>
  176. </pre></div></div>
  177. </div>
  178. <!--- window showing the filter options -->
  179. <div id="MSearchSelectWindow"
  180. onmouseover="return searchBox.OnSearchSelectShow()"
  181. onmouseout="return searchBox.OnSearchSelectHide()"
  182. onkeydown="return searchBox.OnSearchSelectKey(event)">
  183. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Defines</a></div>
  184. <!-- iframe showing the search results (closed by default) -->
  185. <div id="MSearchResultsWindow">
  186. <iframe src="" frameborder="0"
  187. name="MSearchResults" id="MSearchResults">
  188. </iframe>
  189. </div>
  190. <hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:45 for WORM by&#160;
  191. <a href="http://www.doxygen.org/index.html">
  192. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
  193. </body>
  194. </html>