| <!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>AvaticaParameterConverter (Apache Arrow Java Root POM 17.0.0-SNAPSHOT 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="AvaticaParameterConverter (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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="class-use/AvaticaParameterConverter.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/driver/jdbc/converter/AvaticaParameterConverter.html" target="_top">Frames</a></li> |
| <li><a href="AvaticaParameterConverter.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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.arrow.driver.jdbc.converter</div> |
| <h2 title="Interface AvaticaParameterConverter" class="title">Interface AvaticaParameterConverter</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/arrow/driver/jdbc/converter/impl/BinaryAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">BinaryAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/BinaryViewAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">BinaryViewAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/BoolAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">BoolAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/DateAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">DateAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/DecimalAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">DecimalAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/DurationAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">DurationAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/FixedSizeBinaryAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">FixedSizeBinaryAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/FixedSizeListAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">FixedSizeListAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/FloatingPointAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">FloatingPointAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/IntAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">IntAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/IntervalAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">IntervalAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/LargeBinaryAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">LargeBinaryAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/LargeListAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">LargeListAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/LargeUtf8AvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">LargeUtf8AvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/ListAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">ListAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/MapAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">MapAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/NullAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">NullAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/StructAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">StructAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/TimeAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">TimeAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/TimestampAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">TimestampAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/UnionAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">UnionAvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/Utf8AvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">Utf8AvaticaParameterConverter</a>, <a href="../../../../../../org/apache/arrow/driver/jdbc/converter/impl/Utf8ViewAvaticaParameterConverter.html" title="class in org.apache.arrow.driver.jdbc.converter.impl">Utf8ViewAvaticaParameterConverter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">AvaticaParameterConverter</span></pre> |
| <div class="block">Interface for a class in charge of converting between AvaticaParameters and TypedValues and |
| Arrow.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/converter/AvaticaParameterConverter.html#bindParameter-org.apache.arrow.vector.FieldVector-org.apache.calcite.avatica.remote.TypedValue-int-">bindParameter</a></span>(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> vector, |
| org.apache.calcite.avatica.remote.TypedValue typedValue, |
| int index)</code> |
| <div class="block">Bind a TypedValue to a FieldVector at the given index.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.apache.calcite.avatica.AvaticaParameter</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/driver/jdbc/converter/AvaticaParameterConverter.html#createParameter-org.apache.arrow.vector.types.pojo.Field-">createParameter</a></span>(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field)</code> |
| <div class="block">Create an AvaticaParameter from the given Field.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="bindParameter-org.apache.arrow.vector.FieldVector-org.apache.calcite.avatica.remote.TypedValue-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>bindParameter</h4> |
| <pre>boolean bindParameter(<a href="../../../../../../org/apache/arrow/vector/FieldVector.html" title="interface in org.apache.arrow.vector">FieldVector</a> vector, |
| org.apache.calcite.avatica.remote.TypedValue typedValue, |
| int index)</pre> |
| <div class="block">Bind a TypedValue to a FieldVector at the given index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>vector</code> - FieldVector that the parameter should be bound to.</dd> |
| <dd><code>typedValue</code> - TypedValue to bind as a parameter.</dd> |
| <dd><code>index</code> - Vector index (0-indexed) that the TypedValue should be bound to.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether the value was set successfully.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createParameter-org.apache.arrow.vector.types.pojo.Field-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createParameter</h4> |
| <pre>org.apache.calcite.avatica.AvaticaParameter createParameter(<a href="../../../../../../org/apache/arrow/vector/types/pojo/Field.html" title="class in org.apache.arrow.vector.types.pojo">Field</a> field)</pre> |
| <div class="block">Create an AvaticaParameter from the given Field.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>field</code> - Arrow Field to generate an AvaticaParameter from.</dd> |
| </dl> |
| </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="class-use/AvaticaParameterConverter.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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/arrow/driver/jdbc/converter/AvaticaParameterConverter.html" target="_top">Frames</a></li> |
| <li><a href="AvaticaParameterConverter.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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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 © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
