Google Git
Sign in
apache / iceberg / refs/heads/asf-site / . / javadoc / 0.10.0 / org / apache / iceberg / FileScanTask.html
blob: ab3660e88133c81f8ba17b5ede42334c5e89a65d [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_201) on Mon Nov 16 15:41:49 PST 2020 -->
<title>FileScanTask</title>
<meta name="date" content="2020-11-16">
<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="FileScanTask";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":6,"i3":18,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/Files.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/FindFiles.html" title="class 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/FileScanTask.html" target="_top">Frames</a></li>
<li><a href="FileScanTask.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 FileScanTask" class="title">Interface FileScanTask</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a>, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/apache/iceberg/DataTask.html" title="interface in org.apache.iceberg">DataTask</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">FileScanTask</span>
extends <a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></pre>
<div class="block">A scan task over a range of a single file.</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><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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#asFileScanTask--">asFileScanTask</a></span>()</code>
<div class="block">Returns this cast to <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#deletes--">deletes</a></span>()</code>
<div class="block">A list of <a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg"><code>delete files</code></a> to apply when reading the task's data file.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg">DataFile</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#file--">file</a></span>()</code>
<div class="block">The <a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><code>file</code></a> to scan.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#isFileScanTask--">isFileScanTask</a></span>()</code>
<div class="block">Returns true if this is a <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a>, false otherwise.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#length--">length</a></span>()</code>
<div class="block">The number of bytes to scan from the <a href="../../../org/apache/iceberg/FileScanTask.html#start--"><code>start()</code></a> position in the file.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#residual--">residual</a></span>()</code>
<div class="block">Returns the residual expression that should be applied to rows in this file scan.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#spec--">spec</a></span>()</code>
<div class="block">The <a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg"><code>spec</code></a> used to store this file.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.lang.Iterable&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#split-long-">split</a></span>(long&nbsp;splitSize)</code>
<div class="block">Splits this scan task into component <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>scan tasks</code></a>, each of <code>splitSize</code> size</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/FileScanTask.html#start--">start</a></span>()</code>
<div class="block">The starting position of this scan range in the file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.ScanTask">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.iceberg.<a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></h3>
<code><a href="../../../org/apache/iceberg/ScanTask.html#asCombinedScanTask--">asCombinedScanTask</a>, <a href="../../../org/apache/iceberg/ScanTask.html#asDataTask--">asDataTask</a>, <a href="../../../org/apache/iceberg/ScanTask.html#isDataTask--">isDataTask</a></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="file--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>file</h4>
<pre><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg">DataFile</a>&nbsp;file()</pre>
<div class="block">The <a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><code>file</code></a> to scan.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the file to scan</dd>
</dl>
</li>
</ul>
<a name="deletes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deletes</h4>
<pre>java.util.List&lt;<a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg">DeleteFile</a>&gt;&nbsp;deletes()</pre>
<div class="block">A list of <a href="../../../org/apache/iceberg/DeleteFile.html" title="interface in org.apache.iceberg"><code>delete files</code></a> to apply when reading the task's data file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of delete files to apply</dd>
</dl>
</li>
</ul>
<a name="spec--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>spec</h4>
<pre><a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg">PartitionSpec</a>&nbsp;spec()</pre>
<div class="block">The <a href="../../../org/apache/iceberg/PartitionSpec.html" title="class in org.apache.iceberg"><code>spec</code></a> used to store this file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the partition spec from this file's manifest</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>long&nbsp;start()</pre>
<div class="block">The starting position of this scan range in the file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the start position of this scan range</dd>
</dl>
</li>
</ul>
<a name="length--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>length</h4>
<pre>long&nbsp;length()</pre>
<div class="block">The number of bytes to scan from the <a href="../../../org/apache/iceberg/FileScanTask.html#start--"><code>start()</code></a> position in the file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the length of this scan range in bytes</dd>
</dl>
</li>
</ul>
<a name="residual--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>residual</h4>
<pre><a href="../../../org/apache/iceberg/expressions/Expression.html" title="interface in org.apache.iceberg.expressions">Expression</a>&nbsp;residual()</pre>
<div class="block">Returns the residual expression that should be applied to rows in this file scan.
<p>
The residual expression for a file is a filter expression created from the scan's filter, inclusive
any predicates that are true or false for the entire file removed, based on the file's
partition data.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a residual expression to apply to rows from this scan</dd>
</dl>
</li>
</ul>
<a name="split-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>split</h4>
<pre>java.lang.Iterable&lt;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&gt;&nbsp;split(long&nbsp;splitSize)</pre>
<div class="block">Splits this scan task into component <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>scan tasks</code></a>, each of <code>splitSize</code> size</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>splitSize</code> - The size of a component scan task</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Iterable of <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>scan tasks</code></a></dd>
</dl>
</li>
</ul>
<a name="isFileScanTask--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFileScanTask</h4>
<pre>default&nbsp;boolean&nbsp;isFileScanTask()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/ScanTask.html#isFileScanTask--">ScanTask</a></code></span></div>
<div class="block">Returns true if this is a <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a>, false otherwise.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/ScanTask.html#isFileScanTask--">isFileScanTask</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd>
</dl>
</li>
</ul>
<a name="asFileScanTask--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asFileScanTask</h4>
<pre>default&nbsp;<a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>&nbsp;asFileScanTask()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../org/apache/iceberg/ScanTask.html#asFileScanTask--">ScanTask</a></code></span></div>
<div class="block">Returns this cast to <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../org/apache/iceberg/ScanTask.html#asFileScanTask--">asFileScanTask</a></code>&nbsp;in interface&nbsp;<code><a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this cast to <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg"><code>FileScanTask</code></a> if it is one</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/Files.html" title="class in org.apache.iceberg"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/iceberg/FindFiles.html" title="class 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/FileScanTask.html" target="_top">Frames</a></li>
<li><a href="FileScanTask.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>