blob: a84e0a156dd0a80669e377e4b5d9f1194f0d02aa [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SqlWriter.FrameTypeEnum (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="SqlWriter.FrameTypeEnum (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":10,"i2":10,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/SqlWriter.FrameTypeEnum.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="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</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.sql</a></div>
<h2 title="Enum SqlWriter.FrameTypeEnum" class="title">Enum SqlWriter.FrameTypeEnum</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Enum&lt;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.sql.SqlWriter.FrameTypeEnum</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code>java.lang.Comparable&lt;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&gt;</code>, <code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></dd>
</dl>
<hr>
<pre>public static enum <span class="typeNameLabel">SqlWriter.FrameTypeEnum</span>
extends java.lang.Enum&lt;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&gt;
implements <a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></pre>
<div class="block">Enumerates the types of frame.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.summary">
<!-- -->
</a>
<h3>Enum Constant Summary</h3>
<table class="memberSummary">
<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum Constant</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FETCH">FETCH</a></span></code></th>
<td class="colLast">
<div class="block">FETCH clause.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FROM_LIST">FROM_LIST</a></span></code></th>
<td class="colLast">
<div class="block">FROM clause (containing various kinds of JOIN).</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FUN_CALL">FUN_CALL</a></span></code></th>
<td class="colLast">
<div class="block">Function call or datatype declaration.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#FUN_DECL">FUN_DECL</a></span></code></th>
<td class="colLast">
<div class="block">Function declaration.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#GROUP_BY_LIST">GROUP_BY_LIST</a></span></code></th>
<td class="colLast">
<div class="block">GROUP BY list.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#IDENTIFIER">IDENTIFIER</a></span></code></th>
<td class="colLast">
<div class="block">Compound identifier.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#JOIN">JOIN</a></span></code></th>
<td class="colLast">
<div class="block">Pair-wise join.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#OFFSET">OFFSET</a></span></code></th>
<td class="colLast">
<div class="block">OFFSET clause.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ORDER_BY">ORDER_BY</a></span></code></th>
<td class="colLast">
<div class="block">ORDER BY clause of a SELECT statement.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#ORDER_BY_LIST">ORDER_BY_LIST</a></span></code></th>
<td class="colLast">
<div class="block">ORDER BY list.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SELECT">SELECT</a></span></code></th>
<td class="colLast">
<div class="block">SELECT query (or UPDATE or DELETE).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SELECT_LIST">SELECT_LIST</a></span></code></th>
<td class="colLast">
<div class="block">The SELECT clause of a SELECT statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SETOP">SETOP</a></span></code></th>
<td class="colLast">
<div class="block">Set operation.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SIMPLE">SIMPLE</a></span></code></th>
<td class="colLast">
<div class="block">Simple list.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#SUB_QUERY">SUB_QUERY</a></span></code></th>
<td class="colLast">
<div class="block">Sub-query list.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#UPDATE_SET_LIST">UPDATE_SET_LIST</a></span></code></th>
<td class="colLast">
<div class="block">The SET clause of an UPDATE statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#VALUES">VALUES</a></span></code></th>
<td class="colLast">
<div class="block">VALUES clause.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#WHERE_LIST">WHERE_LIST</a></span></code></th>
<td class="colLast">
<div class="block">WHERE clause.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#WINDOW">WINDOW</a></span></code></th>
<td class="colLast">
<div class="block">Window specification.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#WINDOW_DECL_LIST">WINDOW_DECL_LIST</a></span></code></th>
<td class="colLast">
<div class="block">The WINDOW clause of a SELECT statement.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#WITH">WITH</a></span></code></th>
<td class="colLast">
<div class="block">WITH clause of a SELECT statement.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#needsIndent">needsIndent</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()">FrameTypeEnum</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a list type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(boolean)">FrameTypeEnum</a></span>&#8203;(boolean&nbsp;needsIndent)</code></th>
<td class="colLast">
<div class="block">Creates a list type.</div>
</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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 <a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String)">create</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Creates a frame type.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the name of this frame type.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#needsIndent()">needsIndent</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether this frame type should cause the code be further
indented.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.lang.String)">valueOf</a></span>&#8203;(java.lang.String&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#values()">values</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Enum">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li>
</ul>
<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>getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="enum.constant.detail">
<!-- -->
</a>
<h3>Enum Constant Detail</h3>
<a id="SELECT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SELECT</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> SELECT</pre>
<div class="block">SELECT query (or UPDATE or DELETE). The items in the list are the
clauses: FROM, WHERE, etc.</div>
</li>
</ul>
<a id="SIMPLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SIMPLE</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> SIMPLE</pre>
<div class="block">Simple list.</div>
</li>
</ul>
<a id="SELECT_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SELECT_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> SELECT_LIST</pre>
<div class="block">The SELECT clause of a SELECT statement.</div>
</li>
</ul>
<a id="WINDOW_DECL_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WINDOW_DECL_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> WINDOW_DECL_LIST</pre>
<div class="block">The WINDOW clause of a SELECT statement.</div>
</li>
</ul>
<a id="UPDATE_SET_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UPDATE_SET_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> UPDATE_SET_LIST</pre>
<div class="block">The SET clause of an UPDATE statement.</div>
</li>
</ul>
<a id="FUN_DECL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUN_DECL</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> FUN_DECL</pre>
<div class="block">Function declaration.</div>
</li>
</ul>
<a id="FUN_CALL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUN_CALL</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> FUN_CALL</pre>
<div class="block">Function call or datatype declaration.
<p>Examples:</p>
<ul>
<li><code>SUBSTRING('foobar' FROM 1 + 2 TO 4)</code></li>
<li><code>DECIMAL(10, 5)</code></li>
</ul></div>
</li>
</ul>
<a id="WINDOW">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WINDOW</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> WINDOW</pre>
<div class="block">Window specification.
<p>Examples:</p>
<ul>
<li><code>SUM(x) OVER (ORDER BY hireDate ROWS 3 PRECEDING)</code></li>
<li><code>WINDOW w1 AS (ORDER BY hireDate), w2 AS (w1 PARTITION BY gender
RANGE BETWEEN INTERVAL '1' YEAR PRECEDING AND '2' MONTH
PRECEDING)</code></li>
</ul></div>
</li>
</ul>
<a id="ORDER_BY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ORDER_BY</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> ORDER_BY</pre>
<div class="block">ORDER BY clause of a SELECT statement. The "list" has only two items:
the query and the order by clause, with ORDER BY as the separator.</div>
</li>
</ul>
<a id="ORDER_BY_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ORDER_BY_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> ORDER_BY_LIST</pre>
<div class="block">ORDER BY list.
<p>Example:</p>
<ul>
<li><code>ORDER BY x, y DESC, z</code></li>
</ul></div>
</li>
</ul>
<a id="WITH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WITH</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> WITH</pre>
<div class="block">WITH clause of a SELECT statement. The "list" has only two items:
the WITH clause and the query, with AS as the separator.</div>
</li>
</ul>
<a id="OFFSET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OFFSET</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> OFFSET</pre>
<div class="block">OFFSET clause.
<p>Example:</p>
<ul>
<li><code>OFFSET 10 ROWS</code></li>
</ul></div>
</li>
</ul>
<a id="FETCH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FETCH</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> FETCH</pre>
<div class="block">FETCH clause.
<p>Example:</p>
<ul>
<li><code>FETCH FIRST 3 ROWS ONLY</code></li>
</ul></div>
</li>
</ul>
<a id="GROUP_BY_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GROUP_BY_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> GROUP_BY_LIST</pre>
<div class="block">GROUP BY list.
<p>Example:</p>
<ul>
<li><code>GROUP BY x, FLOOR(y)</code></li>
</ul></div>
</li>
</ul>
<a id="SUB_QUERY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SUB_QUERY</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> SUB_QUERY</pre>
<div class="block">Sub-query list. Encloses a SELECT, UNION, EXCEPT, INTERSECT query
with optional ORDER BY.
<p>Example:</p>
<ul>
<li><code>GROUP BY x, FLOOR(y)</code></li>
</ul></div>
</li>
</ul>
<a id="SETOP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SETOP</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> SETOP</pre>
<div class="block">Set operation.
<p>Example:</p>
<ul>
<li><code>SELECT * FROM a UNION SELECT * FROM b</code></li>
</ul></div>
</li>
</ul>
<a id="VALUES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUES</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> VALUES</pre>
<div class="block">VALUES clause.
<p>Example:
<blockquote><pre>VALUES (1, 'a'),
(2, 'b')</pre></blockquote></div>
</li>
</ul>
<a id="FROM_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FROM_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> FROM_LIST</pre>
<div class="block">FROM clause (containing various kinds of JOIN).</div>
</li>
</ul>
<a id="JOIN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JOIN</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> JOIN</pre>
<div class="block">Pair-wise join.</div>
</li>
</ul>
<a id="WHERE_LIST">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WHERE_LIST</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> WHERE_LIST</pre>
<div class="block">WHERE clause.</div>
</li>
</ul>
<a id="IDENTIFIER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IDENTIFIER</h4>
<pre>public static final&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> IDENTIFIER</pre>
<div class="block">Compound identifier.
<p>Example:</p>
<ul>
<li><code>"A"."B"."C"</code></li>
</ul></div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="needsIndent">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>needsIndent</h4>
<pre>private final&nbsp;boolean needsIndent</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="blockList">
<li class="blockList">
<h4>FrameTypeEnum</h4>
<pre>private&nbsp;FrameTypeEnum()</pre>
<div class="block">Creates a list type.</div>
</li>
</ul>
<a id="&lt;init&gt;(boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FrameTypeEnum</h4>
<pre>private&nbsp;FrameTypeEnum&#8203;(boolean&nbsp;needsIndent)</pre>
<div class="block">Creates a list type.</div>
</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="values()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>values</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>[]&nbsp;values()</pre>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared. This method may be used to iterate
over the constants as follows:
<pre>
for (SqlWriter.FrameTypeEnum c : SqlWriter.FrameTypeEnum.values())
&nbsp; System.out.println(c);
</pre></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an array containing the constants of this enum type, in the order they are declared</dd>
</dl>
</li>
</ul>
<a id="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Returns the enum constant of this type with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this type. (Extraneous whitespace characters are
not permitted.)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the enum constant with the specified name</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
</dl>
</li>
</ul>
<a id="needsIndent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>needsIndent</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;needsIndent()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="SqlWriter.FrameType.html#needsIndent()">SqlWriter.FrameType</a></code></span></div>
<div class="block">Returns whether this frame type should cause the code be further
indented.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SqlWriter.FrameType.html#needsIndent()">needsIndent</a></code>&nbsp;in interface&nbsp;<code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether to further indent code within a frame of this type</dd>
</dl>
</li>
</ul>
<a id="create(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a>&nbsp;create&#8203;(java.lang.String&nbsp;name)</pre>
<div class="block">Creates a frame type.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>frame type</dd>
</dl>
</li>
</ul>
<a id="getName()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="SqlWriter.FrameType.html#getName()">SqlWriter.FrameType</a></code></span></div>
<div class="block">Returns the name of this frame type.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="SqlWriter.FrameType.html#getName()">getName</a></code>&nbsp;in interface&nbsp;<code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>name</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/SqlWriter.FrameTypeEnum.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="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</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>