| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TimeFrameSet.Builder (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, interface: Builder"> |
| <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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.calcite.rel.type</a></div> |
| <h1 title="Interface TimeFrameSet.Builder" class="title">Interface TimeFrameSet.Builder</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="TimeFrameSet.html" title="class in org.apache.calcite.rel.type">TimeFrameSet</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">TimeFrameSet.Builder</span></div> |
| <div class="block">Builds a collection of time frames.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#addAlias(java.lang.String,java.lang.String)" class="member-name-link">addAlias</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> name, |
| <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> originalName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines an alias for an existing frame.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addAll(org.apache.calcite.rel.type.TimeFrameSet)" class="member-name-link">addAll</a><wbr>(<a href="TimeFrameSet.html" title="class in org.apache.calcite.rel.type">TimeFrameSet</a> timeFrameSet)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Adds all time frames in <code>timeFrameSet</code> to this <code>Builder</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#addCore(java.lang.String)" class="member-name-link">addCore</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> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a core time frame.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addDivision(java.lang.String,java.lang.Number,java.lang.String)" class="member-name-link">addDivision</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> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> count, |
| <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> baseName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a time frame such that each base frame consists of <code>count</code> |
| instances of the new frame.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#addMultiple(java.lang.String,java.lang.Number,java.lang.String)" class="member-name-link">addMultiple</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> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> count, |
| <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> baseName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a time frame that consists of <code>count</code> instances of |
| a base frame.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addQuotient(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">addQuotient</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> name, |
| <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> minorName, |
| <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> majorName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a time frame that is the number of a minor unit within a major |
| frame.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#addRollup(java.lang.String,java.lang.String)" class="member-name-link">addRollup</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> fromName, |
| <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> toName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Defines a rollup from one frame to another.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TimeFrameSet.html" title="class in org.apache.calcite.rel.type">TimeFrameSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#build()" class="member-name-link">build</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a <code>TimeFrameSet</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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-tab2 method-summary-table-tab3"><code><a href="#withEpoch(org.apache.calcite.util.TimestampString)" class="member-name-link">withEpoch</a><wbr>(<a href="../../util/TimestampString.html" title="class in org.apache.calcite.util">TimestampString</a> epoch)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Replaces the epoch of the most recently added frame.</div> |
| </div> |
| </div> |
| </div> |
| </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="build()"> |
| <h3>build</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.html" title="class in org.apache.calcite.rel.type">TimeFrameSet</a></span> <span class="element-name">build</span>()</div> |
| <div class="block">Creates a <code>TimeFrameSet</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addCore(java.lang.String)"> |
| <h3>addCore</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addCore</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> name)</span></div> |
| <div class="block">Defines a core time frame.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addQuotient(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>addQuotient</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addQuotient</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> name, |
| <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> minorName, |
| <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> majorName)</span></div> |
| <div class="block">Defines a time frame that is the number of a minor unit within a major |
| frame. For example, the "DOY" frame has minor "DAY" and major "YEAR".</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addMultiple(java.lang.String,java.lang.Number,java.lang.String)"> |
| <h3>addMultiple</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addMultiple</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> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> count, |
| <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> baseName)</span></div> |
| <div class="block">Defines a time frame that consists of <code>count</code> instances of |
| a base frame.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addDivision(java.lang.String,java.lang.Number,java.lang.String)"> |
| <h3>addDivision</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addDivision</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> name, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Number.html" title="class or interface in java.lang" class="external-link">Number</a> count, |
| <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> baseName)</span></div> |
| <div class="block">Defines a time frame such that each base frame consists of <code>count</code> |
| instances of the new frame.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addRollup(java.lang.String,java.lang.String)"> |
| <h3>addRollup</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addRollup</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> fromName, |
| <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> toName)</span></div> |
| <div class="block">Defines a rollup from one frame to another. |
| |
| <p>An explicit rollup is not necessary for frames where one is a multiple |
| of another (such as <code>MILLISECOND</code> to <code>HOUR</code>). Only use this |
| method for frames that are not multiples (such as <code>DAY</code> to |
| <code>MONTH</code>). |
| |
| <p>How do we automatically roll up from say, "minute15" to "hour7"? |
| Because we know the following: |
| <ul> |
| <li>"minute15" and "hour7" are based on the same core frame (seconds); |
| <li>"minute15" is 15 * 60 seconds, "hour7" is 7 * 60 * 60 seconds, |
| and the one divides the other; |
| <li>They have the same offset, 1970-01-01 00:00:00. (Different offsets |
| would be OK too, as they are a whole multiple apart.) |
| </ul> |
| |
| <p>A month is not a fixed multiple of days, but a rollup is still |
| possible, because the start of a month is always aligned with the start |
| of a day. This means that you can compute a month total by adding up the |
| day totals for all days in that month. This is useful if you have an |
| aggregate table on DAY and you want to answer a query on <code>MONTH</code>. |
| |
| <p>There is no rollup from <code>WEEK</code> to <code>YEAR</code>, because of a |
| lack of alignment: a year does not start on the first day of a week, and |
| so you cannot compute the total for, say, the year 2022 by adding the |
| totals for all weeks that fall in 2022. |
| |
| <p>Incidentally, <code>ISOWEEK</code> and <code>ISOYEAR</code> are designed so that |
| <code>ISOWEEK</code> can roll up to <code>ISOYEAR</code>. Every <code>ISOYEAR</code> and |
| <code>ISOWEEK</code> start on a Monday, so they are aligned. An |
| <code>ISOYEAR</code> consists of either 52 or 53 <code>ISOWEEK</code> instances, |
| but the variable multiple is not a problem; the alignment ensures that |
| rollup is valid.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAll(org.apache.calcite.rel.type.TimeFrameSet)"> |
| <h3>addAll</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addAll</span><wbr><span class="parameters">(<a href="TimeFrameSet.html" title="class in org.apache.calcite.rel.type">TimeFrameSet</a> timeFrameSet)</span></div> |
| <div class="block">Adds all time frames in <code>timeFrameSet</code> to this <code>Builder</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="withEpoch(org.apache.calcite.util.TimestampString)"> |
| <h3>withEpoch</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">withEpoch</span><wbr><span class="parameters">(<a href="../../util/TimestampString.html" title="class in org.apache.calcite.util">TimestampString</a> epoch)</span></div> |
| <div class="block">Replaces the epoch of the most recently added frame.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addAlias(java.lang.String,java.lang.String)"> |
| <h3>addAlias</h3> |
| <div class="member-signature"><span class="return-type"><a href="TimeFrameSet.Builder.html" title="interface in org.apache.calcite.rel.type">TimeFrameSet.Builder</a></span> <span class="element-name">addAlias</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> name, |
| <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> originalName)</span></div> |
| <div class="block">Defines an alias for an existing frame. |
| |
| <p>For example, <code>add("Y", "YEAR")</code> adds "Y" as an alias for the |
| built-in frame <code>YEAR</code>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The alias</dd> |
| <dd><code>originalName</code> - Name of the existing frame</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
