| <!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_252) on Sun Apr 26 20:47:05 PDT 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>RecordReaderUtils (ORC Core 1.6.3 API)</title> |
| <meta name="date" content="2020-04-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="RecordReaderUtils (ORC Core 1.6.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/RecordReaderUtils.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/RecordReaderImpl.ZeroPositionProvider.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/orc/impl/RecordReaderUtils.ByteBufferAllocatorPool.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/orc/impl/RecordReaderUtils.html" target="_top">Frames</a></li> |
| <li><a href="RecordReaderUtils.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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</div> |
| <h2 title="Class RecordReaderUtils" class="title">Class RecordReaderUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://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.RecordReaderUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">RecordReaderUtils</span> |
| extends <a href="http://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">Stateless methods shared between RecordReaderImpl and EncodedReaderImpl.</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"> </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 </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/RecordReaderUtils.ByteBufferAllocatorPool.html" title="class in org.apache.orc.impl">RecordReaderUtils.ByteBufferAllocatorPool</a></span></code> </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"> </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/RecordReaderUtils.html#RecordReaderUtils--">RecordReaderUtils</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static <a href="../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/RecordReaderUtils.html#createDefaultDataReader-org.apache.orc.impl.DataReaderProperties-">createDefaultDataReader</a></span>(<a href="../../../../org/apache/orc/impl/DataReaderProperties.html" title="class in org.apache.orc.impl">DataReaderProperties</a> properties)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/RecordReaderUtils.html#estimateRgEndOffset-boolean-int-boolean-long-long-">estimateRgEndOffset</a></span>(boolean isCompressed, |
| int bufferSize, |
| boolean isLast, |
| long nextGroupOffset, |
| long streamLength)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/RecordReaderUtils.html#getIndexPosition-org.apache.orc.OrcProto.ColumnEncoding.Kind-org.apache.orc.TypeDescription.Category-org.apache.orc.OrcProto.Stream.Kind-boolean-boolean-">getIndexPosition</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnEncoding.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnEncoding.Kind</a> columnEncoding, |
| <a href="../../../../org/apache/orc/TypeDescription.Category.html" title="enum in org.apache.orc">TypeDescription.Category</a> columnType, |
| <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a> streamType, |
| boolean isCompressed, |
| boolean hasNulls)</code> |
| <div class="block">Get the offset in the index positions for the column that the given |
| stream starts.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/orc/impl/RecordReaderUtils.html#isDictionary-org.apache.orc.OrcProto.Stream.Kind-org.apache.orc.OrcProto.ColumnEncoding-">isDictionary</a></span>(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a> kind, |
| <a href="http://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> encoding)</code> |
| <div class="block">Is this stream part of a dictionary?</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://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/RecordReaderUtils.html#stringifyDiskRanges-org.apache.hadoop.hive.common.io.DiskRangeList-">stringifyDiskRanges</a></span>(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a> range)</code> |
| <div class="block">Build a string representation of a list of disk ranges.</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 java.lang.<a href="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="http://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="RecordReaderUtils--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>RecordReaderUtils</h4> |
| <pre>public RecordReaderUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createDefaultDataReader-org.apache.orc.impl.DataReaderProperties-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createDefaultDataReader</h4> |
| <pre>public static <a href="../../../../org/apache/orc/DataReader.html" title="interface in org.apache.orc">DataReader</a> createDefaultDataReader(<a href="../../../../org/apache/orc/impl/DataReaderProperties.html" title="class in org.apache.orc.impl">DataReaderProperties</a> properties)</pre> |
| </li> |
| </ul> |
| <a name="estimateRgEndOffset-boolean-int-boolean-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>estimateRgEndOffset</h4> |
| <pre>public static long estimateRgEndOffset(boolean isCompressed, |
| int bufferSize, |
| boolean isLast, |
| long nextGroupOffset, |
| long streamLength)</pre> |
| </li> |
| </ul> |
| <a name="getIndexPosition-org.apache.orc.OrcProto.ColumnEncoding.Kind-org.apache.orc.TypeDescription.Category-org.apache.orc.OrcProto.Stream.Kind-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIndexPosition</h4> |
| <pre>public static int getIndexPosition(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.ColumnEncoding.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.ColumnEncoding.Kind</a> columnEncoding, |
| <a href="../../../../org/apache/orc/TypeDescription.Category.html" title="enum in org.apache.orc">TypeDescription.Category</a> columnType, |
| <a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a> streamType, |
| boolean isCompressed, |
| boolean hasNulls)</pre> |
| <div class="block">Get the offset in the index positions for the column that the given |
| stream starts.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>columnEncoding</code> - the encoding of the column</dd> |
| <dd><code>columnType</code> - the type of the column</dd> |
| <dd><code>streamType</code> - the kind of the stream</dd> |
| <dd><code>isCompressed</code> - is the stream compressed?</dd> |
| <dd><code>hasNulls</code> - does the column have a PRESENT stream?</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of positions that will be used for that stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDictionary-org.apache.orc.OrcProto.Stream.Kind-org.apache.orc.OrcProto.ColumnEncoding-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDictionary</h4> |
| <pre>public static boolean isDictionary(<a href="http://orc.apache.org/api/orc-core/org/apache/orc/OrcProto.Stream.Kind.html?is-external=true" title="class or interface in org.apache.orc">OrcProto.Stream.Kind</a> kind, |
| <a href="http://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> encoding)</pre> |
| <div class="block">Is this stream part of a dictionary?</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>is this part of a dictionary?</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stringifyDiskRanges-org.apache.hadoop.hive.common.io.DiskRangeList-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stringifyDiskRanges</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stringifyDiskRanges(<a href="http://orc.apache.org/api/hive-storage-api/org/apache/hadoop/hive/common/io/DiskRangeList.html?is-external=true" title="class or interface in org.apache.hadoop.hive.common.io">DiskRangeList</a> range)</pre> |
| <div class="block">Build a string representation of a list of disk ranges.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>range</code> - ranges to stringify</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the resulting string</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/RecordReaderUtils.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/RecordReaderImpl.ZeroPositionProvider.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/orc/impl/RecordReaderUtils.ByteBufferAllocatorPool.html" title="class in org.apache.orc.impl"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/orc/impl/RecordReaderUtils.html" target="_top">Frames</a></li> |
| <li><a href="RecordReaderUtils.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2013–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
