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.

212 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/wsqlcolumn.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/wsqlcolumn.h</h1> </div>
  98. </div>
  99. <div class="contents">
  100. <a href="wsqlcolumn_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 WSQLCOLUMN_H</span>
  120. <a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define WSQLCOLUMN_H</span>
  121. <a name="l00022"></a>00022 <span class="preprocessor"></span>
  122. <a name="l00023"></a>00023
  123. <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;string&gt;</span>
  124. <a name="l00025"></a>00025
  125. <a name="l00026"></a>00026 <span class="preprocessor">#include &quot;<a class="code" href="wsqldatatype_8h.html">wsqldatatype.h</a>&quot;</span>
  126. <a name="l00027"></a>00027 <span class="preprocessor">#include &quot;<a class="code" href="wsqldatum_8h.html">wsqldatum.h</a>&quot;</span>
  127. <a name="l00028"></a>00028
  128. <a name="l00029"></a>00029 <span class="keyword">namespace </span>WSql{
  129. <a name="l00030"></a>00030
  130. <a name="l00031"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html">00031</a> <span class="keyword">class </span><a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a>
  131. <a name="l00032"></a>00032 {
  132. <a name="l00033"></a>00033
  133. <a name="l00034"></a>00034 <span class="keyword">public</span>:
  134. <a name="l00035"></a>00035 <a class="code" href="class_w_sql_1_1_w_sql_column.html#a8bc78eb4f65d120862a0324ab42c0918">WSqlColumn</a>();
  135. <a name="l00036"></a>00036 <a class="code" href="class_w_sql_1_1_w_sql_column.html#a8bc78eb4f65d120862a0324ab42c0918">WSqlColumn</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a>&amp; other );
  136. <a name="l00037"></a>00037 <span class="keyword">virtual</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a174692b6631e4acaf3cab5847640d622">~WSqlColumn</a>();
  137. <a name="l00038"></a>00038 <span class="keyword">virtual</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a>&amp; <a class="code" href="class_w_sql_1_1_w_sql_column.html#a68ef13cc4d81ef4dc21ff6575bfc1cfe">operator=</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a>&amp; other );
  138. <a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a8e7eeb7567c681d0a489b6c2210866f6">operator==</a>( <span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a>&amp; other ) <span class="keyword">const</span>;
  139. <a name="l00040"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#ad1e9aad637dddc3a870a3f116e0f6bd5">00040</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#ad1e9aad637dddc3a870a3f116e0f6bd5">operator!=</a>(<span class="keyword">const</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html" title="The WSqlColumn class represents a column in SQL database tables.">WSqlColumn</a> &amp;other)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !<a class="code" href="class_w_sql_1_1_w_sql_column.html#a8e7eeb7567c681d0a489b6c2210866f6">operator==</a>(other); }
  140. <a name="l00041"></a>00041
  141. <a name="l00042"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#acae42155de47b43556d3a34b66fc0c5e">00042</a> <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#acae42155de47b43556d3a34b66fc0c5e">setDefaultValue</a>( <span class="keyword">const</span> T t)
  142. <a name="l00043"></a>00043 {
  143. <a name="l00044"></a>00044 _default.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a0ce4bb3b7cfde0bd437a4943a36701f8">setData</a>(t);
  144. <a name="l00045"></a>00045 };
  145. <a name="l00046"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a55feefa5aa00a43a8c8e09a517414047">00046</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_column.html#a55feefa5aa00a43a8c8e09a517414047">defaultValue</a>()
  146. <a name="l00047"></a>00047 {
  147. <a name="l00048"></a>00048 <span class="keywordflow">return</span> _default.<a class="code" href="class_w_sql_1_1_w_sql_datum.html#a11b3692a26f55c315157593158956093">data</a>&lt;T&gt;();
  148. <a name="l00049"></a>00049 };
  149. <a name="l00050"></a>00050
  150. <a name="l00051"></a>00051 <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a9920af02af124b3966b5f2963cd8c2d5" title="Manually set the variableName to name.">setVariableName</a>( <span class="keyword">const</span> std::string&amp; name );
  151. <a name="l00052"></a>00052 <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#afbfa7bbade6aa3ea53603181edc07a82" title="Set the column name to be name.">setColumnName</a>( <span class="keyword">const</span> std::string&amp; name );
  152. <a name="l00053"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#adfcb9b152b86486d17a68e32b6a50432">00053</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#adfcb9b152b86486d17a68e32b6a50432">setMaxLength</a>( <span class="keywordtype">int</span> length ){_maxLength=length;}
  153. <a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a1c346bc7c3fff1c4733deb8b1a400aa5">setPrecision</a>( <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a1cdfad0f1e895e3e6a2b8e1d4e65e84d">precision</a> );
  154. <a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a58d480ea870d66ed50bb09549d321ced">setDataType</a>( <a class="code" href="namespace_w_sql_1_1_w_sql_data_type.html#aa234580d74e3dfc10946a4ec8e317d11">WSqlDataType::Type</a> <a class="code" href="class_w_sql_1_1_w_sql_column.html#ab95bd2f84a51643a608da0e1703cbeae">type</a> );
  155. <a name="l00056"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#aa38b0ccd41135ce10147399d5c5325ec">00056</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#aa38b0ccd41135ce10147399d5c5325ec">setIsAutoIncremented</a>( <span class="keywordtype">bool</span> b ) { _isAutoIncremented = b; }
  156. <a name="l00057"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a857bf7ce5608016c8c3f9f1a04c8c933">00057</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a857bf7ce5608016c8c3f9f1a04c8c933">setCanBeNull</a>( <span class="keywordtype">bool</span> b ) {_canBeNull = b;}
  157. <a name="l00058"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a46599c4e7abaeef9537785b2740a377d">00058</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a46599c4e7abaeef9537785b2740a377d">setIsPrimaryKey</a>( <span class="keywordtype">bool</span> b ) {_isPrimaryKey = b;}
  158. <a name="l00059"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a38c243bff56c7187f9cc13354d6d3735">00059</a> <span class="keywordtype">void</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a38c243bff56c7187f9cc13354d6d3735">setIsUnsigned</a>(<span class="keywordtype">bool</span> b){_isUnsigned=b;}
  159. <a name="l00060"></a>00060
  160. <a name="l00061"></a>00061 <span class="keyword">const</span> std::string&amp; <a class="code" href="class_w_sql_1_1_w_sql_column.html#a44843e71b5805c2287e00df46185eb71">columnName</a>() <span class="keyword">const</span>;
  161. <a name="l00062"></a>00062 <span class="keyword">const</span> std::string&amp; <a class="code" href="class_w_sql_1_1_w_sql_column.html#afab2d8547585c99c4dfefaa8200e0381">variableName</a>() <span class="keyword">const</span>;
  162. <a name="l00063"></a>00063 std::string <a class="code" href="class_w_sql_1_1_w_sql_column.html#afb004b76eddb9fb177082d216211497d" title="Returns a C++ type declaration This method returns a string suitable for a type declaration of a vari...">typeDeclaration</a>()<span class="keyword">const</span>;
  163. <a name="l00064"></a>00064 <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a46eac3f4c5a14bf24bbac67a02787b8b">maxLength</a>() <span class="keyword">const</span>;
  164. <a name="l00065"></a>00065 <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a1cdfad0f1e895e3e6a2b8e1d4e65e84d">precision</a>() <span class="keyword">const</span>;
  165. <a name="l00066"></a>00066 <span class="keyword">const</span> <a class="code" href="namespace_w_sql_1_1_w_sql_data_type.html#aa234580d74e3dfc10946a4ec8e317d11">WSqlDataType::Type</a> <a class="code" href="class_w_sql_1_1_w_sql_column.html#ab95bd2f84a51643a608da0e1703cbeae">type</a>() <span class="keyword">const</span>;
  166. <a name="l00067"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#aa1554dddff2918b50300794905f3edbc">00067</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#aa1554dddff2918b50300794905f3edbc">isAutoIncremented</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> _isAutoIncremented; }
  167. <a name="l00068"></a>00068 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a8d6cb49198c3215c1b8542ba9ea0f16b">canBeNull</a>() <span class="keyword">const</span>;
  168. <a name="l00069"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a550d941195f306da2e2df25bbd08dee6">00069</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a550d941195f306da2e2df25bbd08dee6">isPrimaryKey</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> _isPrimaryKey;}
  169. <a name="l00070"></a><a class="code" href="class_w_sql_1_1_w_sql_column.html#a77fd5a82727a48f5449b62804260d5c3">00070</a> <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a77fd5a82727a48f5449b62804260d5c3">isUnsigned</a>()<span class="keyword"> const </span>{<span class="keywordflow">return</span> _isUnsigned;}
  170. <a name="l00071"></a>00071
  171. <a name="l00072"></a>00072 <span class="keywordtype">bool</span> <a class="code" href="class_w_sql_1_1_w_sql_column.html#a0ffeba97afa732ae7ae9be327b6e517b" title="Returns true if the datatype of the column is supported by the ORM generator.">typeIsSupported</a>()<span class="keyword">const</span>;
  172. <a name="l00073"></a>00073
  173. <a name="l00074"></a>00074 <span class="keyword">private</span>:
  174. <a name="l00075"></a>00075
  175. <a name="l00076"></a>00076 <span class="keywordtype">bool</span> _canBeNull;
  176. <a name="l00077"></a>00077 <span class="keywordtype">bool</span> _isAutoIncremented;
  177. <a name="l00078"></a>00078 <span class="keywordtype">bool</span> _isPrimaryKey;
  178. <a name="l00079"></a>00079 <span class="keywordtype">bool</span> _isUnsigned;
  179. <a name="l00080"></a>00080 <span class="keywordtype">int</span> _maxLength;
  180. <a name="l00081"></a>00081 <span class="keywordtype">int</span> _precision;
  181. <a name="l00082"></a>00082 std::string _columnName;
  182. <a name="l00083"></a>00083 std::string _variableName;
  183. <a name="l00084"></a>00084 <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> _default;
  184. <a name="l00085"></a>00085 <a class="code" href="namespace_w_sql_1_1_w_sql_data_type.html#aa234580d74e3dfc10946a4ec8e317d11">WSqlDataType::Type</a> _type;
  185. <a name="l00086"></a>00086 };
  186. <a name="l00087"></a>00087
  187. <a name="l00088"></a>00088 }<span class="comment">//namespace WSql</span>
  188. <a name="l00089"></a>00089 <span class="preprocessor">#endif // WSQLCOLUMN_H</span>
  189. </pre></div></div>
  190. </div>
  191. <!--- window showing the filter options -->
  192. <div id="MSearchSelectWindow"
  193. onmouseover="return searchBox.OnSearchSelectShow()"
  194. onmouseout="return searchBox.OnSearchSelectHide()"
  195. onkeydown="return searchBox.OnSearchSelectKey(event)">
  196. <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>
  197. <!-- iframe showing the search results (closed by default) -->
  198. <div id="MSearchResultsWindow">
  199. <iframe src="" frameborder="0"
  200. name="MSearchResults" id="MSearchResults">
  201. </iframe>
  202. </div>
  203. <hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:45 for WORM by&#160;
  204. <a href="http://www.doxygen.org/index.html">
  205. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
  206. </body>
  207. </html>