blob: 1b369dccee7a2b85f5be2b2e7ca94e7f963f0804 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Tue Jul 14 14:13:05 PDT 2020 -->
<title>DataFile</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2020-07-14">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DataFile";
}
}
catch(err) {
}
//-->
var data = {"i0":18,"i1":1};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.iceberg</a></div>
<h2 title="Interface DataFile" class="title">Interface DataFile</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&gt;</code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="spark/SparkDataFile.html" title="class in org.apache.iceberg.spark">SparkDataFile</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">DataFile</span>
extends <a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&gt;</pre>
<div class="block">Interface for data files listed in a table manifest.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COLUMN_SIZES">COLUMN_SIZES</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CONTENT">CONTENT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FILE_FORMAT">FILE_FORMAT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FILE_PATH">FILE_PATH</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FILE_SIZE">FILE_SIZE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#KEY_METADATA">KEY_METADATA</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOWER_BOUNDS">LOWER_BOUNDS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NULL_VALUE_COUNTS">NULL_VALUE_COUNTS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARTITION_DOC">PARTITION_DOC</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARTITION_ID">PARTITION_ID</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARTITION_NAME">PARTITION_NAME</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RECORD_COUNT">RECORD_COUNT</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SPLIT_OFFSETS">SPLIT_OFFSETS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UPPER_BOUNDS">UPPER_BOUNDS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#VALUE_COUNTS">VALUE_COUNTS</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default <a href="FileContent.html" title="enum in org.apache.iceberg">FileContent</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#content()">content</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType(org.apache.iceberg.types.Types.StructType)">getType</a></span>&#8203;(<a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a>&nbsp;partitionType)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.iceberg.ContentFile">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.iceberg.<a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a></h3>
<code><a href="ContentFile.html#columnSizes()">columnSizes</a>, <a href="ContentFile.html#copy()">copy</a>, <a href="ContentFile.html#copyWithoutStats()">copyWithoutStats</a>, <a href="ContentFile.html#fileSizeInBytes()">fileSizeInBytes</a>, <a href="ContentFile.html#format()">format</a>, <a href="ContentFile.html#keyMetadata()">keyMetadata</a>, <a href="ContentFile.html#lowerBounds()">lowerBounds</a>, <a href="ContentFile.html#nullValueCounts()">nullValueCounts</a>, <a href="ContentFile.html#partition()">partition</a>, <a href="ContentFile.html#path()">path</a>, <a href="ContentFile.html#recordCount()">recordCount</a>, <a href="ContentFile.html#splitOffsets()">splitOffsets</a>, <a href="ContentFile.html#upperBounds()">upperBounds</a>, <a href="ContentFile.html#valueCounts()">valueCounts</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="CONTENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONTENT</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> CONTENT</pre>
</li>
</ul>
<a id="FILE_PATH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FILE_PATH</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> FILE_PATH</pre>
</li>
</ul>
<a id="FILE_FORMAT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FILE_FORMAT</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> FILE_FORMAT</pre>
</li>
</ul>
<a id="RECORD_COUNT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECORD_COUNT</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> RECORD_COUNT</pre>
</li>
</ul>
<a id="FILE_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FILE_SIZE</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> FILE_SIZE</pre>
</li>
</ul>
<a id="COLUMN_SIZES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>COLUMN_SIZES</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> COLUMN_SIZES</pre>
</li>
</ul>
<a id="VALUE_COUNTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VALUE_COUNTS</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> VALUE_COUNTS</pre>
</li>
</ul>
<a id="NULL_VALUE_COUNTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NULL_VALUE_COUNTS</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> NULL_VALUE_COUNTS</pre>
</li>
</ul>
<a id="LOWER_BOUNDS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOWER_BOUNDS</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> LOWER_BOUNDS</pre>
</li>
</ul>
<a id="UPPER_BOUNDS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UPPER_BOUNDS</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> UPPER_BOUNDS</pre>
</li>
</ul>
<a id="KEY_METADATA">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>KEY_METADATA</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> KEY_METADATA</pre>
</li>
</ul>
<a id="SPLIT_OFFSETS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SPLIT_OFFSETS</h4>
<pre>static final&nbsp;<a href="types/Types.NestedField.html" title="class in org.apache.iceberg.types">Types.NestedField</a> SPLIT_OFFSETS</pre>
</li>
</ul>
<a id="PARTITION_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTITION_ID</h4>
<pre>static final&nbsp;int PARTITION_ID</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.iceberg.DataFile.PARTITION_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="PARTITION_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTITION_NAME</h4>
<pre>static final&nbsp;java.lang.String PARTITION_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.iceberg.DataFile.PARTITION_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="PARTITION_DOC">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PARTITION_DOC</h4>
<pre>static final&nbsp;java.lang.String PARTITION_DOC</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.apache.iceberg.DataFile.PARTITION_DOC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getType(org.apache.iceberg.types.Types.StructType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">static&nbsp;<a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a>&nbsp;getType&#8203;(<a href="types/Types.StructType.html" title="class in org.apache.iceberg.types">Types.StructType</a>&nbsp;partitionType)</pre>
</li>
</ul>
<a id="content()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>content</h4>
<pre class="methodSignature">default&nbsp;<a href="FileContent.html" title="enum in org.apache.iceberg">FileContent</a>&nbsp;content()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ContentFile.html#content()">content</a></code>&nbsp;in interface&nbsp;<code><a href="ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a>&lt;<a href="DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the content stored in the file; one of DATA, POSITION_DELETES, or EQUALITY_DELETES</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>