blob: 0db84e00beecbd8743ebeae522624808dbe58a31 [file] [log] [blame]
<!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>Decimal256Consumer (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="Decimal256Consumer (Apache Arrow Java Root POM 17.0.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Decimal256Consumer.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/arrow/adapter/jdbc/consumer/DateConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/DecimalConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html" target="_top">Frames</a></li>
<li><a href="Decimal256Consumer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.arrow.adapter.jdbc.consumer.BaseConsumer">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.adapter.jdbc.consumer</div>
<h2 title="Class Decimal256Consumer" class="title">Class Decimal256Consumer</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer">org.apache.arrow.adapter.jdbc.consumer.BaseConsumer</a>&lt;<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.arrow.adapter.jdbc.consumer.Decimal256Consumer</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a>&lt;<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Decimal256Consumer</span>
extends <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer">BaseConsumer</a>&lt;<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&gt;</pre>
<div class="block">Consumer which consume decimal type values from <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>.
Write the data to <a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector"><code>Decimal256Vector</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.arrow.adapter.jdbc.consumer.BaseConsumer">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.arrow.adapter.jdbc.consumer.<a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer">BaseConsumer</a></h3>
<code><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html#columnIndexInResultSet">columnIndexInResultSet</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html#currentIndex">currentIndex</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html#vector">vector</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html#Decimal256Consumer-org.apache.arrow.vector.Decimal256Vector-int-">Decimal256Consumer</a></span>(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index)</code>
<div class="block">Constructs a new consumer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html#Decimal256Consumer-org.apache.arrow.vector.Decimal256Vector-int-java.math.RoundingMode-">Decimal256Consumer</a></span>(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a>&nbsp;bigDecimalRoundingMode)</code>
<div class="block">Constructs a new consumer, with optional coercibility.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a>&lt;<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html#createConsumer-org.apache.arrow.vector.Decimal256Vector-int-boolean-java.math.RoundingMode-">createConsumer</a></span>(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index,
boolean&nbsp;nullable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a>&nbsp;bigDecimalRoundingMode)</code>
<div class="block">Creates a consumer for <a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector"><code>Decimal256Vector</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html#set-java.math.BigDecimal-">set</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;value)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.adapter.jdbc.consumer.BaseConsumer">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.arrow.adapter.jdbc.consumer.<a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer">BaseConsumer</a></h3>
<code><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html#close--">close</a>, <a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/BaseConsumer.html#resetValueVector-V-">resetValueVector</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.arrow.adapter.jdbc.consumer.JdbcConsumer">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.arrow.adapter.jdbc.consumer.<a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a></h3>
<code><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html#consume-java.sql.ResultSet-">consume</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Decimal256Consumer-org.apache.arrow.vector.Decimal256Vector-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Decimal256Consumer</h4>
<pre>public&nbsp;Decimal256Consumer(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index)</pre>
<div class="block">Constructs a new consumer.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vector</code> - the underlying vector for the consumer.</dd>
<dd><code>index</code> - the column id for the consumer.</dd>
</dl>
</li>
</ul>
<a name="Decimal256Consumer-org.apache.arrow.vector.Decimal256Vector-int-java.math.RoundingMode-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Decimal256Consumer</h4>
<pre>public&nbsp;Decimal256Consumer(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a>&nbsp;bigDecimalRoundingMode)</pre>
<div class="block">Constructs a new consumer, with optional coercibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vector</code> - the underlying vector for the consumer.</dd>
<dd><code>index</code> - the column index for the consumer.</dd>
<dd><code>bigDecimalRoundingMode</code> - java.math.RoundingMode to be applied if the BigDecimal scale does not match that
of the target vector. Set to null to retain strict matching behavior (scale of
source and target vector must match exactly).</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createConsumer-org.apache.arrow.vector.Decimal256Vector-int-boolean-java.math.RoundingMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createConsumer</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/JdbcConsumer.html" title="interface in org.apache.arrow.adapter.jdbc.consumer">JdbcConsumer</a>&lt;<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&gt;&nbsp;createConsumer(<a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector">Decimal256Vector</a>&nbsp;vector,
int&nbsp;index,
boolean&nbsp;nullable,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/RoundingMode.html?is-external=true" title="class or interface in java.math">RoundingMode</a>&nbsp;bigDecimalRoundingMode)</pre>
<div class="block">Creates a consumer for <a href="../../../../../../org/apache/arrow/vector/Decimal256Vector.html" title="class in org.apache.arrow.vector"><code>Decimal256Vector</code></a>.</div>
</li>
</ul>
<a name="set-java.math.BigDecimal-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>set</h4>
<pre>protected&nbsp;void&nbsp;set(<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;value)</pre>
</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/Decimal256Consumer.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/arrow/adapter/jdbc/consumer/DateConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/arrow/adapter/jdbc/consumer/DecimalConsumer.html" title="class in org.apache.arrow.adapter.jdbc.consumer"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/arrow/adapter/jdbc/consumer/Decimal256Consumer.html" target="_top">Frames</a></li>
<li><a href="Decimal256Consumer.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.arrow.adapter.jdbc.consumer.BaseConsumer">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>