| <!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>org.apache.calcite.avatica.util (Apache Calcite Avatica 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="org.apache.calcite.avatica.util (Apache Calcite Avatica API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/avatica/tck/tests/package-summary.html">Prev Package</a></li> |
| <li>Next Package</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/avatica/util/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.calcite.avatica.util</h1> |
| <div class="docSummary"> |
| <div class="block">Avatica utilities.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/AbstractCursor.Getter.html" title="interface in org.apache.calcite.avatica.util">AbstractCursor.Getter</a></td> |
| <td class="colLast"> |
| <div class="block">Gets a value from a particular field of the current record of this |
| cursor.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">ArrayImpl.Factory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory that can create a ResultSet or Array based on a stream of values.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util">Cursor</a></td> |
| <td class="colLast"> |
| <div class="block">Interface to an iteration that is similar to, and can easily support, |
| a JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql"><code>ResultSet</code></a>, but is simpler to implement.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Cursor.Accessor.html" title="interface in org.apache.calcite.avatica.util">Cursor.Accessor</a></td> |
| <td class="colLast"> |
| <div class="block">Accessor of a column value.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/StructImpl.Factory.html" title="interface in org.apache.calcite.avatica.util">StructImpl.Factory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory that can create a result set based on a list of values.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/AbstractCursor.html" title="class in org.apache.calcite.avatica.util">AbstractCursor</a></td> |
| <td class="colLast"> |
| <div class="block">Base class for implementing a cursor.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/AbstractCursor.ArrayAccessor.html" title="class in org.apache.calcite.avatica.util">AbstractCursor.ArrayAccessor</a></td> |
| <td class="colLast"> |
| <div class="block">Accessor that assumes that the underlying value is an ARRAY; |
| corresponds to <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html?is-external=true#ARRAY" title="class or interface in java.sql"><code>Types.ARRAY</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ArrayFactoryImpl.html" title="class in org.apache.calcite.avatica.util">ArrayFactoryImpl</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/ArrayImpl.Factory.html" title="interface in org.apache.calcite.avatica.util"><code>ArrayImpl.Factory</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ArrayImpl.html" title="class in org.apache.calcite.avatica.util">ArrayImpl</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Array.html?is-external=true" title="class or interface in java.sql"><code>Array</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ArrayIteratorCursor.html" title="class in org.apache.calcite.avatica.util">ArrayIteratorCursor</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> on top of an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> that |
| returns an array of <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> for each row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Base64.html" title="class in org.apache.calcite.avatica.util">Base64</a></td> |
| <td class="colLast"> |
| <div class="block">Encodes and decodes to and from Base64 notation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Base64.InputStream.html" title="class in org.apache.calcite.avatica.util">Base64.InputStream</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/calcite/avatica/util/Base64.InputStream.html" title="class in org.apache.calcite.avatica.util"><code>Base64.InputStream</code></a> will read data from another |
| <code>java.io.InputStream</code>, given in the constructor, |
| and encode/decode to/from Base64 notation on the fly.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Base64.OutputStream.html" title="class in org.apache.calcite.avatica.util">Base64.OutputStream</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../../org/apache/calcite/avatica/util/Base64.OutputStream.html" title="class in org.apache.calcite.avatica.util"><code>Base64.OutputStream</code></a> will write data to another |
| <code>java.io.OutputStream</code>, given in the constructor, |
| and encode/decode to/from Base64 notation on the fly.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ByteString.html" title="class in org.apache.calcite.avatica.util">ByteString</a></td> |
| <td class="colLast"> |
| <div class="block">Collection of bytes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/DateTimeUtils.html" title="class in org.apache.calcite.avatica.util">DateTimeUtils</a></td> |
| <td class="colLast"> |
| <div class="block">Utility functions for datetime types: date, time, timestamp.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/DateTimeUtils.PrecisionTime.html" title="class in org.apache.calcite.avatica.util">DateTimeUtils.PrecisionTime</a></td> |
| <td class="colLast"> |
| <div class="block">Helper class for <a href="../../../../../org/apache/calcite/avatica/util/DateTimeUtils.html#parsePrecisionDateTimeLiteral-java.lang.String-java.lang.String-java.util.TimeZone-"><code>DateTimeUtils.parsePrecisionDateTimeLiteral(java.lang.String, java.lang.String, java.util.TimeZone)</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/FilteredConstants.html" title="class in org.apache.calcite.avatica.util">FilteredConstants</a></td> |
| <td class="colLast"> |
| <div class="block">A class which, at build time, will have build-specific variables substituted into it.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/IteratorCursor.html" title="class in org.apache.calcite.avatica.util">IteratorCursor</a><E></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> |
| on top of an <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> that |
| returns a record for each row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/ListIteratorCursor.html" title="class in org.apache.calcite.avatica.util">ListIteratorCursor</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> on top of an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> that |
| returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><code>List</code></a> for each row.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/MapIteratorCursor.html" title="class in org.apache.calcite.avatica.util">MapIteratorCursor</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> on top of an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> that |
| returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> for each row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/PositionedCursor.html" title="class in org.apache.calcite.avatica.util">PositionedCursor</a><T></td> |
| <td class="colLast"> |
| <div class="block">Abstract implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> |
| that caches its current row.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/RecordIteratorCursor.html" title="class in org.apache.calcite.avatica.util">RecordIteratorCursor</a><E></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../../../../org/apache/calcite/avatica/util/Cursor.html" title="interface in org.apache.calcite.avatica.util"><code>Cursor</code></a> on top of an |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a> that |
| returns a record for each row.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Spacer.html" title="class in org.apache.calcite.avatica.util">Spacer</a></td> |
| <td class="colLast"> |
| <div class="block">Efficiently writes strings of spaces.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Spaces.html" title="class in org.apache.calcite.avatica.util">Spaces</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities for creating strings of spaces.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/StructImpl.html" title="class in org.apache.calcite.avatica.util">StructImpl</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of JDBC <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Struct.html?is-external=true" title="class or interface in java.sql"><code>Struct</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Unsafe.html" title="class in org.apache.calcite.avatica.util">Unsafe</a></td> |
| <td class="colLast"> |
| <div class="block">Contains methods that call JDK methods that the |
| <a href="https://github.com/policeman-tools/forbidden-apis">forbidden |
| APIs checker</a> does not approve of.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/UnsynchronizedBuffer.html" title="class in org.apache.calcite.avatica.util">UnsynchronizedBuffer</a></td> |
| <td class="colLast"> |
| <div class="block">A utility class for reading and writing bytes to byte buffers without synchronization.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Casing.html" title="enum in org.apache.calcite.avatica.util">Casing</a></td> |
| <td class="colLast"> |
| <div class="block">Policy for converting case of identifiers before storing them.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/Quoting.html" title="enum in org.apache.calcite.avatica.util">Quoting</a></td> |
| <td class="colLast"> |
| <div class="block">Syntax for quoting identifiers in SQL statements.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/TimeUnit.html" title="enum in org.apache.calcite.avatica.util">TimeUnit</a></td> |
| <td class="colLast"> |
| <div class="block">Enumeration of time units used to construct an interval.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/TimeUnitRange.html" title="enum in org.apache.calcite.avatica.util">TimeUnitRange</a></td> |
| <td class="colLast"> |
| <div class="block">A range of time units.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/calcite/avatica/util/PackageMarker.html" title="annotation in org.apache.calcite.avatica.util">PackageMarker</a></td> |
| <td class="colLast"> |
| <div class="block">This is a dummy annotation that forces javac to produce output for |
| otherwise empty package-info.java.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.calcite.avatica.util Description">Package org.apache.calcite.avatica.util Description</h2> |
| <div class="block">Avatica utilities.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/calcite/avatica/tck/tests/package-summary.html">Prev Package</a></li> |
| <li>Next Package</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/calcite/avatica/util/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2012–2018 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
