blob: e0b340fd809e01fb86da9365ab81a8eb513d37ad [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 -->
<title>ColumnIterator</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="ColumnIterator";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All 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="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/iceberg/parquet/BasePageIterator.IntIterator.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/parquet/ColumnWriter.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/parquet/ColumnIterator.html" target="_top">Frames</a></li>
<li><a href="ColumnIterator.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.iceberg.parquet.BaseColumnIterator">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.iceberg.parquet</div>
<h2 title="Class ColumnIterator" class="title">Class ColumnIterator&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html" title="class in org.apache.iceberg.parquet">org.apache.iceberg.parquet.BaseColumnIterator</a></li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.parquet.ColumnIterator&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ColumnIterator&lt;T&gt;</span>
extends <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html" title="class in org.apache.iceberg.parquet">BaseColumnIterator</a></pre>
</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.iceberg.parquet.BaseColumnIterator">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.iceberg.parquet.<a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html" title="class in org.apache.iceberg.parquet">BaseColumnIterator</a></h3>
<code><a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#advanceNextPageCount">advanceNextPageCount</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#desc">desc</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#dictionary">dictionary</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#pageSource">pageSource</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#triplesCount">triplesCount</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#triplesRead">triplesRead</a></code></li>
</ul>
</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="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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#currentDefinitionLevel--">currentDefinitionLevel</a></span>()</code>
<div class="block">Returns the definition level from the current triple.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#currentRepetitionLevel--">currentRepetitionLevel</a></span>()</code>
<div class="block">Returns the repetition level from the current triple or 0 if there are no more elements.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.apache.parquet.io.api.Binary</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextBinary--">nextBinary</a></span>()</code>
<div class="block">Returns the next value as a Binary.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextBoolean--">nextBoolean</a></span>()</code>
<div class="block">Returns the next value as an un-boxed boolean.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextDouble--">nextDouble</a></span>()</code>
<div class="block">Returns the next value as an un-boxed double.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextFloat--">nextFloat</a></span>()</code>
<div class="block">Returns the next value as an un-boxed float.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextInteger--">nextInteger</a></span>()</code>
<div class="block">Returns the next value as an un-boxed int.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextLong--">nextLong</a></span>()</code>
<div class="block">Returns the next value as an un-boxed long.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>&lt;N&gt;&nbsp;N</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#nextNull--">nextNull</a></span>()</code>
<div class="block">Returns null and advances the iterator.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/iceberg/parquet/BasePageIterator.html" title="class in org.apache.iceberg.parquet">BasePageIterator</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/parquet/ColumnIterator.html#pageIterator--">pageIterator</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.parquet.BaseColumnIterator">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.iceberg.parquet.<a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html" title="class in org.apache.iceberg.parquet">BaseColumnIterator</a></h3>
<code><a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#advance--">advance</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#hasNext--">hasNext</a>, <a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#setPageSource-org.apache.parquet.column.page.PageReader-">setPageSource</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Iterator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.util.Iterator</h3>
<code>forEachRemaining, hasNext, next, remove</code></li>
</ul>
</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="currentDefinitionLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentDefinitionLevel</h4>
<pre>public&nbsp;int&nbsp;currentDefinitionLevel()</pre>
<div class="block">Returns the definition level from the current triple.
<p>
This method does not advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the definition level of the current triple.</dd>
</dl>
</li>
</ul>
<a name="currentRepetitionLevel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentRepetitionLevel</h4>
<pre>public&nbsp;int&nbsp;currentRepetitionLevel()</pre>
<div class="block">Returns the repetition level from the current triple or 0 if there are no more elements.
<p>
This method does not advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the repetition level of the current triple, or 0 if there is no current triple.</dd>
</dl>
</li>
</ul>
<a name="nextBoolean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextBoolean</h4>
<pre>public&nbsp;boolean&nbsp;nextBoolean()</pre>
<div class="block">Returns the next value as an un-boxed boolean.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as an un-boxed boolean</dd>
</dl>
</li>
</ul>
<a name="nextInteger--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextInteger</h4>
<pre>public&nbsp;int&nbsp;nextInteger()</pre>
<div class="block">Returns the next value as an un-boxed int.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as an un-boxed int</dd>
</dl>
</li>
</ul>
<a name="nextLong--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextLong</h4>
<pre>public&nbsp;long&nbsp;nextLong()</pre>
<div class="block">Returns the next value as an un-boxed long.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as an un-boxed long</dd>
</dl>
</li>
</ul>
<a name="nextFloat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextFloat</h4>
<pre>public&nbsp;float&nbsp;nextFloat()</pre>
<div class="block">Returns the next value as an un-boxed float.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as an un-boxed float</dd>
</dl>
</li>
</ul>
<a name="nextDouble--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextDouble</h4>
<pre>public&nbsp;double&nbsp;nextDouble()</pre>
<div class="block">Returns the next value as an un-boxed double.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as an un-boxed double</dd>
</dl>
</li>
</ul>
<a name="nextBinary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextBinary</h4>
<pre>public&nbsp;org.apache.parquet.io.api.Binary&nbsp;nextBinary()</pre>
<div class="block">Returns the next value as a Binary.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next value as a Binary</dd>
</dl>
</li>
</ul>
<a name="nextNull--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextNull</h4>
<pre>public&nbsp;&lt;N&gt;&nbsp;N&nbsp;nextNull()</pre>
<div class="block">Returns null and advances the iterator.
<p>
This method has the same behavior as <code>Iterator.next()</code> and will advance this iterator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null</dd>
</dl>
</li>
</ul>
<a name="pageIterator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>pageIterator</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/iceberg/parquet/BasePageIterator.html" title="class in org.apache.iceberg.parquet">BasePageIterator</a>&nbsp;pageIterator()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html#pageIterator--">pageIterator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/iceberg/parquet/BaseColumnIterator.html" title="class in org.apache.iceberg.parquet">BaseColumnIterator</a></code></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="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/iceberg/parquet/BasePageIterator.IntIterator.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/iceberg/parquet/ColumnWriter.html" title="class in org.apache.iceberg.parquet"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/parquet/ColumnIterator.html" target="_top">Frames</a></li>
<li><a href="ColumnIterator.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.iceberg.parquet.BaseColumnIterator">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>