blob: 33262e8fc68b12457ffcfe4a0d42c5562e753af6 [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Impala: impala::DescriptorTblBuilder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Impala
</div>
<div id="projectbrief">Impalaistheopensource,nativeanalyticdatabaseforApacheHadoop.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classimpala_1_1DescriptorTblBuilder.html','');});
</script>
<div id="doc-content">
<!-- 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">&#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>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classimpala_1_1DescriptorTblBuilder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">impala::DescriptorTblBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="desc-tbl-builder_8h_source.html">desc-tbl-builder.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for impala::DescriptorTblBuilder:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classimpala_1_1DescriptorTblBuilder__coll__graph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2e6338f2ad59a7c7bc84dccb6204c20a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html#a2e6338f2ad59a7c7bc84dccb6204c20a">DescriptorTblBuilder</a> (<a class="el" href="classimpala_1_1ObjectPool.html">ObjectPool</a> *object_pool)</td></tr>
<tr class="separator:a2e6338f2ad59a7c7bc84dccb6204c20a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6ec606565d14ba2a9d77849fc8051de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1TupleDescBuilder.html">TupleDescBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html#af6ec606565d14ba2a9d77849fc8051de">DeclareTuple</a> ()</td></tr>
<tr class="separator:af6ec606565d14ba2a9d77849fc8051de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af73f3a690dd7c994cc553918fa97b6f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1DescriptorTbl.html">DescriptorTbl</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html#af73f3a690dd7c994cc553918fa97b6f8">Build</a> ()</td></tr>
<tr class="separator:af73f3a690dd7c994cc553918fa97b6f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aca40084987707a4048d35303c95e05bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classimpala_1_1ObjectPool.html">ObjectPool</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html#aca40084987707a4048d35303c95e05bd">obj_pool_</a></td></tr>
<tr class="memdesc:aca40084987707a4048d35303c95e05bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Owned by caller. <a href="#aca40084987707a4048d35303c95e05bd">More...</a><br/></td></tr>
<tr class="separator:aca40084987707a4048d35303c95e05bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab29757f1e4aa1ee325780367a3de1364"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classimpala_1_1TupleDescBuilder.html">TupleDescBuilder</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html#ab29757f1e4aa1ee325780367a3de1364">tuples_descs_</a></td></tr>
<tr class="separator:ab29757f1e4aa1ee325780367a3de1364"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Aids in the construction of a <a class="el" href="classimpala_1_1DescriptorTbl.html">DescriptorTbl</a> by declaring tuples and slots associated with those tuples. TupleIds are monotonically increasing from 0 for each DeclareTuple, and SlotIds increase similarly, but are always greater than all TupleIds. Unlike FE, slots are not reordered based on size, and padding is not addded. Example usage: <a class="el" href="classimpala_1_1DescriptorTblBuilder.html">DescriptorTblBuilder</a> builder; builder.DeclareTuple() &lt;&lt; TYPE_TINYINT &lt;&lt; TYPE_TIMESTAMP; // gets TupleId 0 builder.DeclareTuple() &lt;&lt; TYPE_FLOAT; // gets TupleId 1 <a class="el" href="classimpala_1_1DescriptorTbl.html">DescriptorTbl</a> desc_tbl = builder.Build(); </p>
<p>Definition at line <a class="el" href="desc-tbl-builder_8h_source.html#l00036">36</a> of file <a class="el" href="desc-tbl-builder_8h_source.html">desc-tbl-builder.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2e6338f2ad59a7c7bc84dccb6204c20a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">impala::DescriptorTblBuilder::DescriptorTblBuilder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classimpala_1_1ObjectPool.html">ObjectPool</a> *&#160;</td>
<td class="paramname"><em>object_pool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="desc-tbl-builder_8cc_source.html#l00025">25</a> of file <a class="el" href="desc-tbl-builder_8cc_source.html">desc-tbl-builder.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af73f3a690dd7c994cc553918fa97b6f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1DescriptorTbl.html">DescriptorTbl</a> * impala::DescriptorTblBuilder::Build </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="desc-tbl-builder_8cc_source.html#l00059">59</a> of file <a class="el" href="desc-tbl-builder_8cc_source.html">desc-tbl-builder.cc</a>.</p>
<p>References <a class="el" href="bit-util_8h_source.html#l00032">impala::BitUtil::Ceil()</a>, <a class="el" href="descriptors_8cc_source.html#l00378">impala::DescriptorTbl::Create()</a>, <a class="el" href="desc-tbl-builder_8cc_source.html#l00034">impala::MakeSlotDescriptor()</a>, <a class="el" href="desc-tbl-builder_8cc_source.html#l00051">impala::MakeTupleDescriptor()</a>, <a class="el" href="desc-tbl-builder_8h_source.html#l00045">obj_pool_</a>, <a class="el" href="status_8h_source.html#l00172">impala::Status::ok()</a>, <a class="el" href="desc-tbl-builder_8h_source.html#l00047">tuples_descs_</a>, <a class="el" href="types_8h_source.html#l00038">impala::TYPE_STRING</a>, and <a class="el" href="types_8h_source.html#l00048">impala::TYPE_VARCHAR</a>.</p>
<p>Referenced by <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00070">impala::SimpleTupleStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00405">impala::SimpleNullStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00424">impala::MultiTupleStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00454">impala::MultiNullableTupleStreamTest::CreateDescriptors()</a>, and <a class="el" href="row-batch-list-test_8cc_source.html#l00045">impala::RowBatchListTest::SetUp()</a>.</p>
</div>
</div>
<a class="anchor" id="af6ec606565d14ba2a9d77849fc8051de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1TupleDescBuilder.html">TupleDescBuilder</a> &amp; impala::DescriptorTblBuilder::DeclareTuple </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="desc-tbl-builder_8cc_source.html#l00028">28</a> of file <a class="el" href="desc-tbl-builder_8cc_source.html">desc-tbl-builder.cc</a>.</p>
<p>References <a class="el" href="object-pool_8h_source.html#l00042">impala::ObjectPool::Add()</a>, <a class="el" href="desc-tbl-builder_8h_source.html#l00045">obj_pool_</a>, and <a class="el" href="desc-tbl-builder_8h_source.html#l00047">tuples_descs_</a>.</p>
<p>Referenced by <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00070">impala::SimpleTupleStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00405">impala::SimpleNullStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00424">impala::MultiTupleStreamTest::CreateDescriptors()</a>, <a class="el" href="buffered-tuple-stream-test_8cc_source.html#l00454">impala::MultiNullableTupleStreamTest::CreateDescriptors()</a>, and <a class="el" href="row-batch-list-test_8cc_source.html#l00045">impala::RowBatchListTest::SetUp()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aca40084987707a4048d35303c95e05bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classimpala_1_1ObjectPool.html">ObjectPool</a>* impala::DescriptorTblBuilder::obj_pool_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Owned by caller. </p>
<p>Definition at line <a class="el" href="desc-tbl-builder_8h_source.html#l00045">45</a> of file <a class="el" href="desc-tbl-builder_8h_source.html">desc-tbl-builder.h</a>.</p>
<p>Referenced by <a class="el" href="desc-tbl-builder_8cc_source.html#l00059">Build()</a>, and <a class="el" href="desc-tbl-builder_8cc_source.html#l00028">DeclareTuple()</a>.</p>
</div>
</div>
<a class="anchor" id="ab29757f1e4aa1ee325780367a3de1364"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="classimpala_1_1TupleDescBuilder.html">TupleDescBuilder</a>*&gt; impala::DescriptorTblBuilder::tuples_descs_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="desc-tbl-builder_8h_source.html#l00047">47</a> of file <a class="el" href="desc-tbl-builder_8h_source.html">desc-tbl-builder.h</a>.</p>
<p>Referenced by <a class="el" href="desc-tbl-builder_8cc_source.html#l00059">Build()</a>, and <a class="el" href="desc-tbl-builder_8cc_source.html#l00028">DeclareTuple()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>be/src/testutil/<a class="el" href="desc-tbl-builder_8h_source.html">desc-tbl-builder.h</a></li>
<li>be/src/testutil/<a class="el" href="desc-tbl-builder_8cc_source.html">desc-tbl-builder.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceimpala.html">impala</a></li><li class="navelem"><a class="el" href="classimpala_1_1DescriptorTblBuilder.html">DescriptorTblBuilder</a></li>
<li class="footer">Generated on Thu May 7 2015 16:10:50 for Impala by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
</ul>
</div>
</body>
</html>