| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlWriter.FrameTypeEnum (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.sql, interface: SqlWriter, enum: FrameTypeEnum"> |
| <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><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#enum-constant-summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#enum-constant-detail">Enum Constants</a> | </li> |
| <li>Field | </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.sql</a></div> |
| <h1 title="Enum SqlWriter.FrameTypeEnum" class="title">Enum SqlWriter.FrameTypeEnum</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"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>> |
| <div class="inheritance">org.apache.calcite.sql.SqlWriter.FrameTypeEnum</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code>, <code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">SqlWriter.FrameTypeEnum</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>> |
| implements <a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></span></div> |
| <div class="block">Enumerates the types of frame.</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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#AS" class="member-name-link">AS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Alias ("AS").</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#CASE" class="member-name-link">CASE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">CASE expression.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#FETCH" class="member-name-link">FETCH</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">FETCH clause.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#FROM_LIST" class="member-name-link">FROM_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">FROM clause (containing various kinds of JOIN).</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#FUN_CALL" class="member-name-link">FUN_CALL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Function call or datatype declaration.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#FUN_DECL" class="member-name-link">FUN_DECL</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Function declaration.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#GROUP_BY_LIST" class="member-name-link">GROUP_BY_LIST</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">GROUP BY list.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#IDENTIFIER" class="member-name-link">IDENTIFIER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Compound identifier.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#JOIN" class="member-name-link">JOIN</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Pair-wise join.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#OFFSET" class="member-name-link">OFFSET</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">OFFSET clause.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#ORDER_BY" class="member-name-link">ORDER_BY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">ORDER BY clause of a SELECT statement.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#ORDER_BY_LIST" class="member-name-link">ORDER_BY_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">ORDER BY list.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#OTHER" class="member-name-link">OTHER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Same behavior as user-defined frame type.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#PARENTHESES" class="member-name-link">PARENTHESES</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Comma-separated list surrounded by parentheses.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SELECT" class="member-name-link">SELECT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">SELECT query (or UPDATE or DELETE).</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#SELECT_LIST" class="member-name-link">SELECT_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The SELECT clause of a SELECT statement.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SETOP" class="member-name-link">SETOP</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Set operation.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#SIMPLE" class="member-name-link">SIMPLE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Simple list.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#SUB_QUERY" class="member-name-link">SUB_QUERY</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Sub-query list.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#UPDATE_SET_LIST" class="member-name-link">UPDATE_SET_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The SET clause of an UPDATE statement.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#VALUES" class="member-name-link">VALUES</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">VALUES clause.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#WHERE_LIST" class="member-name-link">WHERE_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">WHERE clause.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#WINDOW" class="member-name-link">WINDOW</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Window specification.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#WINDOW_DECL_LIST" class="member-name-link">WINDOW_DECL_LIST</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The WINDOW clause of a SELECT statement.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#WITH" class="member-name-link">WITH</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">WITH clause of a SELECT statement.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#WITH_BODY" class="member-name-link">WITH_BODY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The body query of WITH.</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-tab1 method-summary-table-tab4"><code>static <a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(java.lang.String)" class="member-name-link">create</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-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a frame type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName()" class="member-name-link">getName</a>()</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 name of this frame type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#needsIndent()" class="member-name-link">needsIndent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns whether this frame type should cause the code be further |
| indented.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</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 odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.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/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.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/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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#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#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#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"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="SELECT"> |
| <h3>SELECT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">SELECT</span></div> |
| <div class="block">SELECT query (or UPDATE or DELETE). The items in the list are the |
| clauses: FROM, WHERE, etc.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SIMPLE"> |
| <h3>SIMPLE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">SIMPLE</span></div> |
| <div class="block">Simple list.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PARENTHESES"> |
| <h3>PARENTHESES</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">PARENTHESES</span></div> |
| <div class="block">Comma-separated list surrounded by parentheses. |
| The parentheses are present even if the list is empty.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SELECT_LIST"> |
| <h3>SELECT_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">SELECT_LIST</span></div> |
| <div class="block">The SELECT clause of a SELECT statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WINDOW_DECL_LIST"> |
| <h3>WINDOW_DECL_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">WINDOW_DECL_LIST</span></div> |
| <div class="block">The WINDOW clause of a SELECT statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="UPDATE_SET_LIST"> |
| <h3>UPDATE_SET_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">UPDATE_SET_LIST</span></div> |
| <div class="block">The SET clause of an UPDATE statement.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FUN_DECL"> |
| <h3>FUN_DECL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">FUN_DECL</span></div> |
| <div class="block">Function declaration.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FUN_CALL"> |
| <h3>FUN_CALL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">FUN_CALL</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WINDOW"> |
| <h3>WINDOW</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">WINDOW</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ORDER_BY"> |
| <h3>ORDER_BY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">ORDER_BY</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="ORDER_BY_LIST"> |
| <h3>ORDER_BY_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">ORDER_BY_LIST</span></div> |
| <div class="block">ORDER BY list. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>ORDER BY x, y DESC, z</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WITH"> |
| <h3>WITH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">WITH</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WITH_BODY"> |
| <h3>WITH_BODY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">WITH_BODY</span></div> |
| <div class="block">The body query of WITH.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OFFSET"> |
| <h3>OFFSET</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">OFFSET</span></div> |
| <div class="block">OFFSET clause. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>OFFSET 10 ROWS</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FETCH"> |
| <h3>FETCH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">FETCH</span></div> |
| <div class="block">FETCH clause. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>FETCH FIRST 3 ROWS ONLY</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="GROUP_BY_LIST"> |
| <h3>GROUP_BY_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">GROUP_BY_LIST</span></div> |
| <div class="block">GROUP BY list. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>GROUP BY x, FLOOR(y)</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SUB_QUERY"> |
| <h3>SUB_QUERY</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">SUB_QUERY</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SETOP"> |
| <h3>SETOP</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">SETOP</span></div> |
| <div class="block">Set operation. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>SELECT * FROM a UNION SELECT * FROM b</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="VALUES"> |
| <h3>VALUES</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">VALUES</span></div> |
| <div class="block">VALUES clause. |
| |
| <p>Example: |
| |
| <blockquote><pre>VALUES (1, 'a'), |
| (2, 'b')</pre></blockquote></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FROM_LIST"> |
| <h3>FROM_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">FROM_LIST</span></div> |
| <div class="block">FROM clause (containing various kinds of JOIN).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="JOIN"> |
| <h3>JOIN</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">JOIN</span></div> |
| <div class="block">Pair-wise join.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WHERE_LIST"> |
| <h3>WHERE_LIST</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">WHERE_LIST</span></div> |
| <div class="block">WHERE clause.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IDENTIFIER"> |
| <h3>IDENTIFIER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">IDENTIFIER</span></div> |
| <div class="block">Compound identifier. |
| |
| <p>Example:</p> |
| <ul> |
| <li><code>"A"."B"."C"</code></li> |
| </ul></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AS"> |
| <h3>AS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">AS</span></div> |
| <div class="block">Alias ("AS"). No indent.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CASE"> |
| <h3>CASE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">CASE</span></div> |
| <div class="block">CASE expression.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="OTHER"> |
| <h3>OTHER</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">OTHER</span></div> |
| <div class="block">Same behavior as user-defined frame type.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span> <span class="element-name">valueOf</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">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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><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">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="needsIndent()"> |
| <h3>needsIndent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">needsIndent</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlWriter.FrameType.html#needsIndent()">needsIndent</a></code> in interface <code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether to further indent code within a frame of this type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="create(java.lang.String)"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></span> <span class="element-name">create</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">Creates a frame type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - Name</dd> |
| <dt>Returns:</dt> |
| <dd>frame type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">getName</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="SqlWriter.FrameType.html#getName()">getName</a></code> in interface <code><a href="SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>name</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> |
