| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) on Sat Jun 13 20:43:56 UTC 2026 --> |
| <title>JniBridge (Apache DataFusion Java 0.2.0-SNAPSHOT)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2026-06-13"> |
| <meta name="description" content="declaration: package: org.apache.datafusion.internal, class: JniBridge"> |
| <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.7.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> |
| <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="class-use/JniBridge.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.datafusion.internal</a></div> |
| <h1 title="Class JniBridge" class="title">Class JniBridge</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.datafusion.internal.JniBridge</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">JniBridge</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Internal trampoline invoked from native code on every UDF call. Not part of the public API.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <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 byte</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#invokeScalarUdf(org.apache.datafusion.ScalarFunction,long,long,long,long,byte%5B%5D,long,long,int)" class="member-name-link">invokeScalarUdf</a><wbr>(<a href="../ScalarFunction.html" title="interface in org.apache.datafusion">ScalarFunction</a> impl, |
| long arrayArgsArrayAddr, |
| long arrayArgsSchemaAddr, |
| long scalarArgsArrayAddr, |
| long scalarArgsSchemaAddr, |
| byte[] argKinds, |
| long resultArrayAddr, |
| long resultSchemaAddr, |
| int rowCount)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Invoke a scalar UDF for one batch.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#invokeTableScan(org.apache.datafusion.TableProvider,long)" class="member-name-link">invokeTableScan</a><wbr>(<a href="../TableProvider.html" title="interface in org.apache.datafusion">TableProvider</a> provider, |
| long ffiStreamAddr)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Open a fresh batch stream from a Java <a href="../TableProvider.html" title="interface in org.apache.datafusion"><code>TableProvider</code></a> and export it through the supplied |
| Arrow C Data Interface address.</div> |
| </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/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="invokeScalarUdf(org.apache.datafusion.ScalarFunction,long,long,long,long,byte[],long,long,int)"> |
| <h3>invokeScalarUdf</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">byte</span> <span class="element-name">invokeScalarUdf</span><wbr><span class="parameters">(<a href="../ScalarFunction.html" title="interface in org.apache.datafusion">ScalarFunction</a> impl, |
| long arrayArgsArrayAddr, |
| long arrayArgsSchemaAddr, |
| long scalarArgsArrayAddr, |
| long scalarArgsSchemaAddr, |
| byte[] argKinds, |
| long resultArrayAddr, |
| long resultSchemaAddr, |
| int rowCount)</span></div> |
| <div class="block">Invoke a scalar UDF for one batch. Called from native code; not for application use. |
| |
| <p>Args arrive split into two struct arrays: <code>arrayArgs*</code> of length <code>rowCount</code> |
| holding the <a href="../ColumnarValue.Array.html" title="class in org.apache.datafusion"><code>ColumnarValue.Array</code></a> arguments in their relative order, and <code> |
| scalarArgs*</code> of length 1 holding the <a href="../ColumnarValue.Scalar.html" title="class in org.apache.datafusion"><code>ColumnarValue.Scalar</code></a> arguments. <code>argKinds</code> |
| records the original positional order so the bridge can interleave them back into a single |
| <code>List<ColumnarValue></code> for the user.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>KIND_ARRAY</code> if the UDF returned an Array, <code>KIND_SCALAR</code> if it returned a |
| Scalar. The native caller uses this to reconstruct the right <code>ColumnarValue</code> variant.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="invokeTableScan(org.apache.datafusion.TableProvider,long)"> |
| <h3>invokeTableScan</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">invokeTableScan</span><wbr><span class="parameters">(<a href="../TableProvider.html" title="interface in org.apache.datafusion">TableProvider</a> provider, |
| long ffiStreamAddr)</span></div> |
| <div class="block">Open a fresh batch stream from a Java <a href="../TableProvider.html" title="interface in org.apache.datafusion"><code>TableProvider</code></a> and export it through the supplied |
| Arrow C Data Interface address. Called from native code; not for application use. |
| |
| <p><a href="../TableProvider.html#scan(org.apache.arrow.memory.BufferAllocator)"><code>TableProvider.scan(org.apache.arrow.memory.BufferAllocator)</code></a> is called with <code>ALLOCATOR</code> so that the reader's buffers share the same allocator root required by <code>Data.exportArrayStream(org.apache.arrow.memory.BufferAllocator, org.apache.arrow.vector.ipc.ArrowReader, org.apache.arrow.c.ArrowArrayStream)</code>. |
| |
| <p>On success, ownership of the returned reader transfers to the FFI stream's release callback, |
| so the native side closing the stream also closes the reader. On any failure during export, the |
| reader is closed here before the exception propagates.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2026. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
