Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1HourTransform.html
blob: ce0d6657130880d84302d37c577108e199666046 [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::HourTransform 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_1HourTransform.html">HourTransform</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_1HourTransform-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::HourTransform Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Hour transform that extracts the number of hours from timestamp inputs since the epoch.
<a href="classiceberg_1_1HourTransform.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="transform__function_8h_source.html">transform_function.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::HourTransform:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1HourTransform.png" usemap="#iceberg::HourTransform_map" alt=""/>
<map id="iceberg::HourTransform_map" name="iceberg::HourTransform_map">
<area href="classiceberg_1_1TransformFunction.html" title="A transform function used for partitioning." alt="iceberg::TransformFunction" shape="rect" coords="0,0,167,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:a745f434273451892667756b47a5683e4" id="r_a745f434273451892667756b47a5683e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1HourTransform.html#a745f434273451892667756b47a5683e4">HourTransform</a> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; const &amp;<a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>)</td></tr>
<tr class="separator:a745f434273451892667756b47a5683e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b78071b98fe8457e819dd5873403b46" id="r_a6b78071b98fe8457e819dd5873403b46"><td class="memItemLeft" align="right" valign="top">Result&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1HourTransform.html#a6b78071b98fe8457e819dd5873403b46">Transform</a> (const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &amp;literal) override</td></tr>
<tr class="memdesc:a6b78071b98fe8457e819dd5873403b46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Extract a timestamp hour, as hours from 1970-01-01 00:00:00. <br /></td></tr>
<tr class="separator:a6b78071b98fe8457e819dd5873403b46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c352ec3dc3a7a40a9b2f7fc19a76f09" id="r_a6c352ec3dc3a7a40a9b2f7fc19a76f09"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1HourTransform.html#a6c352ec3dc3a7a40a9b2f7fc19a76f09">ResultType</a> () const override</td></tr>
<tr class="memdesc:a6c352ec3dc3a7a40a9b2f7fc19a76f09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns INT32 as the output type. <br /></td></tr>
<tr class="separator:a6c352ec3dc3a7a40a9b2f7fc19a76f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classiceberg_1_1TransformFunction"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classiceberg_1_1TransformFunction')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classiceberg_1_1TransformFunction.html">iceberg::TransformFunction</a></td></tr>
<tr class="memitem:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a3e97589741424abf0fb1c0c01117bb5e"><td class="memItemLeft" align="right" valign="top">
&#160;</td><td class="memItemRight" valign="bottom"><b>TransformFunction</b> (<a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a> <a class="el" href="classiceberg_1_1TransformFunction.html#abf4c9031fa1b0de214e6aa7ffc717c56">transform_type</a>, std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; <a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>)</td></tr>
<tr class="separator:a3e97589741424abf0fb1c0c01117bb5e inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction" id="r_abf4c9031fa1b0de214e6aa7ffc717c56"><td class="memItemLeft" align="right" valign="top">
<a class="el" href="transform_8h.html#a78b299cfdfb0b9631ca6fc520bd1b131">TransformType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>transform_type</b> () const</td></tr>
<tr class="memdesc:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transform type. <br /></td></tr>
<tr class="separator:abf4c9031fa1b0de214e6aa7ffc717c56 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction" id="r_a5fb6043200973c2a68f1b59b52f3dc91"><td class="memItemLeft" align="right" valign="top">
const std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>source_type</b> () const</td></tr>
<tr class="memdesc:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the source type of transform function. <br /></td></tr>
<tr class="separator:a5fb6043200973c2a68f1b59b52f3dc91 inherit pub_methods_classiceberg_1_1TransformFunction"><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:a6a65e158b9d471143f2f3a03b787fccc" id="r_a6a65e158b9d471143f2f3a03b787fccc"><td class="memItemLeft" align="right" valign="top">static Result&lt; std::unique_ptr&lt; <a class="el" href="classiceberg_1_1TransformFunction.html">TransformFunction</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1HourTransform.html#a6a65e158b9d471143f2f3a03b787fccc">Make</a> (std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; const &amp;<a class="el" href="classiceberg_1_1TransformFunction.html#a5fb6043200973c2a68f1b59b52f3dc91">source_type</a>)</td></tr>
<tr class="memdesc:a6a65e158b9d471143f2f3a03b787fccc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="classiceberg_1_1HourTransform.html" title="Hour transform that extracts the number of hours from timestamp inputs since the epoch.">HourTransform</a>. <br /></td></tr>
<tr class="separator:a6a65e158b9d471143f2f3a03b787fccc"><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>Hour transform that extracts the number of hours from timestamp inputs since the epoch. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a745f434273451892667756b47a5683e4" name="a745f434273451892667756b47a5683e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a745f434273451892667756b47a5683e4">&#9670;&#160;</a></span>HourTransform()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">iceberg::HourTransform::HourTransform </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>source_type</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source_type</td><td>Must be a timestamp type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6a65e158b9d471143f2f3a03b787fccc" name="a6a65e158b9d471143f2f3a03b787fccc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a65e158b9d471143f2f3a03b787fccc">&#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_1TransformFunction.html">TransformFunction</a> &gt; &gt; iceberg::HourTransform::Make </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Type.html">Type</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>source_type</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 <a class="el" href="classiceberg_1_1HourTransform.html" title="Hour transform that extracts the number of hours from timestamp inputs since the epoch.">HourTransform</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source_type</td><td><a class="el" href="classiceberg_1_1Type.html" title="Interface for a data type for a field.">Type</a> of the input data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A Result containing the <a class="el" href="classiceberg_1_1HourTransform.html" title="Hour transform that extracts the number of hours from timestamp inputs since the epoch.">HourTransform</a> or an error. </dd></dl>
</div>
</div>
<a id="a6c352ec3dc3a7a40a9b2f7fc19a76f09" name="a6c352ec3dc3a7a40a9b2f7fc19a76f09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c352ec3dc3a7a40a9b2f7fc19a76f09">&#9670;&#160;</a></span>ResultType()</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_1Type.html">Type</a> &gt; iceberg::HourTransform::ResultType </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>Returns INT32 as the output type. </p>
<p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#a82841b58ce6380a7467bccf57e18e0d5">iceberg::TransformFunction</a>.</p>
</div>
</div>
<a id="a6b78071b98fe8457e819dd5873403b46" name="a6b78071b98fe8457e819dd5873403b46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b78071b98fe8457e819dd5873403b46">&#9670;&#160;</a></span>Transform()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Result&lt; <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &gt; iceberg::HourTransform::Transform </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classiceberg_1_1Literal.html">Literal</a> &amp;&#160;</td>
<td class="paramname"><em>literal</em></td><td>)</td>
<td></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>Extract a timestamp hour, as hours from 1970-01-01 00:00:00. </p>
<p>Implements <a class="el" href="classiceberg_1_1TransformFunction.html#afb1c573d9bd098c76d858f476ef16f3f">iceberg::TransformFunction</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/<a class="el" href="transform__function_8h_source.html">transform_function.h</a></li>
<li>iceberg/<b>transform_function.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>