| <!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::UnboundTransform 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&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&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_1UnboundTransform.html">UnboundTransform</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1UnboundTransform-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::UnboundTransform Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An unbound transform expression. |
| <a href="classiceberg_1_1UnboundTransform.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="term_8h_source.html">term.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::UnboundTransform:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1UnboundTransform.png" usemap="#iceberg::UnboundTransform_map" alt=""/> |
| <map id="iceberg::UnboundTransform_map" name="iceberg::UnboundTransform_map"> |
| <area href="classiceberg_1_1UnboundTerm.html" alt="iceberg::UnboundTerm< class BoundTransform >" shape="rect" coords="150,112,440,136"/> |
| <area href="classiceberg_1_1Unbound.html" title="Interface for unbound expressions that need schema binding." alt="iceberg::Unbound< B >" shape="rect" coords="0,56,290,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="300,56,590,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="300,0,590,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:aac2547c880112427e20259f84d4f2d80" id="r_aac2547c880112427e20259f84d4f2d80"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTransform.html#aac2547c880112427e20259f84d4f2d80">ToString</a> () const override</td></tr> |
| <tr class="memdesc:aac2547c880112427e20259f84d4f2d80"><td class="mdescLeft"> </td><td class="mdescRight">Get a user-readable string representation. <br /></td></tr> |
| <tr class="separator:aac2547c880112427e20259f84d4f2d80"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa6559c7e9a4b4c46cf58730d467327b2" id="r_aa6559c7e9a4b4c46cf58730d467327b2"><td class="memItemLeft" align="right" valign="top">Result< std::shared_ptr< <a class="el" href="classiceberg_1_1BoundTransform.html">BoundTransform</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTransform.html#aa6559c7e9a4b4c46cf58730d467327b2">Bind</a> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema, bool case_sensitive) const override</td></tr> |
| <tr class="memdesc:aa6559c7e9a4b4c46cf58730d467327b2"><td class="mdescLeft"> </td><td class="mdescRight">Bind this expression to a concrete schema. <br /></td></tr> |
| <tr class="separator:aa6559c7e9a4b4c46cf58730d467327b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adf473df852c9482a59530fd14c26a136" id="r_adf473df852c9482a59530fd14c26a136"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTransform.html#adf473df852c9482a59530fd14c26a136">reference</a> () override</td></tr> |
| <tr class="memdesc:adf473df852c9482a59530fd14c26a136"><td class="mdescLeft"> </td><td class="mdescRight">Returns the underlying named reference for this unbound term. <br /></td></tr> |
| <tr class="separator:adf473df852c9482a59530fd14c26a136"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acd098a804670ca0ebe00c29948b91a51" id="r_acd098a804670ca0ebe00c29948b91a51"><td class="memItemLeft" align="right" valign="top"><a id="acd098a804670ca0ebe00c29948b91a51" name="acd098a804670ca0ebe00c29948b91a51"></a> |
| const std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > & </td><td class="memItemRight" valign="bottom"><b>transform</b> () const</td></tr> |
| <tr class="separator:acd098a804670ca0ebe00c29948b91a51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3f0a01c4063aa0b1bd544855de4f2350" id="r_a3f0a01c4063aa0b1bd544855de4f2350"><td class="memItemLeft" align="right" valign="top">Kind </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTransform.html#a3f0a01c4063aa0b1bd544855de4f2350">kind</a> () const override</td></tr> |
| <tr class="memdesc:a3f0a01c4063aa0b1bd544855de4f2350"><td class="mdescLeft"> </td><td class="mdescRight">Returns the kind of this term. <br /></td></tr> |
| <tr class="separator:a3f0a01c4063aa0b1bd544855de4f2350"><td class="memSeparator" colspan="2"> </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="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1UnboundTerm.html">iceberg::UnboundTerm< class BoundTransform ></a></td></tr> |
| <tr class="memitem:a7c94829ddcc3940ea31b8dd8b5008fdc inherit pub_methods_classiceberg_1_1UnboundTerm" id="r_a7c94829ddcc3940ea31b8dd8b5008fdc"><td class="memItemLeft" align="right" valign="top">bool </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"> </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"> </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="-"/> Public Member Functions inherited from <a class="el" href="classiceberg_1_1Unbound.html">iceberg::Unbound< B ></a></td></tr> |
| <tr class="memitem:a032a320b067d50a56cfe7e5e6ed986e9 inherit pub_methods_classiceberg_1_1Unbound" id="r_a032a320b067d50a56cfe7e5e6ed986e9"><td class="memItemLeft" align="right" valign="top"> |
| Result< std::shared_ptr< B > > </td><td class="memItemRight" valign="bottom"><b>Bind</b> (const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> &schema) const</td></tr> |
| <tr class="memdesc:a032a320b067d50a56cfe7e5e6ed986e9 inherit pub_methods_classiceberg_1_1Unbound"><td class="mdescLeft"> </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"> </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:a6310481c32ff955e0aba82369a23e604" id="r_a6310481c32ff955e0aba82369a23e604"><td class="memItemLeft" align="right" valign="top">static Result< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundTransform.html">UnboundTransform</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1UnboundTransform.html#a6310481c32ff955e0aba82369a23e604">Make</a> (std::shared_ptr< <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> > ref, std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > transform)</td></tr> |
| <tr class="memdesc:a6310481c32ff955e0aba82369a23e604"><td class="mdescLeft"> </td><td class="mdescRight">Create an unbound transform. <br /></td></tr> |
| <tr class="separator:a6310481c32ff955e0aba82369a23e604"><td class="memSeparator" colspan="2"> </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="-"/> Public Types inherited from <a class="el" href="classiceberg_1_1UnboundTerm.html">iceberg::UnboundTerm< class BoundTransform ></a></td></tr> |
| <tr class="memitem:a452fa3a99827b436edc28beb681e89bd inherit pub_types_classiceberg_1_1UnboundTerm" id="r_a452fa3a99827b436edc28beb681e89bd"><td class="memItemLeft" align="right" valign="top"> |
| using </td><td class="memItemRight" valign="bottom"><b>BoundType</b> = class <a class="el" href="classiceberg_1_1BoundTransform.html">BoundTransform</a></td></tr> |
| <tr class="separator:a452fa3a99827b436edc28beb681e89bd inherit pub_types_classiceberg_1_1UnboundTerm"><td class="memSeparator" colspan="2"> </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="-"/> 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  </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"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An unbound transform expression. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aa6559c7e9a4b4c46cf58730d467327b2" name="aa6559c7e9a4b4c46cf58730d467327b2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa6559c7e9a4b4c46cf58730d467327b2">◆ </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< std::shared_ptr< <a class="el" href="classiceberg_1_1BoundTransform.html">BoundTransform</a> > > iceberg::UnboundTransform::Bind </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classiceberg_1_1Schema.html">Schema</a> & </td> |
| <td class="paramname"><em>schema</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>case_sensitive</em> </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< B ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="a3f0a01c4063aa0b1bd544855de4f2350" name="a3f0a01c4063aa0b1bd544855de4f2350"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3f0a01c4063aa0b1bd544855de4f2350">◆ </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::UnboundTransform::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="a6310481c32ff955e0aba82369a23e604" name="a6310481c32ff955e0aba82369a23e604"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6310481c32ff955e0aba82369a23e604">◆ </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< std::unique_ptr< <a class="el" href="classiceberg_1_1UnboundTransform.html">UnboundTransform</a> > > iceberg::UnboundTransform::Make </td> |
| <td>(</td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> > </td> |
| <td class="paramname"><em>ref</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::shared_ptr< <a class="el" href="classiceberg_1_1Transform.html">Transform</a> > </td> |
| <td class="paramname"><em>transform</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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 an unbound transform. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">ref</td><td>The term to apply the transformation to </td></tr> |
| <tr><td class="paramname">transform</td><td>The transformation function to apply </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="adf473df852c9482a59530fd14c26a136" name="adf473df852c9482a59530fd14c26a136"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#adf473df852c9482a59530fd14c26a136">◆ </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< <a class="el" href="classiceberg_1_1NamedReference.html">NamedReference</a> > iceberg::UnboundTransform::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< B ></a>.</p> |
| |
| </div> |
| </div> |
| <a id="aac2547c880112427e20259f84d4f2d80" name="aac2547c880112427e20259f84d4f2d80"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aac2547c880112427e20259f84d4f2d80">◆ </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::UnboundTransform::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 <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> |
