<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>StripePlanner (ORC Core 1.9.0 API)</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="StripePlanner (ORC Core 1.9.0 API)";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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="class-use/StripePlanner.html">Use</a></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/orc/impl/reader/ReaderEncryptionVariant.html" title="class in org.apache.orc.impl.reader"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.StreamInformation.html" title="class in org.apache.orc.impl.reader"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/orc/impl/reader/StripePlanner.html" target="_top">Frames</a></li>
<li><a href="StripePlanner.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.orc.impl.reader</div>
<h2 title="Class StripePlanner" class="title">Class StripePlanner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.orc.impl.reader.StripePlanner</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">StripePlanner</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">This class handles parsing the stripe information and handling the necessary
 filtering and selection.
 <p>
 It supports:
 <ul>
   <li>column projection</li>
   <li>row group selection</li>
   <li>encryption</li>
 </ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.StreamInformation.html" title="class in org.apache.orc.impl.reader">StripePlanner.StreamInformation</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#StripePlanner-org.apache.orc.impl.reader.StripePlanner-">StripePlanner</a></span>(<a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html" title="class in org.apache.orc.impl.reader">StripePlanner</a>&nbsp;old)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#StripePlanner-org.apache.orc.TypeDescription-org.apache.orc.impl.reader.ReaderEncryption-org.apache.orc.DataReader-org.apache.orc.OrcFile.WriterVersion-boolean-long-">StripePlanner</a></span>(<a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
             <a href="../../../../../org/apache/orc/impl/reader/ReaderEncryption.html" title="class in org.apache.orc.impl.reader">ReaderEncryption</a>&nbsp;encryption,
             <a href="../../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a>&nbsp;dataReader,
             <a href="../../../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a>&nbsp;version,
             boolean&nbsp;ignoreNonUtf8BloomFilter,
             long&nbsp;maxBufferSize)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#StripePlanner-org.apache.orc.TypeDescription-org.apache.orc.impl.reader.ReaderEncryption-org.apache.orc.DataReader-org.apache.orc.OrcFile.WriterVersion-boolean-long-java.util.Set-">StripePlanner</a></span>(<a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
             <a href="../../../../../org/apache/orc/impl/reader/ReaderEncryption.html" title="class in org.apache.orc.impl.reader">ReaderEncryption</a>&nbsp;encryption,
             <a href="../../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a>&nbsp;dataReader,
             <a href="../../../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a>&nbsp;version,
             boolean&nbsp;ignoreNonUtf8BloomFilter,
             long&nbsp;maxBufferSize,
             <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;filterColIds)</code>
<div class="block">Create a stripe parser.</div>
</td>
</tr>
</table>
</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#clearStreams--">clearStreams</a></span>()</code>
<div class="block">Release all of the buffers for the current stripe.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnEncoding.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnEncoding</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#getEncoding-int-">getEncoding</a></span>(int&nbsp;column)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/orc/impl/InStream.html" title="class in org.apache.orc.impl">InStream</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#getStream-org.apache.orc.impl.StreamName-">getStream</a></span>(<a href="../../../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name)</code>
<div class="block">Get the stream for the given name.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#getWriterTimezone--">getWriterTimezone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html" title="class in org.apache.orc.impl.reader">StripePlanner</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#parseStripe-org.apache.orc.StripeInformation-boolean:A-">parseStripe</a></span>(<a href="../../../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a>&nbsp;stripe,
           boolean[]&nbsp;columnInclude)</code>
<div class="block">Parse a new stripe.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/orc/impl/BufferChunkList.html" title="class in org.apache.orc.impl">BufferChunkList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#readData-org.apache.orc.impl.OrcIndex-boolean:A-boolean-org.apache.orc.impl.reader.tree.TypeReader.ReadPhase-">readData</a></span>(<a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;index,
        boolean[]&nbsp;rowGroupInclude,
        boolean&nbsp;forceDirect,
        <a href="../../../../../org/apache/orc/impl/reader/tree/TypeReader.ReadPhase.html" title="enum in org.apache.orc.impl.reader.tree">TypeReader.ReadPhase</a>&nbsp;readPhase)</code>
<div class="block">Read the stripe data from the file.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/orc/impl/BufferChunkList.html" title="class in org.apache.orc.impl">BufferChunkList</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#readFollowData-org.apache.orc.impl.OrcIndex-boolean:A-int-boolean-">readFollowData</a></span>(<a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;index,
              boolean[]&nbsp;rowGroupInclude,
              int&nbsp;rgIdx,
              boolean&nbsp;forceDirect)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html#readRowIndex-boolean:A-org.apache.orc.impl.OrcIndex-">readRowIndex</a></span>(boolean[]&nbsp;sargColumns,
            <a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;output)</code>
<div class="block">Read and parse the indexes for the current stripe.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="StripePlanner-org.apache.orc.TypeDescription-org.apache.orc.impl.reader.ReaderEncryption-org.apache.orc.DataReader-org.apache.orc.OrcFile.WriterVersion-boolean-long-java.util.Set-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StripePlanner</h4>
<pre>public&nbsp;StripePlanner(<a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
                     <a href="../../../../../org/apache/orc/impl/reader/ReaderEncryption.html" title="class in org.apache.orc.impl.reader">ReaderEncryption</a>&nbsp;encryption,
                     <a href="../../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a>&nbsp;dataReader,
                     <a href="../../../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a>&nbsp;version,
                     boolean&nbsp;ignoreNonUtf8BloomFilter,
                     long&nbsp;maxBufferSize,
                     <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;filterColIds)</pre>
<div class="block">Create a stripe parser.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schema</code> - the file schema</dd>
<dd><code>encryption</code> - the encryption information</dd>
<dd><code>dataReader</code> - the underlying data reader</dd>
<dd><code>version</code> - the file writer version</dd>
<dd><code>ignoreNonUtf8BloomFilter</code> - ignore old non-utf8 bloom filters</dd>
<dd><code>maxBufferSize</code> - the largest single buffer to use</dd>
<dd><code>filterColIds</code> - Column Ids that identify the filter columns</dd>
</dl>
</li>
</ul>
<a name="StripePlanner-org.apache.orc.TypeDescription-org.apache.orc.impl.reader.ReaderEncryption-org.apache.orc.DataReader-org.apache.orc.OrcFile.WriterVersion-boolean-long-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StripePlanner</h4>
<pre>public&nbsp;StripePlanner(<a href="../../../../../org/apache/orc/TypeDescription.html" title="class in org.apache.orc">TypeDescription</a>&nbsp;schema,
                     <a href="../../../../../org/apache/orc/impl/reader/ReaderEncryption.html" title="class in org.apache.orc.impl.reader">ReaderEncryption</a>&nbsp;encryption,
                     <a href="../../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a>&nbsp;dataReader,
                     <a href="../../../../../org/apache/orc/OrcFile.WriterVersion.html" title="enum in org.apache.orc">OrcFile.WriterVersion</a>&nbsp;version,
                     boolean&nbsp;ignoreNonUtf8BloomFilter,
                     long&nbsp;maxBufferSize)</pre>
</li>
</ul>
<a name="StripePlanner-org.apache.orc.impl.reader.StripePlanner-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StripePlanner</h4>
<pre>public&nbsp;StripePlanner(<a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html" title="class in org.apache.orc.impl.reader">StripePlanner</a>&nbsp;old)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="parseStripe-org.apache.orc.StripeInformation-boolean:A-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>parseStripe</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/orc/impl/reader/StripePlanner.html" title="class in org.apache.orc.impl.reader">StripePlanner</a>&nbsp;parseStripe(<a href="../../../../../org/apache/orc/StripeInformation.html" title="interface in org.apache.orc">StripeInformation</a>&nbsp;stripe,
                                 boolean[]&nbsp;columnInclude)
                          throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Parse a new stripe. Resets the current stripe state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stripe</code> - the new stripe</dd>
<dd><code>columnInclude</code> - an array with true for each column to read</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this for method chaining</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="readData-org.apache.orc.impl.OrcIndex-boolean:A-boolean-org.apache.orc.impl.reader.tree.TypeReader.ReadPhase-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/orc/impl/BufferChunkList.html" title="class in org.apache.orc.impl">BufferChunkList</a>&nbsp;readData(<a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;index,
                                boolean[]&nbsp;rowGroupInclude,
                                boolean&nbsp;forceDirect,
                                <a href="../../../../../org/apache/orc/impl/reader/tree/TypeReader.ReadPhase.html" title="enum in org.apache.orc.impl.reader.tree">TypeReader.ReadPhase</a>&nbsp;readPhase)
                         throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read the stripe data from the file.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>index</code> - null for no row filters or the index for filtering</dd>
<dd><code>rowGroupInclude</code> - null for all of the rows or an array with boolean
                       for each row group in the current stripe.</dd>
<dd><code>forceDirect</code> - should direct buffers be created?</dd>
<dd><code>readPhase</code> - influences the columns that are read e.g. if readPhase = LEADERS then only
                  the data required for FILTER columns is read</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the buffers that were read</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="readFollowData-org.apache.orc.impl.OrcIndex-boolean:A-int-boolean-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readFollowData</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/orc/impl/BufferChunkList.html" title="class in org.apache.orc.impl">BufferChunkList</a>&nbsp;readFollowData(<a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;index,
                                      boolean[]&nbsp;rowGroupInclude,
                                      int&nbsp;rgIdx,
                                      boolean&nbsp;forceDirect)
                               throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getWriterTimezone--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriterTimezone</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getWriterTimezone()</pre>
</li>
</ul>
<a name="getStream-org.apache.orc.impl.StreamName-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStream</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/orc/impl/InStream.html" title="class in org.apache.orc.impl">InStream</a>&nbsp;getStream(<a href="../../../../../org/apache/orc/impl/StreamName.html" title="class in org.apache.orc.impl">StreamName</a>&nbsp;name)
                   throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Get the stream for the given name.
 It is assumed that the name does <b>not</b> have the encryption set,
 because the TreeReader's don't know if they are reading encrypted data.
 Assumes that readData has already been called on this stripe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the column/kind of the stream</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new stream with the options set correctly</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="clearStreams--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearStreams</h4>
<pre>public&nbsp;void&nbsp;clearStreams()</pre>
<div class="block">Release all of the buffers for the current stripe.</div>
</li>
</ul>
<a name="getEncoding-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public&nbsp;<a href="https://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnEncoding.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnEncoding</a>&nbsp;getEncoding(int&nbsp;column)</pre>
</li>
</ul>
<a name="readRowIndex-boolean:A-org.apache.orc.impl.OrcIndex-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readRowIndex</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;readRowIndex(boolean[]&nbsp;sargColumns,
                             <a href="../../../../../org/apache/orc/impl/OrcIndex.html" title="class in org.apache.orc.impl">OrcIndex</a>&nbsp;output)
                      throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read and parse the indexes for the current stripe.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sargColumns</code> - the columns we can use bloom filters for</dd>
<dd><code>output</code> - an OrcIndex to reuse</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the indexes for the required columns</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</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="class-use/StripePlanner.html">Use</a></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/orc/impl/reader/ReaderEncryptionVariant.html" title="class in org.apache.orc.impl.reader"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/orc/impl/reader/StripePlanner.StreamInformation.html" title="class in org.apache.orc.impl.reader"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/orc/impl/reader/StripePlanner.html" target="_top">Frames</a></li>
<li><a href="StripePlanner.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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2013&#x2013;2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
