blob: 702fccbdc10617fdd73f510eaa2c84986db8207b [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>DruidDateTimeUtils (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DruidDateTimeUtils (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DruidDateTimeUtils.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.adapter.druid</a></div>
<h2 title="Class DruidDateTimeUtils" class="title">Class DruidDateTimeUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.adapter.druid.DruidDateTimeUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">DruidDateTimeUtils</span>
extends java.lang.Object</pre>
<div class="block">Utilities for generating intervals from RexNode.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static org.slf4j.Logger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOGGER">LOGGER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">DruidDateTimeUtils</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.util.List&lt;org.joda.time.Interval&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createInterval(org.apache.calcite.rex.RexNode)">createInterval</a></span>&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;e)</code></th>
<td class="colLast">
<div class="block">Generates a list of <code>Interval</code>s equivalent to a given
expression.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="Granularity.html" title="interface in org.apache.calcite.adapter.druid">Granularity</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extractGranularity(org.apache.calcite.rex.RexNode,java.lang.String)">extractGranularity</a></span>&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node,
java.lang.String&nbsp;timeZone)</code></th>
<td class="colLast">
<div class="block">Infers granularity from a time unit.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected static java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extractRanges(org.apache.calcite.rex.RexNode,boolean)">extractRanges</a></span>&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node,
boolean&nbsp;withNot)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected static java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#leafToRanges(org.apache.calcite.rex.RexCall,boolean)">leafToRanges</a></span>&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call,
boolean&nbsp;withNot)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected static java.lang.Long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#literalValue(org.apache.calcite.rex.RexNode)">literalValue</a></span>&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node)</code></th>
<td class="colLast">
<div class="block">Returns the literal value for the given node, assuming it is a literal with
datetime type, or a cast that only alters nullability on top of a literal with
datetime type.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="Granularity.Type.html" title="enum in org.apache.calcite.adapter.druid">Granularity.Type</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toDruidGranularity(org.apache.calcite.avatica.util.TimeUnitRange)">toDruidGranularity</a></span>&#8203;(org.apache.calcite.avatica.util.TimeUnitRange&nbsp;timeUnit)</code></th>
<td class="colLast">
<div class="block">Translates Calcite TimeUnitRange to Druid <a href="Granularity.html" title="interface in org.apache.calcite.adapter.druid"><code>Granularity</code></a></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected static java.util.List&lt;org.joda.time.Interval&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toInterval(java.util.List)">toInterval</a></span>&#8203;(java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;&nbsp;ranges)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toISOPeriodFormat(org.apache.calcite.adapter.druid.Granularity.Type)">toISOPeriodFormat</a></span>&#8203;(<a href="Granularity.Type.html" title="enum in org.apache.calcite.adapter.druid">Granularity.Type</a>&nbsp;type)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="LOGGER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOGGER</h4>
<pre>protected static final&nbsp;org.slf4j.Logger LOGGER</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DruidDateTimeUtils</h4>
<pre>private&nbsp;DruidDateTimeUtils()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="createInterval(org.apache.calcite.rex.RexNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createInterval</h4>
<pre class="methodSignature">@Nullable
public static&nbsp;java.util.List&lt;org.joda.time.Interval&gt;&nbsp;createInterval&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;e)</pre>
<div class="block">Generates a list of <code>Interval</code>s equivalent to a given
expression. Assumes that all the predicates in the input
reference a single column: the timestamp column.</div>
</li>
</ul>
<a id="toInterval(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toInterval</h4>
<pre class="methodSignature">protected static&nbsp;java.util.List&lt;org.joda.time.Interval&gt;&nbsp;toInterval&#8203;(java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;&nbsp;ranges)</pre>
</li>
</ul>
<a id="extractRanges(org.apache.calcite.rex.RexNode,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractRanges</h4>
<pre class="methodSignature">@Nullable
protected static&nbsp;java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;&nbsp;extractRanges&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node,
boolean&nbsp;withNot)</pre>
</li>
</ul>
<a id="leafToRanges(org.apache.calcite.rex.RexCall,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leafToRanges</h4>
<pre class="methodSignature">@Nullable
protected static&nbsp;java.util.List&lt;com.google.common.collect.Range&lt;java.lang.Long&gt;&gt;&nbsp;leafToRanges&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call,
boolean&nbsp;withNot)</pre>
</li>
</ul>
<a id="literalValue(org.apache.calcite.rex.RexNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>literalValue</h4>
<pre class="methodSignature">@Nullable
protected static&nbsp;java.lang.Long&nbsp;literalValue&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node)</pre>
<div class="block">Returns the literal value for the given node, assuming it is a literal with
datetime type, or a cast that only alters nullability on top of a literal with
datetime type.</div>
</li>
</ul>
<a id="extractGranularity(org.apache.calcite.rex.RexNode,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractGranularity</h4>
<pre class="methodSignature">@Nullable
public static&nbsp;<a href="Granularity.html" title="interface in org.apache.calcite.adapter.druid">Granularity</a>&nbsp;extractGranularity&#8203;(<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;node,
java.lang.String&nbsp;timeZone)</pre>
<div class="block">Infers granularity from a time unit.
It supports <code>FLOOR(&lt;time&gt; TO &lt;timeunit&gt;)</code>
and <code>EXTRACT(&lt;timeunit&gt; FROM &lt;time&gt;)</code>.
Returns null if it cannot be inferred.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>node</code> - the Rex node</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the granularity, or null if it cannot be inferred</dd>
</dl>
</li>
</ul>
<a id="toISOPeriodFormat(org.apache.calcite.adapter.druid.Granularity.Type)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toISOPeriodFormat</h4>
<pre class="methodSignature">@Nullable
public static&nbsp;java.lang.String&nbsp;toISOPeriodFormat&#8203;(<a href="Granularity.Type.html" title="enum in org.apache.calcite.adapter.druid">Granularity.Type</a>&nbsp;type)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - Druid Granularity to translate as period of time</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>String representing the granularity as ISO8601 Period of Time, null for unknown case.</dd>
</dl>
</li>
</ul>
<a id="toDruidGranularity(org.apache.calcite.avatica.util.TimeUnitRange)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toDruidGranularity</h4>
<pre class="methodSignature">@Nullable
public static&nbsp;<a href="Granularity.Type.html" title="enum in org.apache.calcite.adapter.druid">Granularity.Type</a>&nbsp;toDruidGranularity&#8203;(org.apache.calcite.avatica.util.TimeUnitRange&nbsp;timeUnit)</pre>
<div class="block">Translates Calcite TimeUnitRange to Druid <a href="Granularity.html" title="interface in org.apache.calcite.adapter.druid"><code>Granularity</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeUnit</code> - Calcite Time unit to convert</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Druid Granularity or null</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DruidDateTimeUtils.html">Use</a></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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>