| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (17) on Sat Jun 13 20:43:56 UTC 2026 --> |
| <title>ColumnarValue (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, interface: ColumnarValue"> |
| <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/ColumnarValue.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><a href="#nested-class-summary">Nested</a> | </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</a></div> |
| <h1 title="Interface ColumnarValue" class="title">Interface ColumnarValue</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="ColumnarValue.Array.html" title="class in org.apache.datafusion">ColumnarValue.Array</a></code>, <code><a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion">ColumnarValue.Scalar</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public sealed interface </span><span class="element-name type-name-label">ColumnarValue</span> |
| <span class="permits">permits <a href="ColumnarValue.Array.html" title="class in org.apache.datafusion">ColumnarValue.Array</a>, <a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion">ColumnarValue.Scalar</a></span></div> |
| <div class="block">The value of a scalar UDF argument or result: either a per-row <a href="ColumnarValue.Array.html" title="class in org.apache.datafusion"><code>ColumnarValue.Array</code></a> of length <code> |
| rowCount</code>, or a <a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion"><code>ColumnarValue.Scalar</code></a> (length-1 vector) that the framework broadcasts. |
| |
| <p>Mirrors DataFusion's <code>datafusion::logical_expr::ColumnarValue</code> enum. Use <a href="#array(org.apache.arrow.vector.FieldVector)"><code>array(FieldVector)</code></a> and <a href="#scalar(org.apache.arrow.vector.FieldVector)"><code>scalar(FieldVector)</code></a> factories rather than constructing the |
| records directly so the length invariants are enforced consistently.</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final record </code></div> |
| <div class="col-second even-row-color"><code><a href="ColumnarValue.Array.html" class="type-name-link" title="class in org.apache.datafusion">ColumnarValue.Array</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Per-row Arrow vector of length equal to the batch row count.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final record </code></div> |
| <div class="col-second odd-row-color"><code><a href="ColumnarValue.Scalar.html" class="type-name-link" title="class in org.apache.datafusion">ColumnarValue.Scalar</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Length-1 Arrow vector representing a single value broadcast across all rows.</div> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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"><code>static <a href="ColumnarValue.html" title="interface in org.apache.datafusion">ColumnarValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#array(org.apache.arrow.vector.FieldVector)" class="member-name-link">array</a><wbr>(org.apache.arrow.vector.FieldVector vector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Wrap an arbitrary-length vector as an <a href="ColumnarValue.Array.html" title="class in org.apache.datafusion"><code>ColumnarValue.Array</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default org.apache.arrow.vector.types.pojo.ArrowType</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#dataType()" class="member-name-link">dataType</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Convenience: the vector's declared Arrow type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="ColumnarValue.html" title="interface in org.apache.datafusion">ColumnarValue</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#scalar(org.apache.arrow.vector.FieldVector)" class="member-name-link">scalar</a><wbr>(org.apache.arrow.vector.FieldVector vector)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Wrap a length-1 vector as a <a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion"><code>ColumnarValue.Scalar</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.arrow.vector.FieldVector</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#vector()" class="member-name-link">vector</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The underlying Arrow vector.</div> |
| </div> |
| </div> |
| </div> |
| </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="vector()"> |
| <h3>vector</h3> |
| <div class="member-signature"><span class="return-type">org.apache.arrow.vector.FieldVector</span> <span class="element-name">vector</span>()</div> |
| <div class="block">The underlying Arrow vector. For <a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion"><code>ColumnarValue.Scalar</code></a> this vector has <code>valueCount == 1</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dataType()"> |
| <h3>dataType</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">org.apache.arrow.vector.types.pojo.ArrowType</span> <span class="element-name">dataType</span>()</div> |
| <div class="block">Convenience: the vector's declared Arrow type.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="array(org.apache.arrow.vector.FieldVector)"> |
| <h3>array</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="ColumnarValue.html" title="interface in org.apache.datafusion">ColumnarValue</a></span> <span class="element-name">array</span><wbr><span class="parameters">(org.apache.arrow.vector.FieldVector vector)</span></div> |
| <div class="block">Wrap an arbitrary-length vector as an <a href="ColumnarValue.Array.html" title="class in org.apache.datafusion"><code>ColumnarValue.Array</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scalar(org.apache.arrow.vector.FieldVector)"> |
| <h3>scalar</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="ColumnarValue.html" title="interface in org.apache.datafusion">ColumnarValue</a></span> <span class="element-name">scalar</span><wbr><span class="parameters">(org.apache.arrow.vector.FieldVector vector)</span></div> |
| <div class="block">Wrap a length-1 vector as a <a href="ColumnarValue.Scalar.html" title="class in org.apache.datafusion"><code>ColumnarValue.Scalar</code></a>.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if <code>vector.getValueCount() != 1</code></dd> |
| </dl> |
| </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> |
