| <!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>ContentScanTask</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="ContentScanTask"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":18,"i1":6,"i2":6,"i3":18,"i4":6,"i5":18,"i6":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/ContentFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/ContentScanTask.html" target="_top">Frames</a></li> |
| <li><a href="ContentScanTask.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 ContentScanTask" class="title">Interface ContentScanTask<F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><F>></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 Java class of the content file</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../org/apache/iceberg/PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a>, <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/AddedRowsScanTask.html" title="interface in org.apache.iceberg">AddedRowsScanTask</a>, <a href="../../../org/apache/iceberg/DataTask.html" title="interface in org.apache.iceberg">DataTask</a>, <a href="../../../org/apache/iceberg/DeletedDataFileScanTask.html" title="interface in org.apache.iceberg">DeletedDataFileScanTask</a>, <a href="../../../org/apache/iceberg/DeletedRowsScanTask.html" title="interface in org.apache.iceberg">DeletedRowsScanTask</a>, <a href="../../../org/apache/iceberg/FileScanTask.html" title="interface in org.apache.iceberg">FileScanTask</a>, <a href="../../../org/apache/iceberg/PositionDeletesScanTask.html" title="interface in org.apache.iceberg">PositionDeletesScanTask</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../org/apache/iceberg/BaseFileScanTask.html" title="class in org.apache.iceberg">BaseFileScanTask</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ContentScanTask<F extends <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg">ContentFile</a><F>></span> |
| extends <a href="../../../org/apache/iceberg/ScanTask.html" title="interface in org.apache.iceberg">ScanTask</a>, <a href="../../../org/apache/iceberg/PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a></pre> |
| <div class="block">A scan task over a range of bytes in a content 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </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 long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentScanTask.html#estimatedRowsCount--">estimatedRowsCount</a></span>()</code> |
| <div class="block">The estimated number of rows produced by this scan task.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/iceberg/ContentScanTask.html" title="type parameter in ContentScanTask">F</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentScanTask.html#file--">file</a></span>()</code> |
| <div class="block">The <a href="../../../org/apache/iceberg/ContentFile.html" title="interface in org.apache.iceberg"><code>file</code></a> to scan.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentScanTask.html#length--">length</a></span>()</code> |
| <div class="block">The number of bytes to scan from the <a href="../../../org/apache/iceberg/ContentScanTask.html#start--"><code>start()</code></a> position in the file.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <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/ContentScanTask.html#partition--">partition</a></span>()</code> |
| <div class="block">Returns the value of the partition for this scan task</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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/ContentScanTask.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="i5" class="rowColor"> |
| <td class="colFirst"><code>default long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentScanTask.html#sizeBytes--">sizeBytes</a></span>()</code> |
| <div class="block">The number of bytes that should be read by this scan task.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/iceberg/ContentScanTask.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.PartitionScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.iceberg.<a href="../../../org/apache/iceberg/PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a></h3> |
| <code><a href="../../../org/apache/iceberg/PartitionScanTask.html#spec--">spec</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.iceberg.ScanTask"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface 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#asFileScanTask--">asFileScanTask</a>, <a href="../../../org/apache/iceberg/ScanTask.html#filesCount--">filesCount</a>, <a href="../../../org/apache/iceberg/ScanTask.html#isDataTask--">isDataTask</a>, <a href="../../../org/apache/iceberg/ScanTask.html#isFileScanTask--">isFileScanTask</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/ContentScanTask.html" title="type parameter in ContentScanTask">F</a> file()</pre> |
| <div class="block">The <a href="../../../org/apache/iceberg/ContentFile.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="partition--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>partition</h4> |
| <pre>default <a href="../../../org/apache/iceberg/StructLike.html" title="interface in org.apache.iceberg">StructLike</a> partition()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/iceberg/PartitionScanTask.html#partition--">PartitionScanTask</a></code></span></div> |
| <div class="block">Returns the value of the partition for this scan task</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/PartitionScanTask.html#partition--">partition</a></code> in interface <code><a href="../../../org/apache/iceberg/PartitionScanTask.html" title="interface in org.apache.iceberg">PartitionScanTask</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sizeBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sizeBytes</h4> |
| <pre>default long sizeBytes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/iceberg/ScanTask.html#sizeBytes--">ScanTask</a></code></span></div> |
| <div class="block">The number of bytes that should be read by this scan task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/ScanTask.html#sizeBytes--">sizeBytes</a></code> in interface <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>the total number of bytes to read</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="start--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre>long 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 length()</pre> |
| <div class="block">The number of bytes to scan from the <a href="../../../org/apache/iceberg/ContentScanTask.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> 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 by partially evaluating |
| the scan's filter using 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="estimatedRowsCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>estimatedRowsCount</h4> |
| <pre>default long estimatedRowsCount()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../org/apache/iceberg/ScanTask.html#estimatedRowsCount--">ScanTask</a></code></span></div> |
| <div class="block">The estimated number of rows produced by this scan task.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../org/apache/iceberg/ScanTask.html#estimatedRowsCount--">estimatedRowsCount</a></code> in interface <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>the estimated number of produced rows</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/ContentFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/iceberg/DataFile.html" title="interface in org.apache.iceberg"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/iceberg/ContentScanTask.html" target="_top">Frames</a></li> |
| <li><a href="ContentScanTask.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
