| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlPrettyWriter (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.pretty, class: SqlPrettyWriter"> |
| <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="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.pretty</a></div> |
| <h1 title="Class SqlPrettyWriter" class="title">Class SqlPrettyWriter</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.pretty.SqlPrettyWriter</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SqlPrettyWriter</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span></div> |
| <div class="block">Pretty printer for SQL statements. |
| |
| <p>There are several options to control the format. |
| |
| <table> |
| <caption>Formatting options</caption> |
| <tr> |
| <th>Option</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#clauseStartsLine()"><code>SqlWriterConfig.clauseStartsLine()</code></a> ClauseStartsLine}</td> |
| <td>Whether a clause (<code>FROM</code>, <code>WHERE</code>, <code>GROUP BY</code>, |
| <code>HAVING</code>, <code>WINDOW</code>, <code>ORDER BY</code>) starts a new line. |
| <code>SELECT</code> is always at the start of a line.</td> |
| <td>true</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#clauseEndsLine()"><code>ClauseEndsLine</code></a></td> |
| <td>Whether a clause (<code>SELECT</code>, <code>FROM</code>, <code>WHERE</code>, |
| <code>GROUP BY</code>, <code>HAVING</code>, <code>WINDOW</code>, <code>ORDER BY</code>) is |
| followed by a new line.</td> |
| <td>false</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#caseClausesOnNewLines()"><code>CaseClausesOnNewLines</code></a></td> |
| <td>Whether the WHEN, THEN and ELSE clauses of a CASE expression appear at |
| the start of a new line.</td> |
| <td>false</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#indentation()"><code>Indentation</code></a></td> |
| <td>Number of spaces to indent</td> |
| <td>4</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#keywordsLowerCase()"><code>KeywordsLowerCase</code></a></td> |
| <td>Whether to print keywords (SELECT, AS, etc.) in lower-case.</td> |
| <td>false</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#alwaysUseParentheses()"><code>AlwaysUseParentheses</code></a></td> |
| <td><p>Whether to enclose all expressions in parentheses, even if the |
| operator has high enough precedence that the parentheses are not required. |
| |
| <p>For example, the parentheses are required in the expression |
| <code>(a + b) * c</code> because the '*' operator has higher precedence than the |
| '+' operator, and so without the parentheses, the expression would be |
| equivalent to <code>a + (b * c)</code>. The fully-parenthesized expression, |
| <code>((a + b) * c)</code> is unambiguous even if you don't know the precedence |
| of every operator.</td> |
| <td>false</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#quoteAllIdentifiers()"><code>QuoteAllIdentifiers</code></a></td> |
| <td>Whether to quote all identifiers, even those which would be correct |
| according to the rules of the <a href="../SqlDialect.html" title="class in org.apache.calcite.sql"><code>SqlDialect</code></a> if quotation marks were |
| omitted.</td> |
| <td>true</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#subQueryStyle()"><code>SubQueryStyle</code></a></td> |
| <td>Style for formatting sub-queries. Values are: |
| <a href="../SqlWriter.SubQueryStyle.html#HYDE"><code>Hyde</code></a>, |
| <a href="../SqlWriter.SubQueryStyle.html#BLACK"><code>Black</code></a>.</td> |
| |
| <td><a href="../SqlWriter.SubQueryStyle.html#HYDE"><code>Hyde</code></a></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#lineLength()"><code>LineLength</code></a></td> |
| <td>The desired maximum length for lines (to look nice in editors, |
| printouts, etc.).</td> |
| <td>-1 (no maximum)</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#foldLength()"><code>FoldLength</code></a></td> |
| <td>The line length at which lines are folded or chopped down |
| (see <code>LineFolding</code>). Only has an effect if clauses are marked |
| <a href="../SqlWriterConfig.LineFolding.html#CHOP"><code>CHOP</code></a> or |
| <a href="../SqlWriterConfig.LineFolding.html#FOLD"><code>FOLD</code></a>.</td> |
| <td>80</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#lineFolding()"><code>LineFolding</code></a></td> |
| <td>How long lines are to be handled. Options are lines are |
| WIDE (do not wrap), |
| FOLD (wrap if long), |
| CHOP (chop down if long), |
| and TALL (wrap always).</td> |
| <td>WIDE</td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#selectFolding()"><code>SelectFolding</code></a></td> |
| <td>How the <code>SELECT</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#fromFolding()"><code>FromFolding</code></a></td> |
| <td>How the <code>FROM</code> clause and nested <code>JOIN</code> clauses are to be |
| folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#whereFolding()"><code>WhereFolding</code></a></td> |
| <td>How the <code>WHERE</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#groupByFolding()"><code>GroupByFolding</code></a></td> |
| <td>How the <code>GROUP BY</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#havingFolding()"><code>HavingFolding</code></a></td> |
| <td>How the <code>HAVING</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#orderByFolding()"><code>OrderByFolding</code></a></td> |
| <td>How the <code>ORDER BY</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#windowFolding()"><code>WindowFolding</code></a></td> |
| <td>How the <code>WINDOW</code> clause is to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#overFolding()"><code>OverFolding</code></a></td> |
| <td>How window declarations in the <code>WINDOW</code> clause |
| and in the <code>OVER</code> clause of aggregate functions are to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#valuesFolding()"><code>ValuesFolding</code></a></td> |
| <td>How lists of values in the <code>VALUES</code> clause are to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| <tr> |
| <td><a href="../SqlWriterConfig.html#updateSetFolding()"><code>UpdateSetFolding</code></a></td> |
| <td>How assignments in the <code>SET</code> clause of an <code>UPDATE</code> statement |
| are to be folded.</td> |
| <td><code>LineFolding</code></td> |
| </tr> |
| |
| </table> |
| |
| <p>The following options exist for backwards compatibility. They are |
| used if <a href="../SqlWriterConfig.html#lineFolding()"><code>LineFolding</code></a> and clause-specific |
| options such as <a href="../SqlWriterConfig.html#selectFolding()"><code>SelectFolding</code></a> are not |
| specified: |
| |
| <ul> |
| |
| <li><a href="../SqlWriterConfig.html#selectListItemsOnSeparateLines()"><code>SelectListItemsOnSeparateLines</code></a> |
| replaced by <a href="../SqlWriterConfig.html#selectFolding()"><code>SelectFolding</code></a>, |
| <a href="../SqlWriterConfig.html#groupByFolding()"><code>GroupByFolding</code></a>, and |
| <a href="../SqlWriterConfig.html#orderByFolding()"><code>OrderByFolding</code></a>; |
| |
| <li><a href="../SqlWriterConfig.html#updateSetListNewline()"><code>UpdateSetListNewline</code></a> |
| replaced by <a href="../SqlWriterConfig.html#updateSetFolding()"><code>UpdateSetFolding</code></a>; |
| |
| <li><a href="../SqlWriterConfig.html#windowDeclListNewline()"><code>WindowDeclListNewline</code></a> |
| replaced by <a href="../SqlWriterConfig.html#windowFolding()"><code>WindowFolding</code></a>; |
| |
| <li><a href="../SqlWriterConfig.html#windowNewline()"><code>WindowNewline</code></a> |
| replaced by <a href="../SqlWriterConfig.html#overFolding()"><code>OverFolding</code></a>; |
| |
| <li><a href="../SqlWriterConfig.html#valuesListNewline()"><code>ValuesListNewline</code></a> |
| replaced by <a href="../SqlWriterConfig.html#valuesFolding()"><code>ValuesFolding</code></a>. |
| |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected class </code></div> |
| <div class="col-second even-row-color"><code><a href="SqlPrettyWriter.FrameImpl.html" class="type-name-link" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Implementation of <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql"><code>SqlWriter.Frame</code></a>.</div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.calcite.sql.SqlWriter">Nested classes/interfaces inherited from interface org.apache.calcite.sql.<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></h2> |
| <code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a>, <a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a>, <a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a>, <a href="../SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected @Nullable <a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#frame" class="member-name-link">frame</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="../../util/trace/CalciteLogger.html" title="class in org.apache.calcite.util.trace">CalciteLogger</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOGGER" class="member-name-link">LOGGER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected @Nullable <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 even-row-color"><code><a href="#nextWhitespace" class="member-name-link">nextWhitespace</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <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"><code><a href="#NL" class="member-name-link">NL</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.calcite.sql.SqlWriter">Fields inherited from interface org.apache.calcite.sql.<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></h3> |
| <code><a href="../SqlWriter.html#COMMA">COMMA</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SqlPrettyWriter</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a writer with the default configuration.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,boolean)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,boolean,java.io.PrintWriter)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a writer with the given configuration and dialect, |
| and a given print writer (or a private print writer if it is null).</div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlWriterConfig)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a writer with the given configuration, |
| and a private builder.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)" class="member-name-link">SqlPrettyWriter</a><wbr>(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a writer with the given configuration |
| and a given buffer to write to.</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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#config()" class="member-name-link">config</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql"><code>SqlWriterConfig</code></a> with Calcite's SQL dialect.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createListFrame(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">createListFrame</a><wbr>(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| @Nullable <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> keyword, |
| <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> open, |
| <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> close)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Creates a list frame.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#describe(java.io.PrintWriter,boolean)" class="member-name-link">describe</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw, |
| boolean omitDefaults)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints the property settings of this pretty-writer to a writer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#dynamicParam(int)" class="member-name-link">dynamicParam</a><wbr>(int index)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a dynamic parameter (e.g.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)" class="member-name-link">endFunCall</a><wbr>(<a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Ends a list which is a call to a function.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#endList(org.apache.calcite.sql.SqlWriter.Frame)" class="member-name-link">endList</a><wbr>(@Nullable <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Ends a list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)" class="member-name-link">fetchOffset</a><wbr>(@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints the OFFSET/FETCH clause.</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="#format(org.apache.calcite.sql.SqlNode)" class="member-name-link">format</a><wbr>(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDialect()" class="member-name-link">getDialect</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 the dialect of SQL.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getIndentation()" class="member-name-link">getIndentation</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#getLineLength()" class="member-name-link">getLineLength</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#identifier(java.lang.String,boolean)" class="member-name-link">identifier</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, |
| boolean quoted)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints an identifier, quoting as necessary.</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="#inQuery()" class="member-name-link">inQuery</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 we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isAlwaysUseParentheses()" class="member-name-link">isAlwaysUseParentheses</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isClauseStartsLine()" class="member-name-link">isClauseStartsLine</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isKeywordsLowerCase()" class="member-name-link">isKeywordsLowerCase</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isQuoteAllIdentifiers()" class="member-name-link">isQuoteAllIdentifiers</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isSelectListExtraIndentFlag()" class="member-name-link">isSelectListExtraIndentFlag</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isSelectListItemsOnSeparateLines()" class="member-name-link">isSelectListItemsOnSeparateLines</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#isWhereListItemsOnSeparateLines()" class="member-name-link">isWhereListItemsOnSeparateLines</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#keyword(java.lang.String)" class="member-name-link">keyword</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> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a sequence of keywords.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)" class="member-name-link">list</a><wbr>(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)" class="member-name-link">list</a><wbr>(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="../SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="../fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="../fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="../SqlWriter.html#COMMA"><code>COMMA</code></a>).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#literal(java.lang.String)" class="member-name-link">literal</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> s)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a literal, exactly as provided.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newlineAndIndent()" class="member-name-link">newlineAndIndent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a new line, and indents.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newlineAndIndent(int)" class="member-name-link">newlineAndIndent</a><wbr>(int indent)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#print(int)" class="member-name-link">print</a><wbr>(int x)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints an integer.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#print(java.lang.String)" class="member-name-link">print</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> s)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Resets this writer so that it can format another expression.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetSettings()" class="member-name-link">resetSettings</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Resets all properties to their default values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sep(java.lang.String)" class="member-name-link">sep</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> sep)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sep(java.lang.String,boolean)" class="member-name-link">sep</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> sep, |
| boolean printFirst)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes a list separator.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAlwaysUseParentheses(boolean)" class="member-name-link">setAlwaysUseParentheses</a><wbr>(boolean alwaysUseParentheses)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setCaseClausesOnNewLines(boolean)" class="member-name-link">setCaseClausesOnNewLines</a><wbr>(boolean caseClausesOnNewLines)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setClauseStartsLine(boolean)" class="member-name-link">setClauseStartsLine</a><wbr>(boolean clauseStartsLine)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFormatOptions(org.apache.calcite.sql.pretty.SqlFormatOptions)" class="member-name-link">setFormatOptions</a><wbr>(@Nullable <a href="SqlFormatOptions.html" title="class in org.apache.calcite.sql.pretty">SqlFormatOptions</a> options)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setIndentation(int)" class="member-name-link">setIndentation</a><wbr>(int indentation)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setKeywordsLowerCase(boolean)" class="member-name-link">setKeywordsLowerCase</a><wbr>(boolean keywordsLowerCase)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setLineLength(int)" class="member-name-link">setLineLength</a><wbr>(int lineLength)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNeedWhitespace(boolean)" class="member-name-link">setNeedWhitespace</a><wbr>(boolean needWhitespace)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setQuoteAllIdentifiers(boolean)" class="member-name-link">setQuoteAllIdentifiers</a><wbr>(boolean quoteAllIdentifiers)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setSelectListExtraIndentFlag(boolean)" class="member-name-link">setSelectListExtraIndentFlag</a><wbr>(boolean selectListExtraIndentFlag)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setSelectListItemsOnSeparateLines(boolean)" class="member-name-link">setSelectListItemsOnSeparateLines</a><wbr>(boolean b)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSettings(java.util.Properties)" class="member-name-link">setSettings</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets settings from a properties object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setSubQueryStyle(org.apache.calcite.sql.SqlWriter.SubQueryStyle)" class="member-name-link">setSubQueryStyle</a><wbr>(<a href="../SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a> subQueryStyle)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setWhereListItemsOnSeparateLines(boolean)" class="member-name-link">setWhereListItemsOnSeparateLines</a><wbr>(boolean whereListItemsOnSeparateLines)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setWindowDeclListNewline(boolean)" class="member-name-link">setWindowDeclListNewline</a><wbr>(boolean windowDeclListNewline)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setWindowNewline(boolean)" class="member-name-link">setWindowNewline</a><wbr>(boolean windowNewline)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startFunCall(java.lang.String)" class="member-name-link">startFunCall</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> funName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts a list which is a call to a function.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startList(java.lang.String,java.lang.String)" class="member-name-link">startList</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> open, |
| <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> close)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts a list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)" class="member-name-link">startList</a><wbr>(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts a list with no opening string.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">startList</a><wbr>(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| @Nullable <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> keyword, |
| <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> open, |
| <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> close)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts a list.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)" class="member-name-link">startList</a><wbr>(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <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> open, |
| <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> close)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Starts a list.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#tooLong(java.lang.String)" class="member-name-link">tooLong</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> s)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)" class="member-name-link">topN</a><wbr>(@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Prints the TOP(n) clause.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSqlString()" class="member-name-link">toSqlString</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 contents of this writer as a 'certified kocher' SQL string.</div> |
| </div> |
| <div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#whiteSpace()" class="member-name-link">whiteSpace</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOGGER"> |
| <h3>LOGGER</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="../../util/trace/CalciteLogger.html" title="class in org.apache.calcite.util.trace">CalciteLogger</a></span> <span class="element-name">LOGGER</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NL"> |
| <h3>NL</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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">NL</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="frame"> |
| <h3>frame</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@Nullable <a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></span> <span class="element-name">frame</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nextWhitespace"> |
| <h3>nextWhitespace</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">@Nullable <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">nextWhitespace</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</span></div> |
| <div class="block">Creates a writer with the given configuration |
| and a given buffer to write to.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</span></div> |
| <div class="block">Creates a writer with the given configuration and dialect, |
| and a given print writer (or a private print writer if it is null).</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Creates a writer with the given configuration |
| and a private print writer.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlDialect,boolean,java.io.PrintWriter)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlDialect,boolean)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlDialect)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Creates a writer with a given dialect, the default configuration |
| and a private print writer.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.sql.SqlWriterConfig)"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span><wbr><span class="parameters">(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config)</span></div> |
| <div class="block">Creates a writer with the given configuration, |
| and a private builder.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>SqlPrettyWriter</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SqlPrettyWriter</span>()</div> |
| <div class="block">Creates a writer with the default configuration.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#config()"><code>config()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="config()"> |
| <h3>config</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a></span> <span class="element-name">config</span>()</div> |
| <div class="block">Creates a <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql"><code>SqlWriterConfig</code></a> with Calcite's SQL dialect.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCaseClausesOnNewLines(boolean)"> |
| <h3>setCaseClausesOnNewLines</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCaseClausesOnNewLines</span><wbr><span class="parameters">(boolean caseClausesOnNewLines)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSubQueryStyle(org.apache.calcite.sql.SqlWriter.SubQueryStyle)"> |
| <h3>setSubQueryStyle</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSubQueryStyle</span><wbr><span class="parameters">(<a href="../SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a> subQueryStyle)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setWindowNewline(boolean)"> |
| <h3>setWindowNewline</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWindowNewline</span><wbr><span class="parameters">(boolean windowNewline)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setWindowDeclListNewline(boolean)"> |
| <h3>setWindowDeclListNewline</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWindowDeclListNewline</span><wbr><span class="parameters">(boolean windowDeclListNewline)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIndentation()"> |
| <h3>getIndentation</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getIndentation</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#getIndentation()">SqlWriter</a></code></span></div> |
| <div class="block">Returns the offset for each level of indentation. Default 4.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#getIndentation()">getIndentation</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAlwaysUseParentheses()"> |
| <h3>isAlwaysUseParentheses</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isAlwaysUseParentheses</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#isAlwaysUseParentheses()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether to enclose all expressions in parentheses, even if the |
| operator has high enough precedence that the parentheses are not |
| required. |
| |
| <p>For example, the parentheses are required in the expression <code>(a + |
| b) * c</code> because the '*' operator has higher precedence than the '+' |
| operator, and so without the parentheses, the expression would be |
| equivalent to <code>a + (b * c)</code>. The fully-parenthesized |
| expression, <code>((a + b) * c)</code> is unambiguous even if you don't |
| know the precedence of every operator.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#isAlwaysUseParentheses()">isAlwaysUseParentheses</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="inQuery()"> |
| <h3>inQuery</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">inQuery</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#inQuery()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#inQuery()">inQuery</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isQuoteAllIdentifiers()"> |
| <h3>isQuoteAllIdentifiers</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isQuoteAllIdentifiers</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#isQuoteAllIdentifiers()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether this writer should quote all identifiers, even those |
| that do not contain mixed-case identifiers or punctuation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#isQuoteAllIdentifiers()">isQuoteAllIdentifiers</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether to quote all identifiers</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isClauseStartsLine()"> |
| <h3>isClauseStartsLine</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isClauseStartsLine</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#isClauseStartsLine()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether this writer should start each clause (e.g. GROUP BY) on |
| a new line.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#isClauseStartsLine()">isClauseStartsLine</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether to start each clause on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSelectListItemsOnSeparateLines()"> |
| <h3>isSelectListItemsOnSeparateLines</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSelectListItemsOnSeparateLines</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#isSelectListItemsOnSeparateLines()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether the items in the SELECT clause should each be on a |
| separate line.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#isSelectListItemsOnSeparateLines()">isSelectListItemsOnSeparateLines</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether to put each SELECT clause item on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isWhereListItemsOnSeparateLines()"> |
| <h3>isWhereListItemsOnSeparateLines</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isWhereListItemsOnSeparateLines</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSelectListExtraIndentFlag()"> |
| <h3>isSelectListExtraIndentFlag</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSelectListExtraIndentFlag</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isKeywordsLowerCase()"> |
| <h3>isKeywordsLowerCase</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isKeywordsLowerCase</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#isKeywordsLowerCase()">SqlWriter</a></code></span></div> |
| <div class="block">Returns whether to output all keywords (e.g. SELECT, GROUP BY) in lower |
| case.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#isKeywordsLowerCase()">isKeywordsLowerCase</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether to output SQL keywords in lower case</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLineLength()"> |
| <h3>getLineLength</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getLineLength</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetSettings()"> |
| <h3>resetSettings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetSettings</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#resetSettings()">SqlWriter</a></code></span></div> |
| <div class="block">Resets all properties to their default values.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#resetSettings()">resetSettings</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reset()"> |
| <h3>reset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reset</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#reset()">SqlWriter</a></code></span></div> |
| <div class="block">Resets this writer so that it can format another expression. Does not |
| affect formatting preferences (see <a href="../SqlWriter.html#resetSettings()"><code>SqlWriter.resetSettings()</code></a></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#reset()">reset</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIndentation(int)"> |
| <h3>setIndentation</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIndentation</span><wbr><span class="parameters">(int indentation)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="describe(java.io.PrintWriter,boolean)"> |
| <h3>describe</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">describe</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/PrintWriter.html" title="class or interface in java.io" class="external-link">PrintWriter</a> pw, |
| boolean omitDefaults)</span></div> |
| <div class="block">Prints the property settings of this pretty-writer to a writer.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pw</code> - Writer</dd> |
| <dd><code>omitDefaults</code> - Whether to omit properties whose value is the same as |
| the default</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSettings(java.util.Properties)"> |
| <h3>setSettings</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSettings</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> properties)</span></div> |
| <div class="block">Sets settings from a properties object.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setClauseStartsLine(boolean)"> |
| <h3>setClauseStartsLine</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setClauseStartsLine</span><wbr><span class="parameters">(boolean clauseStartsLine)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSelectListItemsOnSeparateLines(boolean)"> |
| <h3>setSelectListItemsOnSeparateLines</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSelectListItemsOnSeparateLines</span><wbr><span class="parameters">(boolean b)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSelectListExtraIndentFlag(boolean)"> |
| <h3>setSelectListExtraIndentFlag</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setSelectListExtraIndentFlag</span><wbr><span class="parameters">(boolean selectListExtraIndentFlag)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setKeywordsLowerCase(boolean)"> |
| <h3>setKeywordsLowerCase</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setKeywordsLowerCase</span><wbr><span class="parameters">(boolean keywordsLowerCase)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setWhereListItemsOnSeparateLines(boolean)"> |
| <h3>setWhereListItemsOnSeparateLines</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setWhereListItemsOnSeparateLines</span><wbr><span class="parameters">(boolean whereListItemsOnSeparateLines)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAlwaysUseParentheses(boolean)"> |
| <h3>setAlwaysUseParentheses</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAlwaysUseParentheses</span><wbr><span class="parameters">(boolean alwaysUseParentheses)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newlineAndIndent()"> |
| <h3>newlineAndIndent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">newlineAndIndent</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#newlineAndIndent()">SqlWriter</a></code></span></div> |
| <div class="block">Prints a new line, and indents.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#newlineAndIndent()">newlineAndIndent</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newlineAndIndent(int)"> |
| <h3>newlineAndIndent</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">newlineAndIndent</span><wbr><span class="parameters">(int indent)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setQuoteAllIdentifiers(boolean)"> |
| <h3>setQuoteAllIdentifiers</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setQuoteAllIdentifiers</span><wbr><span class="parameters">(boolean quoteAllIdentifiers)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createListFrame(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>createListFrame</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></span> <span class="element-name">createListFrame</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| @Nullable <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> keyword, |
| <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> open, |
| <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> close)</span></div> |
| <div class="block">Creates a list frame. |
| |
| <p>Derived classes should override this method to specify the indentation |
| of the list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - What type of list</dd> |
| <dd><code>keyword</code> - The keyword to be printed at the start of the list</dd> |
| <dd><code>open</code> - The string to print at the start of the list</dd> |
| <dd><code>close</code> - The string to print at the end of the list</dd> |
| <dt>Returns:</dt> |
| <dd>A frame</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| @Nullable <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> keyword, |
| <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> open, |
| <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> close)</span></div> |
| <div class="block">Starts a list.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - Type of list. For example, a SELECT list will be |
| governed according to SELECT-list formatting preferences.</dd> |
| <dd><code>open</code> - String to print at the start of the list; typically "(" or |
| the empty string.</dd> |
| <dd><code>close</code> - String to print at the end of the list.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="endList(org.apache.calcite.sql.SqlWriter.Frame)"> |
| <h3>endList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">endList</span><wbr><span class="parameters">(@Nullable <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#endList(org.apache.calcite.sql.SqlWriter.Frame)">SqlWriter</a></code></span></div> |
| <div class="block">Ends a list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#endList(org.apache.calcite.sql.SqlWriter.Frame)">endList</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - The frame which was created by <a href="../SqlWriter.html#startList(java.lang.String,java.lang.String)"><code>SqlWriter.startList(java.lang.String, java.lang.String)</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(org.apache.calcite.sql.SqlNode)"> |
| <h3>format</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">format</span><wbr><span class="parameters">(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toSqlString()"> |
| <h3>toSqlString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="element-name">toSqlString</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#toSqlString()">SqlWriter</a></code></span></div> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#toSqlString()">toSqlString</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>SQL string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDialect()"> |
| <h3>getDialect</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></span> <span class="element-name">getDialect</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#getDialect()">SqlWriter</a></code></span></div> |
| <div class="block">Returns the dialect of SQL.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#getDialect()">getDialect</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>SQL dialect</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="literal(java.lang.String)"> |
| <h3>literal</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">literal</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> s)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#literal(java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Prints a literal, exactly as provided. Does not attempt to indent or |
| convert to upper or lower case. Does not add quotation marks. Adds |
| preceding whitespace if necessary.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#literal(java.lang.String)">literal</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="keyword(java.lang.String)"> |
| <h3>keyword</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">keyword</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> s)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#keyword(java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Prints a sequence of keywords. Must not start or end with space, but may |
| contain a space. For example, <code>keyword("SELECT")</code>, <code> |
| keyword("CHARACTER SET")</code>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#keyword(java.lang.String)">keyword</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="whiteSpace()"> |
| <h3>whiteSpace</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">whiteSpace</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tooLong(java.lang.String)"> |
| <h3>tooLong</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">tooLong</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> s)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="print(java.lang.String)"> |
| <h3>print</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">print</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> s)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#print(java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#print(java.lang.String)">print</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="print(int)"> |
| <h3>print</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">print</span><wbr><span class="parameters">(int x)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#print(int)">SqlWriter</a></code></span></div> |
| <div class="block">Prints an integer.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#print(int)">print</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>x</code> - Integer</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="identifier(java.lang.String,boolean)"> |
| <h3>identifier</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">identifier</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, |
| boolean quoted)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#identifier(java.lang.String,boolean)">SqlWriter</a></code></span></div> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#identifier(java.lang.String,boolean)">identifier</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - The identifier name</dd> |
| <dd><code>quoted</code> - Whether this identifier was quoted in the original sql statement, |
| this may not be the only factor to decide whether this identifier |
| should be quoted</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dynamicParam(int)"> |
| <h3>dynamicParam</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">dynamicParam</span><wbr><span class="parameters">(int index)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#dynamicParam(int)">SqlWriter</a></code></span></div> |
| <div class="block">Prints a dynamic parameter (e.g. <code>?</code> for default JDBC)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#dynamicParam(int)">dynamicParam</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"> |
| <h3>fetchOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">fetchOffset</span><wbr><span class="parameters">(@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">SqlWriter</a></code></span></div> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">fetchOffset</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"> |
| <h3>topN</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">topN</span><wbr><span class="parameters">(@Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| @Nullable <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">SqlWriter</a></code></span></div> |
| <div class="block">Prints the TOP(n) clause.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">topN</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../SqlWriter.html#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)"><code>SqlWriter.fetchOffset(org.apache.calcite.sql.SqlNode, org.apache.calcite.sql.SqlNode)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startFunCall(java.lang.String)"> |
| <h3>startFunCall</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startFunCall</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> funName)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#startFunCall(java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Starts a list which is a call to a function.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#startFunCall(java.lang.String)">startFunCall</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../SqlWriter.html#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"><code>SqlWriter.endFunCall(Frame)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"> |
| <h3>endFunCall</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">endFunCall</span><wbr><span class="parameters">(<a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">SqlWriter</a></code></span></div> |
| <div class="block">Ends a list which is a call to a function.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">endFunCall</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frame</code> - Frame</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../SqlWriter.html#startFunCall(java.lang.String)"><code>SqlWriter.startFunCall(String)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(java.lang.String,java.lang.String)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</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> open, |
| <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> close)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#startList(java.lang.String,java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Starts a list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#startList(java.lang.String,java.lang.String)">startList</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">SqlWriter</a></code></span></div> |
| <div class="block">Starts a list with no opening string.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">startList</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - Type of list. For example, a SELECT list will be |
| governed according to SELECT-list formatting preferences.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)"> |
| <h3>startList</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="element-name">startList</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <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> open, |
| <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> close)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Starts a list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">startList</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>frameType</code> - Type of list. For example, a SELECT list will be |
| governed according to SELECT-list formatting preferences.</dd> |
| <dd><code>open</code> - String to start the list; typically "(" or the empty |
| string.</dd> |
| <dd><code>close</code> - String to close the list</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)"> |
| <h3>list</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="element-name">list</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)">SqlWriter</a></code></span></div> |
| <div class="block">Writes a list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)">list</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)"> |
| <h3>list</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="element-name">list</span><wbr><span class="parameters">(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="../SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="../SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)">SqlWriter</a></code></span></div> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="../fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="../fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="../SqlWriter.html#COMMA"><code>COMMA</code></a>).</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)">list</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sep(java.lang.String)"> |
| <h3>sep</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sep</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> sep)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#sep(java.lang.String)">SqlWriter</a></code></span></div> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#sep(java.lang.String)">sep</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sep</code> - List separator, typically ",".</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sep(java.lang.String,boolean)"> |
| <h3>sep</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">sep</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> sep, |
| boolean printFirst)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#sep(java.lang.String,boolean)">SqlWriter</a></code></span></div> |
| <div class="block">Writes a list separator.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#sep(java.lang.String,boolean)">sep</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>sep</code> - List separator, typically ","</dd> |
| <dd><code>printFirst</code> - Whether to print the first occurrence of the separator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNeedWhitespace(boolean)"> |
| <h3>setNeedWhitespace</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setNeedWhitespace</span><wbr><span class="parameters">(boolean needWhitespace)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../SqlWriter.html#setNeedWhitespace(boolean)">SqlWriter</a></code></span></div> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SqlWriter.html#setNeedWhitespace(boolean)">setNeedWhitespace</a></code> in interface <code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLineLength(int)"> |
| <h3>setLineLength</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLineLength</span><wbr><span class="parameters">(int lineLength)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFormatOptions(org.apache.calcite.sql.pretty.SqlFormatOptions)"> |
| <h3>setFormatOptions</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFormatOptions</span><wbr><span class="parameters">(@Nullable <a href="SqlFormatOptions.html" title="class in org.apache.calcite.sql.pretty">SqlFormatOptions</a> options)</span></div> |
| </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> |