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.

204 lines
20 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/wsqlfield.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/wsqlfield.h</h1> </div>
  98. </div>
  99. <div class="contents">
  100. <a href="wsqlfield_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 <span class="preprocessor">#ifndef WSQLFIELD_H</span>
  119. <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define WSQLFIELD_H</span>
  120. <a name="l00021"></a>00021 <span class="preprocessor"></span>
  121. <a name="l00022"></a>00022 <span class="preprocessor">#include &lt;string&gt;</span>
  122. <a name="l00023"></a>00023 <span class="preprocessor">#include &quot;<a class="code" href="wsqldatum_8h.html">wsqldatum.h</a>&quot;</span>
  123. <a name="l00024"></a>00024 <span class="preprocessor">#include &quot;<a class="code" href="wsqldatatype_8h.html">wsqldatatype.h</a>&quot;</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_sql_field.html">00029</a> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a>
  129. <a name="l00030"></a>00030 {
  130. <a name="l00031"></a>00031 <span class="keyword">public</span>:
  131. <a name="l00032"></a>00032
  132. <a name="l00033"></a>00033 <a class="code" href="class_w_sql_1_1_w_sql_field.html#a0dd42e00ccb9869989b1bda585c85d3f">WSqlField</a>();
  133. <a name="l00034"></a>00034 <a class="code" href="class_w_sql_1_1_w_sql_field.html#a0dd42e00ccb9869989b1bda585c85d3f">WSqlField</a>(<span class="keyword">const</span> std::string&amp; fieldName, <span class="keyword">const</span> std::string&amp; <a class="code" href="class_w_sql_1_1_w_sql_field.html#a9d7961be812bf9aedd031abbd0126a62" title="Returns the name of the column as defined in the database..">columnName</a>=std::string());
  134. <a name="l00035"></a>00035 <span class="comment">/* WSqlField( const std::string&amp; columnName = std::string(),</span>
  135. <a name="l00036"></a>00036 <span class="comment"> WSqlDataType::Type typeflag = WSqlDataType::NOTYPE );*/</span>
  136. <a name="l00037"></a>00037
  137. <a name="l00038"></a>00038 <a class="code" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a>&amp; <a class="code" href="class_w_sql_1_1_w_sql_field.html#a6d13d952f74c177f24d96a23c7889688">operator=</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a>&amp; other );
  138. <a name="l00039"></a>00039 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a9aeafd8ad1f6b26ae9f19d559c5a9788">operator==</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a>&amp; other ) <span class="keyword">const</span>;
  139. <a name="l00040"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#acb49c435cad44cc3e0b6c95d44c72fc7">00040</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#acb49c435cad44cc3e0b6c95d44c72fc7">operator!=</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a> &amp;other )<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !<a class="code" href="class_w_sql_1_1_w_sql_field.html#a9aeafd8ad1f6b26ae9f19d559c5a9788">operator==</a>( other ); }
  140. <a name="l00041"></a>00041 <a class="code" href="class_w_sql_1_1_w_sql_field.html#a38ff89e6025ddf2807e59f852710be50">~WSqlField</a>();
  141. <a name="l00042"></a>00042
  142. <a name="l00043"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a811c3e5bc9c0dad605d1bbfc1856e495">00043</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a811c3e5bc9c0dad605d1bbfc1856e495" title="Functions for setting the value of the data.">setData</a>( std::string s ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;std::string&gt;( s );}
  143. <a name="l00044"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a3434bacc1437c15fc4148e55c6bec47c">00044</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a3434bacc1437c15fc4148e55c6bec47c">setData</a>( <span class="keywordtype">short</span> sh ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;<span class="keywordtype">short</span>&gt;( sh );}
  144. <a name="l00045"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#aecea0803b54fcc83056b19a5a5af40e5">00045</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#aecea0803b54fcc83056b19a5a5af40e5">setData</a>( <span class="keywordtype">int</span> i ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;<span class="keywordtype">int</span>&gt;( i );}
  145. <a name="l00046"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a7911192da632f9a8577395d9d11ef4d3">00046</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a7911192da632f9a8577395d9d11ef4d3">setData</a>( <span class="keywordtype">long</span> l ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;<span class="keywordtype">long</span>&gt;( l );}
  146. <a name="l00047"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a4108c7b4e2f9ec53b6cf46ab1ad00f99">00047</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a4108c7b4e2f9ec53b6cf46ab1ad00f99">setData</a>( <span class="keywordtype">float</span> f ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;<span class="keywordtype">float</span>&gt;( f );}
  147. <a name="l00048"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a5b41e4e3cfbd6f83f85da93a29535921">00048</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a5b41e4e3cfbd6f83f85da93a29535921">setData</a>( <span class="keywordtype">double</span> d ) { _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>&lt;<span class="keywordtype">double</span>&gt;( d );}
  148. <a name="l00049"></a>00049
  149. <a name="l00050"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a3f48248a0281a2beb96cecde18185bd1">00050</a> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; T <a class="code" href="class_w_sql_1_1_w_sql_field.html#a3f48248a0281a2beb96cecde18185bd1">data</a>()
  150. <a name="l00051"></a>00051 {
  151. <a name="l00052"></a>00052 <span class="keywordflow">return</span> _data.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a11b3692a26f55c315157593158956093">data</a>&lt;T&gt;();
  152. <a name="l00053"></a>00053 };
  153. <a name="l00054"></a>00054
  154. <a name="l00055"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#aff27cae280caaa89b30a1666fbc5d770">00055</a> <span class="keyword">inline</span> <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a>&amp; <a class="code" href="class_w_sql_1_1_w_sql_field.html#aff27cae280caaa89b30a1666fbc5d770">rawDatum</a>() {<span class="keywordflow">return</span> _data;}
  155. <a name="l00056"></a>00056
  156. <a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a2a6d7066f692882849c81b10aa9eba08">clear</a>();
  157. <a name="l00058"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#ac0966bdbf13441434dd307baa2673194">00058</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#ac0966bdbf13441434dd307baa2673194">setName</a>( <span class="keyword">const</span> std::string&amp; fname ) {_name = fname;}
  158. <a name="l00059"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#ac0d7a9fa06ff09cacdac9cd1a8c11109">00059</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#ac0d7a9fa06ff09cacdac9cd1a8c11109">setColumnName</a>( <span class="keyword">const</span> std::string&amp; cname ) {_columnName = cname;}
  159. <a name="l00060"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a37da6850bd578aafbf5b4e4cb7f059af">00060</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a37da6850bd578aafbf5b4e4cb7f059af">setIsDirty</a>( <span class="keywordtype">bool</span> b ) { _isDirty = b;}
  160. <a name="l00061"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a75ffb62cf646cae4e90b0226052c1d5a">00061</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a75ffb62cf646cae4e90b0226052c1d5a">setPrecision</a>( <span class="keywordtype">int</span> i ) {_precision = i;}
  161. <a name="l00062"></a>00062
  162. <a name="l00063"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a82c823aaaca531dd3ba39c4308d2ab1e">00063</a> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a82c823aaaca531dd3ba39c4308d2ab1e">isDirty</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> _isDirty;}
  163. <a name="l00064"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a953649f01aad00a111f5879295aa07b8">00064</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string&amp; <a class="code" href="class_w_sql_1_1_w_sql_field.html#a953649f01aad00a111f5879295aa07b8" title="Returns the name of the field in the record.">name</a>()<span class="keyword">const </span>{<span class="keywordflow">return</span> _name;};
  164. <a name="l00065"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a9d7961be812bf9aedd031abbd0126a62">00065</a> <span class="keyword">inline</span> <span class="keyword">const</span> std::string&amp; <a class="code" href="class_w_sql_1_1_w_sql_field.html#a9d7961be812bf9aedd031abbd0126a62" title="Returns the name of the column as defined in the database..">columnName</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> _columnName;};
  165. <a name="l00066"></a><a class="code" href="class_w_sql_1_1_w_sql_field.html#a445c702691d6b8f3be5d146b914986e3">00066</a> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_sql_field.html#a445c702691d6b8f3be5d146b914986e3">precision</a>()<span class="keyword">const </span>{<span class="keywordflow">return</span> _precision;}
  166. <a name="l00067"></a>00067
  167. <a name="l00068"></a>00068 <span class="keyword">private</span>:
  168. <a name="l00069"></a>00069 <span class="keywordtype">int</span> _precision;
  169. <a name="l00070"></a>00070 <span class="keywordtype">bool</span> _isDirty;
  170. <a name="l00071"></a>00071 std::string _columnName;
  171. <a name="l00072"></a>00072 std::string _name;
  172. <a name="l00073"></a>00073 <a class="code" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a> _data;
  173. <a name="l00075"></a>00075 <span class="comment">// the real question is whether to stay light or subclass WSqlColumn??</span>
  174. <a name="l00076"></a>00076
  175. <a name="l00077"></a>00077 };
  176. <a name="l00078"></a>00078
  177. <a name="l00079"></a>00079 } <span class="comment">//namespace WSql</span>
  178. <a name="l00080"></a>00080
  179. <a name="l00081"></a>00081
  180. <a name="l00082"></a>00082 <span class="preprocessor">#endif // WSQLFIELD_H</span>
  181. </pre></div></div>
  182. </div>
  183. <!--- window showing the filter options -->
  184. <div id="MSearchSelectWindow"
  185. onmouseover="return searchBox.OnSearchSelectShow()"
  186. onmouseout="return searchBox.OnSearchSelectHide()"
  187. onkeydown="return searchBox.OnSearchSelectKey(event)">
  188. <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>
  189. <!-- iframe showing the search results (closed by default) -->
  190. <div id="MSearchResultsWindow">
  191. <iframe src="" frameborder="0"
  192. name="MSearchResults" id="MSearchResults">
  193. </iframe>
  194. </div>
  195. <hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:45 for WORM by&#160;
  196. <a href="http://www.doxygen.org/index.html">
  197. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
  198. </body>
  199. </html>