blob: e3252deac745702f9e4d5be1cca609aac029f62f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TimeFrameSet (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.rel.type, class: TimeFrameSet">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.rel.type</a></div>
<h1 title="Class TimeFrameSet" class="title">Class TimeFrameSet</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.rel.type.TimeFrameSet</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TimeFrameSet</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Set of <a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type"><code>TimeFrame</code></a> definitions.
<p>Every SQL statement has a time frame set, and is accessed via
<a href="RelDataTypeSystem.html#deriveTimeFrameSet(org.apache.calcite.rel.type.TimeFrameSet)"><code>RelDataTypeSystem.deriveTimeFrameSet(TimeFrameSet)</code></a>. If you want to
use a custom set of time frames, you should override that method.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="TimeFrameSet.Builder.html" class="type-name-link" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></code></div>
<div class="col-last even-row-color">
<div class="block">Builds a collection of time frames.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addDate(int,int,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">addDate</a><wbr>(int&nbsp;date,
int&nbsp;interval,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addTimestamp(long,long,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">addTimestamp</a><wbr>(long&nbsp;timestamp,
long&nbsp;interval,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#builder()" class="member-name-link">builder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates a Builder.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ceilDate(int,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">ceilDate</a><wbr>(int&nbsp;date,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Computes "FLOOR(date TO frame)", where <code>date</code> is the number of
days since UNIX Epoch.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#ceilTimestamp(long,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">ceilTimestamp</a><wbr>(long&nbsp;ts,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Computes "CEIL(timestamp TO frame)", where <code>ts</code> is the number of
milliseconds since UNIX Epoch.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#diffDate(int,int,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">diffDate</a><wbr>(int&nbsp;date,
int&nbsp;date2,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#diffTimestamp(long,long,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">diffTimestamp</a><wbr>(long&nbsp;timestamp,
long&nbsp;timestamp2,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#floorDate(int,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">floorDate</a><wbr>(int&nbsp;date,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Computes "FLOOR(date TO frame)", where <code>date</code> is the number of
days since UNIX Epoch.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#floorTimestamp(long,org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">floorTimestamp</a><wbr>(long&nbsp;ts,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Computes "FLOOR(timestamp TO frame)", where <code>ts</code> is the number of
milliseconds since UNIX Epoch.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(java.lang.String)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the time frame with the given name,
or throws <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> if not found.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#get(org.apache.calcite.avatica.util.TimeUnit)" class="member-name-link">get</a><wbr>(org.apache.calcite.avatica.util.TimeUnit&nbsp;timeUnit)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the time frame with the given name,
or throws <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOpt(java.lang.String)" class="member-name-link">getOpt</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the time frame with the given name (case-insensitive),
or returns null.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable org.apache.calcite.avatica.util.TimeUnit</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUnit(org.apache.calcite.rel.type.TimeFrame)" class="member-name-link">getUnit</a><wbr>(<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;timeFrame)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the time unit that this time frame is based upon, or null.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="builder()">
<h3>builder</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span>&nbsp;<span class="element-name">builder</span>()</div>
<div class="block">Creates a Builder.</div>
</section>
</li>
<li>
<section class="detail" id="getOpt(java.lang.String)">
<h3>getOpt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></span>&nbsp;<span class="element-name">getOpt</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the time frame with the given name (case-insensitive),
or returns null.</div>
</section>
</li>
<li>
<section class="detail" id="get(java.lang.String)">
<h3>get</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></span>&nbsp;<span class="element-name">get</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the time frame with the given name,
or throws <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> if not found.
If <code>name</code> is an alias, resolves to the underlying frame.</div>
</section>
</li>
<li>
<section class="detail" id="get(org.apache.calcite.avatica.util.TimeUnit)">
<h3>get</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a></span>&nbsp;<span class="element-name">get</span><wbr><span class="parameters">(org.apache.calcite.avatica.util.TimeUnit&nbsp;timeUnit)</span></div>
<div class="block">Returns the time frame with the given name,
or throws <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="floorDate(int,org.apache.calcite.rel.type.TimeFrame)">
<h3>floorDate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">floorDate</span><wbr><span class="parameters">(int&nbsp;date,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
<div class="block">Computes "FLOOR(date TO frame)", where <code>date</code> is the number of
days since UNIX Epoch.</div>
</section>
</li>
<li>
<section class="detail" id="ceilDate(int,org.apache.calcite.rel.type.TimeFrame)">
<h3>ceilDate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">ceilDate</span><wbr><span class="parameters">(int&nbsp;date,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
<div class="block">Computes "FLOOR(date TO frame)", where <code>date</code> is the number of
days since UNIX Epoch.</div>
</section>
</li>
<li>
<section class="detail" id="floorTimestamp(long,org.apache.calcite.rel.type.TimeFrame)">
<h3>floorTimestamp</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">floorTimestamp</span><wbr><span class="parameters">(long&nbsp;ts,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
<div class="block">Computes "FLOOR(timestamp TO frame)", where <code>ts</code> is the number of
milliseconds since UNIX Epoch.</div>
</section>
</li>
<li>
<section class="detail" id="ceilTimestamp(long,org.apache.calcite.rel.type.TimeFrame)">
<h3>ceilTimestamp</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">ceilTimestamp</span><wbr><span class="parameters">(long&nbsp;ts,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
<div class="block">Computes "CEIL(timestamp TO frame)", where <code>ts</code> is the number of
milliseconds since UNIX Epoch.</div>
</section>
</li>
<li>
<section class="detail" id="getUnit(org.apache.calcite.rel.type.TimeFrame)">
<h3>getUnit</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable org.apache.calcite.avatica.util.TimeUnit</span>&nbsp;<span class="element-name">getUnit</span><wbr><span class="parameters">(<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;timeFrame)</span></div>
<div class="block">Returns the time unit that this time frame is based upon, or null.</div>
</section>
</li>
<li>
<section class="detail" id="addDate(int,int,org.apache.calcite.rel.type.TimeFrame)">
<h3>addDate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">addDate</span><wbr><span class="parameters">(int&nbsp;date,
int&nbsp;interval,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
</section>
</li>
<li>
<section class="detail" id="addTimestamp(long,long,org.apache.calcite.rel.type.TimeFrame)">
<h3>addTimestamp</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">addTimestamp</span><wbr><span class="parameters">(long&nbsp;timestamp,
long&nbsp;interval,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
</section>
</li>
<li>
<section class="detail" id="diffDate(int,int,org.apache.calcite.rel.type.TimeFrame)">
<h3>diffDate</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">diffDate</span><wbr><span class="parameters">(int&nbsp;date,
int&nbsp;date2,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
</section>
</li>
<li>
<section class="detail" id="diffTimestamp(long,long,org.apache.calcite.rel.type.TimeFrame)">
<h3>diffTimestamp</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name">diffTimestamp</span><wbr><span class="parameters">(long&nbsp;timestamp,
long&nbsp;timestamp2,
<a href="TimeFrame.html" title="interface in org.apache.calcite.rel.type">TimeFrame</a>&nbsp;frame)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>