blob: 944406f57c2b7c8bb37a341d0b760c86769d6e1f [file]
<!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::NamedReference 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="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_1NamedReference.html">NamedReference</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1NamedReference-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::NamedReference Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A reference to an unbound named field.
<a href="classiceberg_1_1NamedReference.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="term_8h_source.html">term.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::NamedReference:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1NamedReference.png" usemap="#iceberg::NamedReference_map" alt=""/>
<map id="iceberg::NamedReference_map" name="iceberg::NamedReference_map">
<area href="classiceberg_1_1Reference.html" title="A reference represents a named field in an expression." alt="iceberg::Reference" shape="rect" coords="0,112,298,136"/>
<area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm&lt; BoundReference &gt;" shape="rect" coords="308,112,606,136"/>
<area href="classiceberg_1_1Unbound.html" title="Interface for unbound expressions that need schema binding." alt="iceberg::Unbound&lt; B &gt;" shape="rect" coords="154,56,452,80"/>
<area href="classiceberg_1_1Term.html" title="A term is an expression node that produces a typed value when evaluated." alt="iceberg::Term" shape="rect" coords="462,56,760,80"/>
<area href="classiceberg_1_1util_1_1Formattable.html" title="Interface for objects that can be formatted via std::format." alt="iceberg::util::Formattable" shape="rect" coords="462,0,760,24"/>
</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:a3a61b01701fb7ebfe17d84c2eb2758b9" id="r_a3a61b01701fb7ebfe17d84c2eb2758b9"><td class="memItemLeft" align="right" valign="top">std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#a3a61b01701fb7ebfe17d84c2eb2758b9">name</a> () const override</td></tr>
<tr class="memdesc:a3a61b01701fb7ebfe17d84c2eb2758b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the referenced field. <br /></td></tr>
<tr class="separator:a3a61b01701fb7ebfe17d84c2eb2758b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f3f71369896b2014bfd23dc027d290c" id="r_a3f3f71369896b2014bfd23dc027d290c"><td class="memItemLeft" align="right" valign="top">Result&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1BoundReference.html">BoundReference</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#a3f3f71369896b2014bfd23dc027d290c">Bind</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &amp;schema, bool case_sensitive) const override</td></tr>
<tr class="memdesc:a3f3f71369896b2014bfd23dc027d290c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind this expression to a concrete schema. <br /></td></tr>
<tr class="separator:a3f3f71369896b2014bfd23dc027d290c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedb7bee2e1d2e6fe4c03cc2910e7ffab" id="r_aedb7bee2e1d2e6fe4c03cc2910e7ffab"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#aedb7bee2e1d2e6fe4c03cc2910e7ffab">reference</a> () override</td></tr>
<tr class="memdesc:aedb7bee2e1d2e6fe4c03cc2910e7ffab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the underlying named reference for this unbound term. <br /></td></tr>
<tr class="separator:aedb7bee2e1d2e6fe4c03cc2910e7ffab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac79a95853baaf85e52186e5b18b18537" id="r_ac79a95853baaf85e52186e5b18b18537"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#ac79a95853baaf85e52186e5b18b18537">ToString</a> () const override</td></tr>
<tr class="memdesc:ac79a95853baaf85e52186e5b18b18537"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr>
<tr class="separator:ac79a95853baaf85e52186e5b18b18537"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5ddc401012195f12349f37a7facdcc7" id="r_af5ddc401012195f12349f37a7facdcc7"><td class="memItemLeft" align="right" valign="top">Kind&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#af5ddc401012195f12349f37a7facdcc7">kind</a> () const override</td></tr>
<tr class="memdesc:af5ddc401012195f12349f37a7facdcc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the kind of this term. <br /></td></tr>
<tr class="separator:af5ddc401012195f12349f37a7facdcc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1UnboundTerm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1UnboundTerm')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1UnboundTerm.html">iceberg::UnboundTerm&lt; BoundReference &gt;</a></td></tr>
<tr class="memitem:a7c94829ddcc3940ea31b8dd8b5008fdc inherit pub_methods_classiceberg_1_1UnboundTerm" id="r_a7c94829ddcc3940ea31b8dd8b5008fdc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTerm.html#a7c94829ddcc3940ea31b8dd8b5008fdc">is_unbound</a> () const override</td></tr>
<tr class="memdesc:a7c94829ddcc3940ea31b8dd8b5008fdc inherit pub_methods_classiceberg_1_1UnboundTerm"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether this term is unbound. <br /></td></tr>
<tr class="separator:a7c94829ddcc3940ea31b8dd8b5008fdc inherit pub_methods_classiceberg_1_1UnboundTerm"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1Unbound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1Unbound')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1Unbound.html">iceberg::Unbound&lt; B &gt;</a></td></tr>
<tr class="memitem:a032a320b067d50a56cfe7e5e6ed986e9 inherit pub_methods_classiceberg_1_1Unbound" id="r_a032a320b067d50a56cfe7e5e6ed986e9"><td class="memItemLeft" align="right" valign="top">
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 inherit pub_methods_classiceberg_1_1Unbound"><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 inherit pub_methods_classiceberg_1_1Unbound"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a01fee088359db0103123ef662d2ece81" id="r_a01fee088359db0103123ef662d2ece81"><td class="memItemLeft" align="right" valign="top">static Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1NamedReference.html#a01fee088359db0103123ef662d2ece81">Make</a> (std::string field_name)</td></tr>
<tr class="memdesc:a01fee088359db0103123ef662d2ece81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a named reference to a field. <br /></td></tr>
<tr class="separator:a01fee088359db0103123ef662d2ece81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classiceberg_1_1UnboundTerm"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1UnboundTerm')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1UnboundTerm.html">iceberg::UnboundTerm&lt; BoundReference &gt;</a></td></tr>
<tr class="memitem:a452fa3a99827b436edc28beb681e89bd inherit pub_types_classiceberg_1_1UnboundTerm" id="r_a452fa3a99827b436edc28beb681e89bd"><td class="memItemLeft" align="right" valign="top">
using&#160;</td><td class="memItemRight" valign="bottom"><b>BoundType</b> = <a class="el" href="classiceberg_1_1BoundReference.html">BoundReference</a></td></tr>
<tr class="separator:a452fa3a99827b436edc28beb681e89bd inherit pub_types_classiceberg_1_1UnboundTerm"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_classiceberg_1_1Term"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classiceberg_1_1Term')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classiceberg_1_1Term.html">iceberg::Term</a></td></tr>
<tr class="memitem:aafdab7cb8b14117f662d394450af6be8 inherit pub_types_classiceberg_1_1Term" id="r_aafdab7cb8b14117f662d394450af6be8"><td class="memItemLeft" align="right" valign="top"><a id="aafdab7cb8b14117f662d394450af6be8" name="aafdab7cb8b14117f662d394450af6be8"></a>enum class &#160;</td><td class="memItemRight" valign="bottom"><b>Kind</b> : uint8_t { <b>kReference</b>
, <b>kTransform</b>
, <b>kExtract</b>
}</td></tr>
<tr class="separator:aafdab7cb8b14117f662d394450af6be8 inherit pub_types_classiceberg_1_1Term"><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>A reference to an unbound named field. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3f3f71369896b2014bfd23dc027d290c" name="a3f3f71369896b2014bfd23dc027d290c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f3f71369896b2014bfd23dc027d290c">&#9670;&#160;</a></span>Bind()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1BoundReference.html">BoundReference</a> &gt; &gt; iceberg::NamedReference::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">override</span><span class="mlabel">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>Implements <a class="el" href="classiceberg_1_1Unbound.html#a3af63f1670bd36266714c7cf3296fc83">iceberg::Unbound&lt; B &gt;</a>.</p>
</div>
</div>
<a id="af5ddc401012195f12349f37a7facdcc7" name="af5ddc401012195f12349f37a7facdcc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5ddc401012195f12349f37a7facdcc7">&#9670;&#160;</a></span>kind()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Kind iceberg::NamedReference::kind </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the kind of this term. </p>
<p>Implements <a class="el" href="classiceberg_1_1Term.html#abc8368a414f930269b883a090869eb14">iceberg::Term</a>.</p>
</div>
</div>
<a id="a01fee088359db0103123ef662d2ece81" name="a01fee088359db0103123ef662d2ece81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01fee088359db0103123ef662d2ece81">&#9670;&#160;</a></span>Make()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt; &gt; iceberg::NamedReference::Make </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>field_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a named reference to a field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field_name</td><td>The name of the field to reference </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a61b01701fb7ebfe17d84c2eb2758b9" name="a3a61b01701fb7ebfe17d84c2eb2758b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a61b01701fb7ebfe17d84c2eb2758b9">&#9670;&#160;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string_view iceberg::NamedReference::name </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the referenced field. </p>
<p>Implements <a class="el" href="classiceberg_1_1Reference.html#ac4cb7c4810d5bd567cce304e56ca82e4">iceberg::Reference</a>.</p>
</div>
</div>
<a id="aedb7bee2e1d2e6fe4c03cc2910e7ffab" name="aedb7bee2e1d2e6fe4c03cc2910e7ffab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aedb7bee2e1d2e6fe4c03cc2910e7ffab">&#9670;&#160;</a></span>reference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> &gt; iceberg::NamedReference::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the underlying named reference for this unbound term. </p>
<p>Implements <a class="el" href="classiceberg_1_1Unbound.html#aba4992824a9033d7fa4e1c75bb2ed854">iceberg::Unbound&lt; B &gt;</a>.</p>
</div>
</div>
<a id="ac79a95853baaf85e52186e5b18b18537" name="ac79a95853baaf85e52186e5b18b18537"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac79a95853baaf85e52186e5b18b18537">&#9670;&#160;</a></span>ToString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string iceberg::NamedReference::ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a user-readable string representation. </p>
<p>Implements <a class="el" href="classiceberg_1_1util_1_1Formattable.html#a79618aca5b3bf63610d9c87ac5ae0386">iceberg::util::Formattable</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/expression/<a class="el" href="term_8h_source.html">term.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>