| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SqlWriter (Apache Calcite calcite API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SqlWriter (Apache Calcite calcite API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/sql/SqlWithItem.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql/SqlWriter.html" target="_top">Frames</a></li> |
| <li><a href="SqlWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.calcite.sql</div> |
| <h2 title="Interface SqlWriter" class="title">Interface SqlWriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/calcite/sql/pretty/SqlPrettyWriter.html" title="class in org.apache.calcite.sql.pretty">SqlPrettyWriter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SqlWriter</span></pre> |
| <div class="block">A <code>SqlWriter</code> is the target to construct a SQL statement from a |
| parse tree. It deals with dialect differences; for example, Oracle quotes |
| identifiers as <code>"scott"</code>, while SQL Server quotes them as <code> |
| [scott]</code>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></span></code> |
| <div class="block">A Frame is a piece of generated text which shares a common indentation |
| level.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a></span></code> |
| <div class="block">Frame type.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a></span></code> |
| <div class="block">Enumerates the types of frame.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.SubQueryStyle.html" title="enum in org.apache.calcite.sql">SqlWriter.SubQueryStyle</a></span></code> |
| <div class="block">Style of formatting sub-queries.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/apache/calcite/sql/SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#COMMA">COMMA</a></span></code> |
| <div class="block">Comma operator.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#dynamicParam-int-">dynamicParam</a></span>(int index)</code> |
| <div class="block">Prints a dynamic parameter (e.g.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#endFunCall-org.apache.calcite.sql.SqlWriter.Frame-">endFunCall</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code> |
| <div class="block">Ends a list which is a call to a function.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#endList-org.apache.calcite.sql.SqlWriter.Frame-">endList</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</code> |
| <div class="block">Ends a list.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#fetchOffset-org.apache.calcite.sql.SqlNode-org.apache.calcite.sql.SqlNode-">fetchOffset</a></span>(<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#getDialect--">getDialect</a></span>()</code> |
| <div class="block">Returns the dialect of SQL.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#getIndentation--">getIndentation</a></span>()</code> |
| <div class="block">Returns the offset for each level of indentation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#identifier-java.lang.String-boolean-">identifier</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean quoted)</code> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#inQuery--">inQuery</a></span>()</code> |
| <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 id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#isAlwaysUseParentheses--">isAlwaysUseParentheses</a></span>()</code> |
| <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.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#isClauseStartsLine--">isClauseStartsLine</a></span>()</code> |
| <div class="block">Returns whether this writer should start each clause (e.g.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#isKeywordsLowerCase--">isKeywordsLowerCase</a></span>()</code> |
| <div class="block">Returns whether to output all keywords (e.g.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#isQuoteAllIdentifiers--">isQuoteAllIdentifiers</a></span>()</code> |
| <div class="block">Returns whether this writer should quote all identifiers, even those |
| that do not contain mixed-case identifiers or punctuation.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#isSelectListItemsOnSeparateLines--">isSelectListItemsOnSeparateLines</a></span>()</code> |
| <div class="block">Returns whether the items in the SELECT clause should each be on a |
| separate line.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#keyword-java.lang.String-">keyword</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Prints a sequence of keywords.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#list-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-java.util.function.Consumer-">list</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</code> |
| <div class="block">Writes a list.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#list-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-org.apache.calcite.sql.SqlBinaryOperator-org.apache.calcite.sql.SqlNodeList-">list</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="../../../../org/apache/calcite/sql/SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="../../../../org/apache/calcite/sql/SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</code> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="../../../../org/apache/calcite/sql/fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="../../../../org/apache/calcite/sql/fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="../../../../org/apache/calcite/sql/SqlWriter.html#COMMA"><code>COMMA</code></a>).</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#literal-java.lang.String-">literal</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Prints a literal, exactly as provided.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#newlineAndIndent--">newlineAndIndent</a></span>()</code> |
| <div class="block">Prints a new line, and indents.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#print-int-">print</a></span>(int x)</code> |
| <div class="block">Prints an integer.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#print-java.lang.String-">print</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#reset--">reset</a></span>()</code> |
| <div class="block">Resets this writer so that it can format another expression.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#resetSettings--">resetSettings</a></span>()</code> |
| <div class="block">Resets all properties to their default values.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#sep-java.lang.String-">sep</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sep)</code> |
| <div class="block">Writes a list separator, unless the separator is "," and this is the |
| first occurrence in the list.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#sep-java.lang.String-boolean-">sep</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sep, |
| boolean printFirst)</code> |
| <div class="block">Writes a list separator.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#setNeedWhitespace-boolean-">setNeedWhitespace</a></span>(boolean needWhitespace)</code> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#startFunCall-java.lang.String-">startFunCall</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> funName)</code> |
| <div class="block">Starts a list which is a call to a function.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#startList-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-">startList</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</code> |
| <div class="block">Starts a list with no opening string.</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#startList-org.apache.calcite.sql.SqlWriter.FrameType-java.lang.String-java.lang.String-">startList</a></span>(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> open, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> close)</code> |
| <div class="block">Starts a list.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#startList-java.lang.String-java.lang.String-">startList</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> open, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> close)</code> |
| <div class="block">Starts a list.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#topN-org.apache.calcite.sql.SqlNode-org.apache.calcite.sql.SqlNode-">topN</a></span>(<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</code> |
| <div class="block">Prints the TOP(n) clause.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/calcite/sql/SqlWriter.html#toSqlString--">toSqlString</a></span>()</code> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="COMMA"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>COMMA</h4> |
| <pre>static final <a href="../../../../org/apache/calcite/sql/SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> COMMA</pre> |
| <div class="block">Comma operator. |
| |
| <p>Defined in <code>SqlWriter</code> because it is only used while converting |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql"><code>SqlNode</code></a> to SQL; |
| see <a href="../../../../org/apache/calcite/sql/SqlWriter.html#list-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-org.apache.calcite.sql.SqlBinaryOperator-org.apache.calcite.sql.SqlNodeList-"><code>list(FrameTypeEnum, SqlBinaryOperator, SqlNodeList)</code></a>. |
| |
| <p>The precedence of the comma operator is low but not zero. For |
| instance, this ensures parentheses in |
| <code>select x, (select * from foo order by z), y from t</code>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>void reset()</pre> |
| <div class="block">Resets this writer so that it can format another expression. Does not |
| affect formatting preferences (see <a href="../../../../org/apache/calcite/sql/SqlWriter.html#resetSettings--"><code>resetSettings()</code></a></div> |
| </li> |
| </ul> |
| <a name="resetSettings--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetSettings</h4> |
| <pre>void resetSettings()</pre> |
| <div class="block">Resets all properties to their default values.</div> |
| </li> |
| </ul> |
| <a name="getDialect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDialect</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlDialect.html" title="class in org.apache.calcite.sql">SqlDialect</a> getDialect()</pre> |
| <div class="block">Returns the dialect of SQL.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SQL dialect</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toSqlString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toSqlString</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/util/SqlString.html" title="class in org.apache.calcite.sql.util">SqlString</a> toSqlString()</pre> |
| <div class="block">Returns the contents of this writer as a 'certified kocher' SQL string.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SQL string</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="literal-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>literal</h4> |
| <pre>void literal(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="keyword-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>keyword</h4> |
| <pre>void keyword(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="print-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>print</h4> |
| <pre>void print(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| <div class="block">Prints a string, preceded by whitespace if necessary.</div> |
| </li> |
| </ul> |
| <a name="print-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>print</h4> |
| <pre>void print(int x)</pre> |
| <div class="block">Prints an integer.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>x</code> - Integer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="identifier-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>identifier</h4> |
| <pre>void identifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| boolean quoted)</pre> |
| <div class="block">Prints an identifier, quoting as necessary.</div> |
| <dl> |
| <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> |
| </li> |
| </ul> |
| <a name="dynamicParam-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dynamicParam</h4> |
| <pre>void dynamicParam(int index)</pre> |
| <div class="block">Prints a dynamic parameter (e.g. <code>?</code> for default JDBC)</div> |
| </li> |
| </ul> |
| <a name="fetchOffset-org.apache.calcite.sql.SqlNode-org.apache.calcite.sql.SqlNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fetchOffset</h4> |
| <pre>void fetchOffset(<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</pre> |
| <div class="block">Prints the OFFSET/FETCH clause.</div> |
| </li> |
| </ul> |
| <a name="topN-org.apache.calcite.sql.SqlNode-org.apache.calcite.sql.SqlNode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>topN</h4> |
| <pre>void topN(<a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> fetch, |
| <a href="../../../../org/apache/calcite/sql/SqlNode.html" title="class in org.apache.calcite.sql">SqlNode</a> offset)</pre> |
| <div class="block">Prints the TOP(n) clause.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql/SqlWriter.html#fetchOffset-org.apache.calcite.sql.SqlNode-org.apache.calcite.sql.SqlNode-"><code>fetchOffset(org.apache.calcite.sql.SqlNode, org.apache.calcite.sql.SqlNode)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newlineAndIndent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newlineAndIndent</h4> |
| <pre>void newlineAndIndent()</pre> |
| <div class="block">Prints a new line, and indents.</div> |
| </li> |
| </ul> |
| <a name="isQuoteAllIdentifiers--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isQuoteAllIdentifiers</h4> |
| <pre>boolean isQuoteAllIdentifiers()</pre> |
| <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="returnLabel">Returns:</span></dt> |
| <dd>whether to quote all identifiers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClauseStartsLine--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClauseStartsLine</h4> |
| <pre>boolean isClauseStartsLine()</pre> |
| <div class="block">Returns whether this writer should start each clause (e.g. GROUP BY) on |
| a new line.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to start each clause on a new line</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSelectListItemsOnSeparateLines--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSelectListItemsOnSeparateLines</h4> |
| <pre>boolean isSelectListItemsOnSeparateLines()</pre> |
| <div class="block">Returns whether the items in the SELECT clause should each be on a |
| separate line.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to put each SELECT clause item on a new line</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isKeywordsLowerCase--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isKeywordsLowerCase</h4> |
| <pre>boolean isKeywordsLowerCase()</pre> |
| <div class="block">Returns whether to output all keywords (e.g. SELECT, GROUP BY) in lower |
| case.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether to output SQL keywords in lower case</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startFunCall-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startFunCall</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> startFunCall(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> funName)</pre> |
| <div class="block">Starts a list which is a call to a function.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql/SqlWriter.html#endFunCall-org.apache.calcite.sql.SqlWriter.Frame-"><code>endFunCall(Frame)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endFunCall-org.apache.calcite.sql.SqlWriter.Frame-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endFunCall</h4> |
| <pre>void endFunCall(<a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</pre> |
| <div class="block">Ends a list which is a call to a function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - Frame</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/calcite/sql/SqlWriter.html#startFunCall-java.lang.String-"><code>startFunCall(String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="startList-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startList</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> startList(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> open, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> close)</pre> |
| <div class="block">Starts a list.</div> |
| </li> |
| </ul> |
| <a name="startList-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startList</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> startList(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType)</pre> |
| <div class="block">Starts a list with no opening string.</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> |
| </dl> |
| </li> |
| </ul> |
| <a name="startList-org.apache.calcite.sql.SqlWriter.FrameType-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startList</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> startList(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameType.html" title="interface in org.apache.calcite.sql">SqlWriter.FrameType</a> frameType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> open, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> close)</pre> |
| <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 start the list; typically "(" or the empty |
| string.</dd> |
| <dd><code>close</code> - String to close the list</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="endList-org.apache.calcite.sql.SqlWriter.Frame-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endList</h4> |
| <pre>void endList(<a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql">SqlWriter.Frame</a> frame)</pre> |
| <div class="block">Ends a list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>frame</code> - The frame which was created by <a href="../../../../org/apache/calcite/sql/SqlWriter.html#startList-java.lang.String-java.lang.String-"><code>startList(java.lang.String, java.lang.String)</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="list-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-java.util.function.Consumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>list</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> list(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html?is-external=true" title="class or interface in java.util.function">Consumer</a><<a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a>> action)</pre> |
| <div class="block">Writes a list.</div> |
| </li> |
| </ul> |
| <a name="list-org.apache.calcite.sql.SqlWriter.FrameTypeEnum-org.apache.calcite.sql.SqlBinaryOperator-org.apache.calcite.sql.SqlNodeList-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>list</h4> |
| <pre><a href="../../../../org/apache/calcite/sql/SqlWriter.html" title="interface in org.apache.calcite.sql">SqlWriter</a> list(<a href="../../../../org/apache/calcite/sql/SqlWriter.FrameTypeEnum.html" title="enum in org.apache.calcite.sql">SqlWriter.FrameTypeEnum</a> frameType, |
| <a href="../../../../org/apache/calcite/sql/SqlBinaryOperator.html" title="class in org.apache.calcite.sql">SqlBinaryOperator</a> sepOp, |
| <a href="../../../../org/apache/calcite/sql/SqlNodeList.html" title="class in org.apache.calcite.sql">SqlNodeList</a> list)</pre> |
| <div class="block">Writes a list separated by a binary operator |
| (<a href="../../../../org/apache/calcite/sql/fun/SqlStdOperatorTable.html#AND"><code>AND</code></a>, |
| <a href="../../../../org/apache/calcite/sql/fun/SqlStdOperatorTable.html#OR"><code>OR</code></a>, or |
| <a href="../../../../org/apache/calcite/sql/SqlWriter.html#COMMA"><code>COMMA</code></a>).</div> |
| </li> |
| </ul> |
| <a name="sep-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sep</h4> |
| <pre>void sep(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sep)</pre> |
| <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="paramLabel">Parameters:</span></dt> |
| <dd><code>sep</code> - List separator, typically ",".</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sep-java.lang.String-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sep</h4> |
| <pre>void sep(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> sep, |
| boolean printFirst)</pre> |
| <div class="block">Writes a list separator.</div> |
| <dl> |
| <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> |
| </li> |
| </ul> |
| <a name="setNeedWhitespace-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNeedWhitespace</h4> |
| <pre>void setNeedWhitespace(boolean needWhitespace)</pre> |
| <div class="block">Sets whether whitespace is needed before the next token.</div> |
| </li> |
| </ul> |
| <a name="getIndentation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndentation</h4> |
| <pre>int getIndentation()</pre> |
| <div class="block">Returns the offset for each level of indentation. Default 4.</div> |
| </li> |
| </ul> |
| <a name="isAlwaysUseParentheses--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isAlwaysUseParentheses</h4> |
| <pre>boolean isAlwaysUseParentheses()</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="inQuery--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>inQuery</h4> |
| <pre>boolean inQuery()</pre> |
| <div class="block">Returns whether we are currently in a query context (SELECT, INSERT, |
| UNION, INTERSECT, EXCEPT, and the ORDER BY operator).</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.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"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/calcite/sql/SqlWithItem.html" title="class in org.apache.calcite.sql"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/calcite/sql/SqlWriter.Frame.html" title="interface in org.apache.calcite.sql"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/calcite/sql/SqlWriter.html" target="_top">Frames</a></li> |
| <li><a href="SqlWriter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <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>Constr | </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>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </body> |
| </html> |