| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SqlPrettyWriter (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":42,"i11":10,"i12":10,"i13":42,"i14":42,"i15":42,"i16":42,"i17":42,"i18":42,"i19":42,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":42,"i33":42,"i34":42,"i35":10,"i36":42,"i37":42,"i38":42,"i39":10,"i40":42,"i41":42,"i42":42,"i43":10,"i44":42,"i45":42,"i46":42,"i47":42,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">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="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.sql.pretty.SqlPrettyWriter</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SqlPrettyWriter</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></pre> |
| <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="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql"><code>SqlWriter.Frame</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h2>Nested classes/interfaces inherited from interface org.apache.calcite.sql.<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></h2> |
| <a id="nested.classes.inherited.from.class.org.apache.calcite.sql.SqlWriter"> |
| <!-- --> |
| </a><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 class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#frame">frame</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="../../util/trace/CalciteLogger.html" title="class in org.apache.calcite.util.trace">CalciteLogger</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOGGER">LOGGER</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextWhitespace">nextWhitespace</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NL">NL</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="inheritedList"> |
| <h3>Fields inherited from interface org.apache.calcite.sql.<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></h3> |
| <a id="fields.inherited.from.class.org.apache.calcite.sql.SqlWriter"> |
| <!-- --> |
| </a><code><a href="../SqlWriter.html#COMMA">COMMA</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="constructorSummary"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h2>Constructor Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SqlPrettyWriter</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a writer with the default configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect)">SqlPrettyWriter</a></span>​(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,boolean)">SqlPrettyWriter</a></span>​(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,boolean,java.io.PrintWriter)">SqlPrettyWriter</a></span>​(<a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io" class="externalLink">PrintWriter</a> pw)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig)">SqlPrettyWriter</a></span>​(<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></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)">SqlPrettyWriter</a></span>​(<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/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">StringBuilder</a> buf)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlWriterConfig)">SqlPrettyWriter</a></span>​(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a writer with the given configuration, |
| and a private builder.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)">SqlPrettyWriter</a></span>​(<a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">StringBuilder</a> buf)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a writer with the given configuration |
| and a given buffer to write to.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#config()">config</a></span>()</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>protected <a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createListFrame(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)">createListFrame</a></span>​(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> keyword, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list frame.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describe(java.io.PrintWriter,boolean)">describe</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io" class="externalLink">PrintWriter</a> pw, |
| boolean omitDefaults)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints the property settings of this pretty-writer to a writer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dynamicParam(int)">dynamicParam</a></span>​(int index)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a dynamic parameter (e.g.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">endFunCall</a></span>​(<a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Ends a list which is a call to a function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#endList(org.apache.calcite.sql.SqlWriter.Frame)">endList</a></span>​(<a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code></th> |
| <td class="colLast"> |
| <div class="block">Ends a list.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">fetchOffset</a></span>​(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#format(org.apache.calcite.sql.SqlNode)">format</a></span>​(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDialect()">getDialect</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the dialect of SQL.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndentation()">getIndentation</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLineLength()">getLineLength</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#identifier(java.lang.String,boolean)">identifier</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| boolean quoted)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inQuery()">inQuery</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns whether we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAlwaysUseParentheses()">isAlwaysUseParentheses</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isClauseStartsLine()">isClauseStartsLine</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isKeywordsLowerCase()">isKeywordsLowerCase</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isQuoteAllIdentifiers()">isQuoteAllIdentifiers</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSelectListExtraIndentFlag()">isSelectListExtraIndentFlag</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isSelectListItemsOnSeparateLines()">isSelectListItemsOnSeparateLines</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isWhereListItemsOnSeparateLines()">isWhereListItemsOnSeparateLines</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyword(java.lang.String)">keyword</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a sequence of keywords.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)">list</a></span>​(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a list.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)">list</a></span>​(<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></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#literal(java.lang.String)">literal</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a literal, exactly as provided.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newlineAndIndent()">newlineAndIndent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a new line, and indents.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newlineAndIndent(int)">newlineAndIndent</a></span>​(int indent)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#print(int)">print</a></span>​(int x)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints an integer.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#print(java.lang.String)">print</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets this writer so that it can format another expression.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetSettings()">resetSettings</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets all properties to their default values.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sep(java.lang.String)">sep</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sep)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sep(java.lang.String,boolean)">sep</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sep, |
| boolean printFirst)</code></th> |
| <td class="colLast"> |
| <div class="block">Writes a list separator.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAlwaysUseParentheses(boolean)">setAlwaysUseParentheses</a></span>​(boolean alwaysUseParentheses)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCaseClausesOnNewLines(boolean)">setCaseClausesOnNewLines</a></span>​(boolean caseClausesOnNewLines)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setClauseStartsLine(boolean)">setClauseStartsLine</a></span>​(boolean clauseStartsLine)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFormatOptions(org.apache.calcite.sql.pretty.SqlFormatOptions)">setFormatOptions</a></span>​(<a href="SqlFormatOptions.html" title="class in org.apache.calcite.sql.pretty">SqlFormatOptions</a> options)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIndentation(int)">setIndentation</a></span>​(int indentation)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeywordsLowerCase(boolean)">setKeywordsLowerCase</a></span>​(boolean keywordsLowerCase)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLineLength(int)">setLineLength</a></span>​(int lineLength)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNeedWhitespace(boolean)">setNeedWhitespace</a></span>​(boolean needWhitespace)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQuoteAllIdentifiers(boolean)">setQuoteAllIdentifiers</a></span>​(boolean quoteAllIdentifiers)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSelectListExtraIndentFlag(boolean)">setSelectListExtraIndentFlag</a></span>​(boolean selectListExtraIndentFlag)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSelectListItemsOnSeparateLines(boolean)">setSelectListItemsOnSeparateLines</a></span>​(boolean b)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSettings(java.util.Properties)">setSettings</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink">Properties</a> properties)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets settings from a properties object.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSubQueryStyle(org.apache.calcite.sql.SqlWriter.SubQueryStyle)">setSubQueryStyle</a></span>​(<a href="../SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a> subQueryStyle)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWhereListItemsOnSeparateLines(boolean)">setWhereListItemsOnSeparateLines</a></span>​(boolean whereListItemsOnSeparateLines)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWindowDeclListNewline(boolean)">setWindowDeclListNewline</a></span>​(boolean windowDeclListNewline)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i47"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setWindowNewline(boolean)">setWindowNewline</a></span>​(boolean windowNewline)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i48"> |
| <td class="colFirst"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startFunCall(java.lang.String)">startFunCall</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> funName)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts a list which is a call to a function.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i49"> |
| <td class="colFirst"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(java.lang.String,java.lang.String)">startList</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts a list.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i50"> |
| <td class="colFirst"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">startList</a></span>​(<a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts a list with no opening string.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i51"> |
| <td class="colFirst"><code><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">startList</a></span>​(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts a list.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i52"> |
| <td class="colFirst"><code>protected <a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)">startList</a></span>​(<a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> keyword, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts a list.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i53"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#tooLong(java.lang.String)">tooLong</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i54"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">topN</a></span>​(<a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code></th> |
| <td class="colLast"> |
| <div class="block">Prints the TOP(n) clause.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i55"> |
| <td class="colFirst"><code><a href="../util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toSqlString()">toSqlString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i56"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i57"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#whiteSpace()">whiteSpace</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="LOGGER">LOGGER</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType"><a href="../../util/trace/CalciteLogger.html" title="class in org.apache.calcite.util.trace">CalciteLogger</a></span> <span class="memberName">LOGGER</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="NL">NL</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected static final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">NL</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="frame">frame</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></span> <span class="memberName">frame</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="nextWhitespace">nextWhitespace</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">nextWhitespace</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li class="blockList"> |
| <section class="constructorDetails"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h2>Constructor Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| <a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a> config, |
| <a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig,java.lang.StringBuilder)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><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/javase/9/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlDialect,org.apache.calcite.sql.SqlWriterConfig)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><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="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block">Creates a writer with the given configuration |
| and a private print writer.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlDialect,boolean,java.io.PrintWriter)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io" class="externalLink">PrintWriter</a> pw)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlDialect,boolean)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect, |
| boolean alwaysUseParentheses)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlDialect)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> dialect)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>(org.apache.calcite.sql.SqlWriterConfig)">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| <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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="<init>()">SqlPrettyWriter</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">SqlPrettyWriter</span>()</div> |
| <div class="block">Creates a writer with the default configuration.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#config()"><code>config()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="config()">config</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="../SqlWriterConfig.html" title="interface in org.apache.calcite.sql">SqlWriterConfig</a></span> <span class="memberName">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="setCaseClausesOnNewLines(boolean)">setCaseClausesOnNewLines</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setCaseClausesOnNewLines</span>​(<span class="arguments">boolean caseClausesOnNewLines)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setSubQueryStyle(org.apache.calcite.sql.SqlWriter.SubQueryStyle)">setSubQueryStyle</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setSubQueryStyle</span>​(<span class="arguments"><a href="../SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a> subQueryStyle)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setWindowNewline(boolean)">setWindowNewline</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setWindowNewline</span>​(<span class="arguments">boolean windowNewline)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setWindowDeclListNewline(boolean)">setWindowDeclListNewline</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setWindowDeclListNewline</span>​(<span class="arguments">boolean windowDeclListNewline)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getIndentation()">getIndentation</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getIndentation</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="isAlwaysUseParentheses()">isAlwaysUseParentheses</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isAlwaysUseParentheses</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="inQuery()">inQuery</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">inQuery</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="isQuoteAllIdentifiers()">isQuoteAllIdentifiers</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isQuoteAllIdentifiers</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to quote all identifiers</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isClauseStartsLine()">isClauseStartsLine</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isClauseStartsLine</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to start each clause on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isSelectListItemsOnSeparateLines()">isSelectListItemsOnSeparateLines</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isSelectListItemsOnSeparateLines</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to put each SELECT clause item on a new line</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isWhereListItemsOnSeparateLines()">isWhereListItemsOnSeparateLines</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isWhereListItemsOnSeparateLines</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isSelectListExtraIndentFlag()">isSelectListExtraIndentFlag</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isSelectListExtraIndentFlag</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isKeywordsLowerCase()">isKeywordsLowerCase</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isKeywordsLowerCase</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to output SQL keywords in lower case</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getLineLength()">getLineLength</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">getLineLength</span>()</div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="resetSettings()">resetSettings</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">resetSettings</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="reset()">reset</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">reset</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="setIndentation(int)">setIndentation</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setIndentation</span>​(<span class="arguments">int indentation)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="describe(java.io.PrintWriter,boolean)">describe</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">describe</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io" class="externalLink">PrintWriter</a> pw, |
| boolean omitDefaults)</span></div> |
| <div class="block">Prints the property settings of this pretty-writer to a writer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="setSettings(java.util.Properties)">setSettings</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setSettings</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util" class="externalLink">Properties</a> properties)</span></div> |
| <div class="block">Sets settings from a properties object.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setClauseStartsLine(boolean)">setClauseStartsLine</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setClauseStartsLine</span>​(<span class="arguments">boolean clauseStartsLine)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setSelectListItemsOnSeparateLines(boolean)">setSelectListItemsOnSeparateLines</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setSelectListItemsOnSeparateLines</span>​(<span class="arguments">boolean b)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setSelectListExtraIndentFlag(boolean)">setSelectListExtraIndentFlag</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setSelectListExtraIndentFlag</span>​(<span class="arguments">boolean selectListExtraIndentFlag)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setKeywordsLowerCase(boolean)">setKeywordsLowerCase</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setKeywordsLowerCase</span>​(<span class="arguments">boolean keywordsLowerCase)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setWhereListItemsOnSeparateLines(boolean)">setWhereListItemsOnSeparateLines</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setWhereListItemsOnSeparateLines</span>​(<span class="arguments">boolean whereListItemsOnSeparateLines)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setAlwaysUseParentheses(boolean)">setAlwaysUseParentheses</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setAlwaysUseParentheses</span>​(<span class="arguments">boolean alwaysUseParentheses)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="newlineAndIndent()">newlineAndIndent</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">newlineAndIndent</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="newlineAndIndent(int)">newlineAndIndent</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">newlineAndIndent</span>​(<span class="arguments">int indent)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setQuoteAllIdentifiers(boolean)">setQuoteAllIdentifiers</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setQuoteAllIdentifiers</span>​(<span class="arguments">boolean quoteAllIdentifiers)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createListFrame(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)">createListFrame</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="SqlPrettyWriter.FrameImpl.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter.FrameImpl</a></span> <span class="memberName">createListFrame</span>​(<span class="arguments"><a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> keyword, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>A frame</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String,java.lang.String)">startList</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="memberName">startList</span>​(<span class="arguments"><a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> keyword, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</span></div> |
| <div class="block">Starts a list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="endList(org.apache.calcite.sql.SqlWriter.Frame)">endList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">endList</span>​(<span class="arguments"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="format(org.apache.calcite.sql.SqlNode)">format</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">format</span>​(<span class="arguments"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> node)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toSqlString()">toSqlString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></span> <span class="memberName">toSqlString</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>SQL string</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getDialect()">getDialect</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></span> <span class="memberName">getDialect</span>()</div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>SQL dialect</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="literal(java.lang.String)">literal</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">literal</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="keyword(java.lang.String)">keyword</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">keyword</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="whiteSpace()">whiteSpace</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">void</span> <span class="memberName">whiteSpace</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="tooLong(java.lang.String)">tooLong</a></h3> |
| <div class="memberSignature"><span class="modifiers">protected</span> <span class="returnType">boolean</span> <span class="memberName">tooLong</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="print(java.lang.String)">print</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">print</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> s)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="print(int)">print</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">print</span>​(<span class="arguments">int x)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../SqlWriter.html#print(int)">SqlWriter</a></code></span></div> |
| <div class="block">Prints an integer.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - Integer</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="identifier(java.lang.String,boolean)">identifier</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">identifier</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, |
| boolean quoted)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="dynamicParam(int)">dynamicParam</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">dynamicParam</span>​(<span class="arguments">int index)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="fetchOffset(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">fetchOffset</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">fetchOffset</span>​(<span class="arguments"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="topN(org.apache.calcite.sql.SqlNode,org.apache.calcite.sql.SqlNode)">topN</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">topN</span>​(<span class="arguments"><a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><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></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="startFunCall(java.lang.String)">startFunCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="memberName">startFunCall</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> funName)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../SqlWriter.html#endFunCall(org.apache.calcite.sql.SqlWriter.Frame)"><code>SqlWriter.endFunCall(Frame)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="endFunCall(org.apache.calcite.sql.SqlWriter.Frame)">endFunCall</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">endFunCall</span>​(<span class="arguments"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - Frame</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../SqlWriter.html#startFunCall(java.lang.String)"><code>SqlWriter.startFunCall(String)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="startList(java.lang.String,java.lang.String)">startList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="memberName">startList</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="startList(org.apache.calcite.sql.SqlWriter.FrameTypeEnum)">startList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="memberName">startList</span>​(<span class="arguments"><a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="startList(org.apache.calcite.sql.SqlWriter.FrameType,java.lang.String,java.lang.String)">startList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span> <span class="memberName">startList</span>​(<span class="arguments"><a href="../SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> open, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> close)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,java.util.function.Consumer)">list</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="memberName">list</span>​(<span class="arguments"><a href="../SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function" class="externalLink">Consumer</a><<a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="list(org.apache.calcite.sql.SqlWriter.FrameTypeEnum,org.apache.calcite.sql.SqlBinaryOperator,org.apache.calcite.sql.SqlNodeList)">list</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="../SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></span> <span class="memberName">list</span>​(<span class="arguments"><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="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="sep(java.lang.String)">sep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">sep</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sep)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sep</code> - List separator, typically ",".</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="sep(java.lang.String,boolean)">sep</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">sep</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sep, |
| boolean printFirst)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="setNeedWhitespace(boolean)">setNeedWhitespace</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setNeedWhitespace</span>​(<span class="arguments">boolean needWhitespace)</span></div> |
| <div class="block"><span class="descfrmTypeLabel">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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="setLineLength(int)">setLineLength</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setLineLength</span>​(<span class="arguments">int lineLength)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setFormatOptions(org.apache.calcite.sql.pretty.SqlFormatOptions)">setFormatOptions</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">setFormatOptions</span>​(<span class="arguments"><a href="SqlFormatOptions.html" title="class in org.apache.calcite.sql.pretty">SqlFormatOptions</a> options)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
