| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ColumnMetaData (Apache Calcite Avatica API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.avatica, class: ColumnMetaData"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite Avatica</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.avatica</a></div> |
| <h1 title="Class ColumnMetaData" class="title">Class ColumnMetaData</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.avatica.ColumnMetaData</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ColumnMetaData</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Metadata for a column. |
| |
| <p>(Compare with <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html" title="class or interface in java.sql" class="external-link"><code>ResultSetMetaData</code></a>.)</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ColumnMetaData.ArrayType.html" class="type-name-link" title="class in org.apache.calcite.avatica">ColumnMetaData.ArrayType</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Array type.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ColumnMetaData.AvaticaType.html" class="type-name-link" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Base class for a column type.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="ColumnMetaData.Rep.html" class="type-name-link" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Description of the type used to internally represent a value.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="ColumnMetaData.ScalarType.html" class="type-name-link" title="class in org.apache.calcite.avatica">ColumnMetaData.ScalarType</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Scalar type.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="ColumnMetaData.StructType.html" class="type-name-link" title="class in org.apache.calcite.avatica">ColumnMetaData.StructType</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Record type.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#autoIncrement" class="member-name-link">autoIncrement</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#caseSensitive" class="member-name-link">caseSensitive</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#catalogName" class="member-name-link">catalogName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#columnClassName" class="member-name-link">columnClassName</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#columnName" class="member-name-link">columnName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#currency" class="member-name-link">currency</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#definitelyWritable" class="member-name-link">definitelyWritable</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#displaySize" class="member-name-link">displaySize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#label" class="member-name-link">label</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#nullable" class="member-name-link">nullable</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#ordinal" class="member-name-link">ordinal</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#precision" class="member-name-link">precision</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#readOnly" class="member-name-link">readOnly</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#scale" class="member-name-link">scale</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#schemaName" class="member-name-link">schemaName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#searchable" class="member-name-link">searchable</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#signed" class="member-name-link">signed</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#tableName" class="member-name-link">tableName</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>final <a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#type" class="member-name-link">type</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#writable" class="member-name-link">writable</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,boolean,boolean,boolean,boolean,int,boolean,int,java.lang.String,java.lang.String,java.lang.String,int,int,java.lang.String,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.AvaticaType,boolean,boolean,boolean,java.lang.String)" class="member-name-link">ColumnMetaData</a><wbr>(int ordinal, |
| boolean autoIncrement, |
| boolean caseSensitive, |
| boolean searchable, |
| boolean currency, |
| int nullable, |
| boolean signed, |
| int displaySize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> schemaName, |
| int precision, |
| int scale, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> catalogName, |
| <a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> type, |
| boolean readOnly, |
| boolean writable, |
| boolean definitelyWritable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnClassName)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ColumnMetaData.ArrayType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ArrayType</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#array(org.apache.calcite.avatica.ColumnMetaData.AvaticaType,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.Rep)" class="member-name-link">array</a><wbr>(<a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> componentType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> typeName, |
| <a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates an <a href="ColumnMetaData.ArrayType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.ArrayType</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#dummy(org.apache.calcite.avatica.ColumnMetaData.AvaticaType,boolean)" class="member-name-link">dummy</a><wbr>(<a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> type, |
| boolean nullable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a ColumnMetaData for result sets that are not based on a struct |
| but need to have a single 'field' for purposes of |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html" title="class or interface in java.sql" class="external-link"><code>ResultSetMetaData</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromProto(org.apache.calcite.avatica.proto.Common.ColumnMetaData)" class="member-name-link">fromProto</a><wbr>(org.apache.calcite.avatica.proto.Common.ColumnMetaData proto)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ColumnMetaData.ScalarType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ScalarType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#scalar(int,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.Rep)" class="member-name-link">scalar</a><wbr>(int type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> typeName, |
| <a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a <a href="ColumnMetaData.ScalarType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.ScalarType</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRep(org.apache.calcite.avatica.ColumnMetaData.Rep)" class="member-name-link">setRep</a><wbr>(<a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="ColumnMetaData.StructType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.StructType</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#struct(java.util.List)" class="member-name-link">struct</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>> columns)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a <a href="ColumnMetaData.StructType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.StructType</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.calcite.avatica.proto.Common.ColumnMetaData</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toProto()" class="member-name-link">toProto</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ordinal"> |
| <h3>ordinal</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">ordinal</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="autoIncrement"> |
| <h3>autoIncrement</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">autoIncrement</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="caseSensitive"> |
| <h3>caseSensitive</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">caseSensitive</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="searchable"> |
| <h3>searchable</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">searchable</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="currency"> |
| <h3>currency</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">currency</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="nullable"> |
| <h3>nullable</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">nullable</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="signed"> |
| <h3>signed</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">signed</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="displaySize"> |
| <h3>displaySize</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">displaySize</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="label"> |
| <h3>label</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">label</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="columnName"> |
| <h3>columnName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">columnName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="schemaName"> |
| <h3>schemaName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">schemaName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="precision"> |
| <h3>precision</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">precision</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scale"> |
| <h3>scale</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">scale</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tableName"> |
| <h3>tableName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">tableName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="catalogName"> |
| <h3>catalogName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">catalogName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readOnly"> |
| <h3>readOnly</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">readOnly</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writable"> |
| <h3>writable</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">writable</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="definitelyWritable"> |
| <h3>definitelyWritable</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">definitelyWritable</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="columnClassName"> |
| <h3>columnClassName</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">columnClassName</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="type"> |
| <h3>type</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a></span> <span class="element-name">type</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(int,boolean,boolean,boolean,boolean,int,boolean,int,java.lang.String,java.lang.String,java.lang.String,int,int,java.lang.String,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.AvaticaType,boolean,boolean,boolean,java.lang.String)"> |
| <h3>ColumnMetaData</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ColumnMetaData</span><wbr><span class="parameters">(int ordinal, |
| boolean autoIncrement, |
| boolean caseSensitive, |
| boolean searchable, |
| boolean currency, |
| int nullable, |
| boolean signed, |
| int displaySize, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> schemaName, |
| int precision, |
| int scale, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> tableName, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> catalogName, |
| <a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> type, |
| boolean readOnly, |
| boolean writable, |
| boolean definitelyWritable, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> columnClassName)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="toProto()"> |
| <h3>toProto</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.calcite.avatica.proto.Common.ColumnMetaData</span> <span class="element-name">toProto</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fromProto(org.apache.calcite.avatica.proto.Common.ColumnMetaData)"> |
| <h3>fromProto</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></span> <span class="element-name">fromProto</span><wbr><span class="parameters">(org.apache.calcite.avatica.proto.Common.ColumnMetaData proto)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scalar(int,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.Rep)"> |
| <h3>scalar</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ColumnMetaData.ScalarType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ScalarType</a></span> <span class="element-name">scalar</span><wbr><span class="parameters">(int type, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> typeName, |
| <a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</span></div> |
| <div class="block">Creates a <a href="ColumnMetaData.ScalarType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.ScalarType</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="struct(java.util.List)"> |
| <h3>struct</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ColumnMetaData.StructType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.StructType</a></span> <span class="element-name">struct</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a>> columns)</span></div> |
| <div class="block">Creates a <a href="ColumnMetaData.StructType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.StructType</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="array(org.apache.calcite.avatica.ColumnMetaData.AvaticaType,java.lang.String,org.apache.calcite.avatica.ColumnMetaData.Rep)"> |
| <h3>array</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ColumnMetaData.ArrayType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.ArrayType</a></span> <span class="element-name">array</span><wbr><span class="parameters">(<a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> componentType, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> typeName, |
| <a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</span></div> |
| <div class="block">Creates an <a href="ColumnMetaData.ArrayType.html" title="class in org.apache.calcite.avatica"><code>ColumnMetaData.ArrayType</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dummy(org.apache.calcite.avatica.ColumnMetaData.AvaticaType,boolean)"> |
| <h3>dummy</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></span> <span class="element-name">dummy</span><wbr><span class="parameters">(<a href="ColumnMetaData.AvaticaType.html" title="class in org.apache.calcite.avatica">ColumnMetaData.AvaticaType</a> type, |
| boolean nullable)</span></div> |
| <div class="block">Creates a ColumnMetaData for result sets that are not based on a struct |
| but need to have a single 'field' for purposes of |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html" title="class or interface in java.sql" class="external-link"><code>ResultSetMetaData</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRep(org.apache.calcite.avatica.ColumnMetaData.Rep)"> |
| <h3>setRep</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="ColumnMetaData.html" title="class in org.apache.calcite.avatica">ColumnMetaData</a></span> <span class="element-name">setRep</span><wbr><span class="parameters">(<a href="ColumnMetaData.Rep.html" title="enum in org.apache.calcite.avatica">ColumnMetaData.Rep</a> rep)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |