blob: b7bcf8417e59728a39b7ce0fd6e5235e5b8d19ea [file] [log] [blame]
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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>tmudr: tmudr::UniqueConstraintInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
<div class="navpath"><b>tmudr</b>::<a class="el" href="classtmudr_1_1UniqueConstraintInfo.html">UniqueConstraintInfo</a>
</div>
</div>
<div class="contents">
<h1>tmudr::UniqueConstraintInfo Class Reference</h1><!-- doxytag: class="tmudr::UniqueConstraintInfo" --><!-- doxytag: inherits="tmudr::ConstraintInfo" -->
<p>A uniqueness constraint.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="sqludr_8h_source.html">sqludr.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for tmudr::UniqueConstraintInfo:</div>
<div class="dynsection">
<div class="center">
<img src="classtmudr_1_1UniqueConstraintInfo.gif" usemap="#tmudr::UniqueConstraintInfo_map" alt=""/>
<map id="tmudr::UniqueConstraintInfo_map" name="tmudr::UniqueConstraintInfo_map">
<area href="classtmudr_1_1ConstraintInfo.html" alt="tmudr::ConstraintInfo" shape="rect" coords="0,0,165,24"/>
</map>
</div>
</div>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#a369e24f52470dac46c051d072255590e">UniqueConstraintInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#ad47e14ccc5fe2c1e1740fa7fc1ea0bf7">getNumUniqueColumns</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#ae781aff62acfd3745b91d08b2246a5b5">getUniqueColumn</a> (int i) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#a20b7a861cebf2362c707a5da433e4a62">addColumn</a> (int c)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A uniqueness constraint. </p>
<p>A list of columns that, together, form a unique key </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a369e24f52470dac46c051d072255590e"></a><!-- doxytag: member="tmudr::UniqueConstraintInfo::UniqueConstraintInfo" ref="a369e24f52470dac46c051d072255590e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">UniqueConstraintInfo::UniqueConstraintInfo </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor for an empty uniqueness constraint.</p>
<p>Use method <a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#a20b7a861cebf2362c707a5da433e4a62">addColumn()</a> to add columns. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a20b7a861cebf2362c707a5da433e4a62"></a><!-- doxytag: member="tmudr::UniqueConstraintInfo::addColumn" ref="a20b7a861cebf2362c707a5da433e4a62" args="(int c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void UniqueConstraintInfo::addColumn </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>c</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a column to a uniqueness constraint.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>c</em>&nbsp;</td><td>Column number/ordinal of one of the unique columns in the constraint. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad47e14ccc5fe2c1e1740fa7fc1ea0bf7"></a><!-- doxytag: member="tmudr::UniqueConstraintInfo::getNumUniqueColumns" ref="ad47e14ccc5fe2c1e1740fa7fc1ea0bf7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UniqueConstraintInfo::getNumUniqueColumns </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of columns that form the unique key.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of columns in the uniqueness constraint. </dd></dl>
</div>
</div>
<a class="anchor" id="ae781aff62acfd3745b91d08b2246a5b5"></a><!-- doxytag: member="tmudr::UniqueConstraintInfo::getUniqueColumn" ref="ae781aff62acfd3745b91d08b2246a5b5" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int UniqueConstraintInfo::getUniqueColumn </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>i</em></td>
<td>&nbsp;)&nbsp;</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a column of the uniqueness constraint by iterator.</p>
<p>Like in other methods, we use an integer to iterate over the columns in the set. Note that the columns form a set, so this number i is merely there to iterate over the set of columns.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>i</em>&nbsp;</td><td>A number between 0 and <a class="el" href="classtmudr_1_1UniqueConstraintInfo.html#ad47e14ccc5fe2c1e1740fa7fc1ea0bf7">getNumUniqueColumns()</a>-1. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Column number/ordinal of the unique column. </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="classtmudr_1_1UDRException.html" title="This is the exception to throw when an error occurs in a UDR.">UDRException</a></em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="sqludr_8h_source.html">sqludr.h</a></li>
<li>sqludr.cpp</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 3 Mar 2017 for tmudr by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>