Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1Unbound.html
blob: 60955ad586b75f39da3b1dc12a37eccfce1e06cb [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::Unbound&lt; B &gt; Class Template 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1Unbound.html">Unbound</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1Unbound-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Unbound&lt; B &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Interface for unbound expressions that need schema binding.
<a href="classiceberg_1_1Unbound.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="expression_8h_source.html">expression.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::Unbound&lt; B &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1Unbound.png" usemap="#iceberg::Unbound_3C_20B_20_3E_map" alt=""/>
<map id="iceberg::Unbound_3C_20B_20_3E_map" name="iceberg::Unbound_3C_20B_20_3E_map">
<area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm&lt; BoundReference &gt;" shape="rect" coords="0,56,290,80"/>
<area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm&lt; class BoundTransform &gt;" shape="rect" coords="300,56,590,80"/>
<area href="classiceberg_1_1UnboundTerm.html" title="Base class for unbound terms." alt="iceberg::UnboundTerm&lt; B &gt;" shape="rect" coords="600,56,890,80"/>
<area href="classiceberg_1_1NamedReference.html" title="A reference to an unbound named field." alt="iceberg::NamedReference" shape="rect" coords="0,112,290,136"/>
<area href="classiceberg_1_1UnboundTransform.html" title="An unbound transform expression." alt="iceberg::UnboundTransform" shape="rect" coords="300,112,590,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3af63f1670bd36266714c7cf3296fc83" id="r_a3af63f1670bd36266714c7cf3296fc83"><td class="memItemLeft" align="right" valign="top">virtual Result&lt; std::shared_ptr&lt; B &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Unbound.html#a3af63f1670bd36266714c7cf3296fc83">Bind</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema, bool case_sensitive) const =0</td></tr>
<tr class="memdesc:a3af63f1670bd36266714c7cf3296fc83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind this expression to a concrete schema. <br /></td></tr>
<tr class="separator:a3af63f1670bd36266714c7cf3296fc83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a032a320b067d50a56cfe7e5e6ed986e9" id="r_a032a320b067d50a56cfe7e5e6ed986e9"><td class="memItemLeft" align="right" valign="top"><a id="a032a320b067d50a56cfe7e5e6ed986e9" name="a032a320b067d50a56cfe7e5e6ed986e9"></a>
Result&lt; std::shared_ptr&lt; B &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Bind</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema) const</td></tr>
<tr class="memdesc:a032a320b067d50a56cfe7e5e6ed986e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overloaded Bind method that uses case-sensitive matching by default. <br /></td></tr>
<tr class="separator:a032a320b067d50a56cfe7e5e6ed986e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba4992824a9033d7fa4e1c75bb2ed854" id="r_aba4992824a9033d7fa4e1c75bb2ed854"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; class <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Unbound.html#aba4992824a9033d7fa4e1c75bb2ed854">reference</a> ()=0</td></tr>
<tr class="memdesc:aba4992824a9033d7fa4e1c75bb2ed854"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the underlying named reference for this unbound term. <br /></td></tr>
<tr class="separator:aba4992824a9033d7fa4e1c75bb2ed854"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename B&gt;<br />
class iceberg::Unbound&lt; B &gt;</div><p>Interface for unbound expressions that need schema binding. </p>
<p><a class="el" href="classiceberg_1_1Unbound.html" title="Interface for unbound expressions that need schema binding.">Unbound</a> expressions contain string-based references that must be resolved against a concrete schema to produce bound expressions that can be evaluated.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">B</td><td>The bound type this term produces when binding is successful </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3af63f1670bd36266714c7cf3296fc83" name="a3af63f1670bd36266714c7cf3296fc83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3af63f1670bd36266714c7cf3296fc83">&#9670;&#160;</a></span>Bind()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename B &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Result&lt; std::shared_ptr&lt; B &gt; &gt; <a class="el" href="classiceberg_1_1Unbound.html">iceberg::Unbound</a>&lt; B &gt;::Bind </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;&#160;</td>
<td class="paramname"><em>schema</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>case_sensitive</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Bind this expression to a concrete schema. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">schema</td><td>The schema to bind against </td></tr>
<tr><td class="paramname">case_sensitive</td><td>Whether field name matching should be case sensitive </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A bound expression or an error if binding fails </dd></dl>
<p>Implemented in <a class="el" href="classiceberg_1_1UnboundAggregateImpl.html#a4855375d718179c731529527844a88af">iceberg::UnboundAggregateImpl&lt; B &gt;</a>, <a class="el" href="classiceberg_1_1UnboundPredicateImpl.html#a234cf2ed28904188e1976ad3813a8553">iceberg::UnboundPredicateImpl&lt; B &gt;</a>, <a class="el" href="classiceberg_1_1NamedReference.html#a3f3f71369896b2014bfd23dc027d290c">iceberg::NamedReference</a>, <a class="el" href="classiceberg_1_1UnboundTransform.html#aa6559c7e9a4b4c46cf58730d467327b2">iceberg::UnboundTransform</a>, and <a class="el" href="classiceberg_1_1UnboundPredicate.html#a59f8bba53fe0247d28327d23189f7dd1">iceberg::UnboundPredicate</a>.</p>
</div>
</div>
<a id="aba4992824a9033d7fa4e1c75bb2ed854" name="aba4992824a9033d7fa4e1c75bb2ed854"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba4992824a9033d7fa4e1c75bb2ed854">&#9670;&#160;</a></span>reference()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename B &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::shared_ptr&lt; class <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt; <a class="el" href="classiceberg_1_1Unbound.html">iceberg::Unbound</a>&lt; B &gt;::reference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the underlying named reference for this unbound term. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1UnboundAggregateImpl.html#a15f042b6cc58c144ad2042b922089a40">iceberg::UnboundAggregateImpl&lt; B &gt;</a>, <a class="el" href="classiceberg_1_1UnboundPredicateImpl.html#adf9d6125fc9e654129c760e9039c6f7a">iceberg::UnboundPredicateImpl&lt; B &gt;</a>, <a class="el" href="classiceberg_1_1NamedReference.html#aedb7bee2e1d2e6fe4c03cc2910e7ffab">iceberg::NamedReference</a>, <a class="el" href="classiceberg_1_1UnboundTransform.html#adf473df852c9482a59530fd14c26a136">iceberg::UnboundTransform</a>, and <a class="el" href="classiceberg_1_1UnboundPredicate.html#afc28a47f14049b5e3a9cbe27f557633e">iceberg::UnboundPredicate</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/expression/<a class="el" href="expression_8h_source.html">expression.h</a></li>
<li>iceberg/expression/<b>term.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>