blob: 4e9ee6f78b4076bda1a413cd42fba63a2538446c [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 (1.8.0_231) on Tue Jan 26 14:32:16 PST 2021 -->
<title>ContentFile</title>
<meta name="date" content="2021-01-26">
<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="ContentFile";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":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="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/CombinedScanTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/ContentFile.html" target="_top">Frames</a></li>
<li><a href="ContentFile.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>Field&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</div>
<h2 title="Interface ContentFile" class="title">Interface ContentFile&lt;F&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>F</code> - the concrete Java class of a ContentFile instance.</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg">DataFile</a>, <a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/iceberg/spark/SparkDataFile.html" title="class in org.apache.iceberg.spark">SparkDataFile</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ContentFile&lt;F&gt;</span></pre>
<div class="block">Superinterface of <a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><code>DataFile</code></a> and <a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg"><code>DeleteFile</code></a> that exposes common methods.</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">&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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#columnSizes--">columnSizes</a></span>()</code>
<div class="block">Returns if collected, map from column ID to the size of the column in bytes, null otherwise.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/FileContent.html" title="enum in org.apache.iceberg">FileContent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#content--">content</a></span>()</code>
<div class="block">Returns type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/ContentFile.html" title="type parameter in ContentFile">F</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#copy--">copy</a></span>()</code>
<div class="block">Copies this file.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/ContentFile.html" title="type parameter in ContentFile">F</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#copyWithoutStats--">copyWithoutStats</a></span>()</code>
<div class="block">Copies this file without file stats.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Integer&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#equalityFieldIds--">equalityFieldIds</a></span>()</code>
<div class="block">Returns the set of field IDs used for equality comparison, in equality delete files.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#fileSizeInBytes--">fileSizeInBytes</a></span>()</code>
<div class="block">Returns the file size in bytes.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#format--">format</a></span>()</code>
<div class="block">Returns format of the file.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.nio.ByteBuffer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#keyMetadata--">keyMetadata</a></span>()</code>
<div class="block">Returns metadata about how this file is encrypted, or null if the file is stored in plain text.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,java.nio.ByteBuffer&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#lowerBounds--">lowerBounds</a></span>()</code>
<div class="block">Returns if collected, map from column ID to value lower bounds, null otherwise.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#nanValueCounts--">nanValueCounts</a></span>()</code>
<div class="block">Returns if collected, map from column ID to its NaN value count, null otherwise.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#nullValueCounts--">nullValueCounts</a></span>()</code>
<div class="block">Returns if collected, map from column ID to its null value count, null otherwise.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg">StructLike</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#partition--">partition</a></span>()</code>
<div class="block">Returns partition for this file as a <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>java.lang.CharSequence</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#path--">path</a></span>()</code>
<div class="block">Returns fully qualified path to the file, suitable for constructing a Hadoop Path.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.Long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#pos--">pos</a></span>()</code>
<div class="block">Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#recordCount--">recordCount</a></span>()</code>
<div class="block">Returns the number of top-level records in the file.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#specId--">specId</a></span>()</code>
<div class="block">Returns id of the partition spec used for partition metadata.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#splitOffsets--">splitOffsets</a></span>()</code>
<div class="block">Returns list of recommended split locations, if applicable, null otherwise.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,java.nio.ByteBuffer&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#upperBounds--">upperBounds</a></span>()</code>
<div class="block">Returns if collected, map from column ID to value upper bounds, null otherwise.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentFile.html#valueCounts--">valueCounts</a></span>()</code>
<div class="block">Returns if collected, map from column ID to the count of its non-null values, null otherwise.</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="pos--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pos</h4>
<pre>java.lang.Long&nbsp;pos()</pre>
<div class="block">Returns the ordinal position of the file in a manifest, or null if it was not read from a manifest.</div>
</li>
</ul>
<a name="specId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>specId</h4>
<pre>int&nbsp;specId()</pre>
<div class="block">Returns id of the partition spec used for partition metadata.</div>
</li>
</ul>
<a name="content--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>content</h4>
<pre><a href="../../../org/apache/iceberg/FileContent.html" title="enum in org.apache.iceberg">FileContent</a>&nbsp;content()</pre>
<div class="block">Returns type of content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES.</div>
</li>
</ul>
<a name="path--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>path</h4>
<pre>java.lang.CharSequence&nbsp;path()</pre>
<div class="block">Returns fully qualified path to the file, suitable for constructing a Hadoop Path.</div>
</li>
</ul>
<a name="format--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre><a href="../../../org/apache/iceberg/FileFormat.html" title="enum in org.apache.iceberg">FileFormat</a>&nbsp;format()</pre>
<div class="block">Returns format of the file.</div>
</li>
</ul>
<a name="partition--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>partition</h4>
<pre><a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg">StructLike</a>&nbsp;partition()</pre>
<div class="block">Returns partition for this file as a <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg"><code>StructLike</code></a>.</div>
</li>
</ul>
<a name="recordCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recordCount</h4>
<pre>long&nbsp;recordCount()</pre>
<div class="block">Returns the number of top-level records in the file.</div>
</li>
</ul>
<a name="fileSizeInBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fileSizeInBytes</h4>
<pre>long&nbsp;fileSizeInBytes()</pre>
<div class="block">Returns the file size in bytes.</div>
</li>
</ul>
<a name="columnSizes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnSizes</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;&nbsp;columnSizes()</pre>
<div class="block">Returns if collected, map from column ID to the size of the column in bytes, null otherwise.</div>
</li>
</ul>
<a name="valueCounts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueCounts</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;&nbsp;valueCounts()</pre>
<div class="block">Returns if collected, map from column ID to the count of its non-null values, null otherwise.</div>
</li>
</ul>
<a name="nullValueCounts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nullValueCounts</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;&nbsp;nullValueCounts()</pre>
<div class="block">Returns if collected, map from column ID to its null value count, null otherwise.</div>
</li>
</ul>
<a name="nanValueCounts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nanValueCounts</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.lang.Long&gt;&nbsp;nanValueCounts()</pre>
<div class="block">Returns if collected, map from column ID to its NaN value count, null otherwise.</div>
</li>
</ul>
<a name="lowerBounds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lowerBounds</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.nio.ByteBuffer&gt;&nbsp;lowerBounds()</pre>
<div class="block">Returns if collected, map from column ID to value lower bounds, null otherwise.</div>
</li>
</ul>
<a name="upperBounds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>upperBounds</h4>
<pre>java.util.Map&lt;java.lang.Integer,java.nio.ByteBuffer&gt;&nbsp;upperBounds()</pre>
<div class="block">Returns if collected, map from column ID to value upper bounds, null otherwise.</div>
</li>
</ul>
<a name="keyMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyMetadata</h4>
<pre>java.nio.ByteBuffer&nbsp;keyMetadata()</pre>
<div class="block">Returns metadata about how this file is encrypted, or null if the file is stored in plain text.</div>
</li>
</ul>
<a name="splitOffsets--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>splitOffsets</h4>
<pre>java.util.List&lt;java.lang.Long&gt;&nbsp;splitOffsets()</pre>
<div class="block">Returns list of recommended split locations, if applicable, null otherwise.
<p>
When available, this information is used for planning scan tasks whose boundaries
are determined by these offsets. The returned list must be sorted in ascending order.</div>
</li>
</ul>
<a name="equalityFieldIds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalityFieldIds</h4>
<pre>java.util.List&lt;java.lang.Integer&gt;&nbsp;equalityFieldIds()</pre>
<div class="block">Returns the set of field IDs used for equality comparison, in equality delete files.
<p>
An equality delete file may contain additional data fields that are not used by equality
comparison. The subset of columns in a delete file to be used in equality comparison are
tracked by ID. Extra columns can be used to reconstruct changes and metrics from extra
columns are used during job planning.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>IDs of the fields used in equality comparison with the records in this delete file</dd>
</dl>
</li>
</ul>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre><a href="../../../org/apache/iceberg/ContentFile.html" title="type parameter in ContentFile">F</a>&nbsp;copy()</pre>
<div class="block">Copies this file. Manifest readers can reuse file instances; use
this method to copy data when collecting files from tasks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this data file</dd>
</dl>
</li>
</ul>
<a name="copyWithoutStats--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>copyWithoutStats</h4>
<pre><a href="../../../org/apache/iceberg/ContentFile.html" title="type parameter in ContentFile">F</a>&nbsp;copyWithoutStats()</pre>
<div class="block">Copies this file without file stats. Manifest readers can reuse file instances; use
this method to copy data without stats when collecting files.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this data file, without lower bounds, upper bounds, value counts,
null value counts, or nan value counts</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/CombinedScanTask.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/iceberg/ContentFile.html" target="_top">Frames</a></li>
<li><a href="ContentFile.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>Field&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>