| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>HFileBlockIndex.CellBasedKeyBlockIndexReaderV2 (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.io.hfile, class: HFileBlockIndex, class: CellBasedKeyBlockIndexReaderV2"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.io.hfile</a></div> |
| <h1 title="Class HFileBlockIndex.CellBasedKeyBlockIndexReaderV2" class="title">Class HFileBlockIndex.CellBasedKeyBlockIndexReaderV2</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="HFileBlockIndex.BlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.BlockIndexReader</a> |
| <div class="inheritance"><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader</a> |
| <div class="inheritance">org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReaderV2</div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="HFileBlockIndex.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">static class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.html#line-483">HFileBlockIndex.CellBasedKeyBlockIndexReaderV2</a></span> |
| <span class="extends-implements">extends <a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></span></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private <a href="HFileIndexBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#indexBlockEncoder" class="member-name-link">indexBlockEncoder</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="HFileIndexBlockEncoder.EncodedSeeker.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder.EncodedSeeker</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#seeker" class="member-name-link">seeker</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader">Fields inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></h3> |
| <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#comparator">comparator</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.BlockIndexReader">Fields inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlockIndex.BlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.BlockIndexReader</a></h3> |
| <code><a href="HFileBlockIndex.BlockIndexReader.html#blockDataSizes">blockDataSizes</a>, <a href="HFileBlockIndex.BlockIndexReader.html#blockOffsets">blockOffsets</a>, <a href="HFileBlockIndex.BlockIndexReader.html#midKeyEntry">midKeyEntry</a>, <a href="HFileBlockIndex.BlockIndexReader.html#midLeafBlockOffset">midLeafBlockOffset</a>, <a href="HFileBlockIndex.BlockIndexReader.html#midLeafBlockOnDiskSize">midLeafBlockOnDiskSize</a>, <a href="HFileBlockIndex.BlockIndexReader.html#rootCount">rootCount</a>, <a href="HFileBlockIndex.BlockIndexReader.html#searchTreeLevel">searchTreeLevel</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.CellComparator,int)" class="member-name-link">CellBasedKeyBlockIndexReaderV2</a><wbr>(<a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> c, |
| int treeLevel)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.CellComparator,int,org.apache.hadoop.hbase.io.hfile.HFileIndexBlockEncoder)" class="member-name-link">CellBasedKeyBlockIndexReaderV2</a><wbr>(<a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> c, |
| int treeLevel, |
| <a href="HFileIndexBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder</a> indexBlockEncoder)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#calculateHeapSizeForBlockKeys(long)" class="member-name-link">calculateHeapSizeForBlockKeys</a><wbr>(long heapSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRootBlockCount()" class="member-name-link">getRootBlockCount</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of root-level blocks in this block index</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRootBlockKey(int)" class="member-name-link">getRootBlockKey</a><wbr>(int i)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">from 0 to <a href="#getRootBlockCount()"><code>- 1</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if the block index is empty.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="BlockWithScanInfo.html" title="class in org.apache.hadoop.hbase.io.hfile">BlockWithScanInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadDataBlockWithScanInfo(org.apache.hadoop.hbase.ExtendedCell,org.apache.hadoop.hbase.io.hfile.HFileBlock,boolean,boolean,boolean,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)" class="member-name-link">loadDataBlockWithScanInfo</a><wbr>(<a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key, |
| <a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a> currentBlock, |
| boolean cacheBlocks, |
| boolean pread, |
| boolean isCompaction, |
| <a href="../encoding/DataBlockEncoding.html" title="enum class in org.apache.hadoop.hbase.io.encoding">DataBlockEncoding</a> expectedDataBlockEncoding, |
| <a href="HFile.CachingBlockReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.CachingBlockReader</a> cachingBlockReader)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the BlockWithScanInfo, a data structure which contains the Data HFileBlock with other |
| scan info such as the key that starts the next HFileBlock.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#midkey(org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)" class="member-name-link">midkey</a><wbr>(<a href="HFile.CachingBlockReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.CachingBlockReader</a> cachingBlockReader)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">An approximation to the <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a>'s mid-key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#readMultiLevelIndexRoot(org.apache.hadoop.hbase.io.hfile.HFileBlock,int)" class="member-name-link">readMultiLevelIndexRoot</a><wbr>(<a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a> blk, |
| int numEntries)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Read the root-level metadata of a multi-level block index.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rootBlockContainingKey(org.apache.hadoop.hbase.Cell)" class="member-name-link">rootBlockContainingKey</a><wbr>(<a href="../../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Finds the root-level index block containing the given key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader">Methods inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></h3> |
| <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#add(byte%5B%5D,long,int)">add</a>, <a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#initialize(int)">initialize</a>, <a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#rootBlockContainingKey(byte%5B%5D,int,int,org.apache.hadoop.hbase.CellComparator)">rootBlockContainingKey</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.BlockIndexReader">Methods inherited from class org.apache.hadoop.hbase.io.hfile.<a href="HFileBlockIndex.BlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.BlockIndexReader</a></h3> |
| <code><a href="HFileBlockIndex.BlockIndexReader.html#binarySearchNonRootIndex(org.apache.hadoop.hbase.Cell,org.apache.hadoop.hbase.nio.ByteBuff,org.apache.hadoop.hbase.CellComparator)">binarySearchNonRootIndex</a>, <a href="HFileBlockIndex.BlockIndexReader.html#ensureNonEmpty()">ensureNonEmpty</a>, <a href="HFileBlockIndex.BlockIndexReader.html#getNonRootIndexedKey(org.apache.hadoop.hbase.nio.ByteBuff,int)">getNonRootIndexedKey</a>, <a href="HFileBlockIndex.BlockIndexReader.html#getRootBlockDataSize(int)">getRootBlockDataSize</a>, <a href="HFileBlockIndex.BlockIndexReader.html#getRootBlockOffset(int)">getRootBlockOffset</a>, <a href="HFileBlockIndex.BlockIndexReader.html#heapSize()">heapSize</a>, <a href="HFileBlockIndex.BlockIndexReader.html#locateNonRootIndexEntry(org.apache.hadoop.hbase.nio.ByteBuff,org.apache.hadoop.hbase.Cell,org.apache.hadoop.hbase.CellComparator)">locateNonRootIndexEntry</a>, <a href="HFileBlockIndex.BlockIndexReader.html#readRootIndex(java.io.DataInput,int)">readRootIndex</a>, <a href="HFileBlockIndex.BlockIndexReader.html#readRootIndex(org.apache.hadoop.hbase.io.hfile.HFileBlock,int)">readRootIndex</a>, <a href="HFileBlockIndex.BlockIndexReader.html#rootBlockContainingKey(byte%5B%5D,int,int)">rootBlockContainingKey</a>, <a href="HFileBlockIndex.BlockIndexReader.html#seekToDataBlock(org.apache.hadoop.hbase.ExtendedCell,org.apache.hadoop.hbase.io.hfile.HFileBlock,boolean,boolean,boolean,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)">seekToDataBlock</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="indexBlockEncoder"> |
| <h3>indexBlockEncoder</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="HFileIndexBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-485">indexBlockEncoder</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seeker"> |
| <h3>seeker</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="HFileIndexBlockEncoder.EncodedSeeker.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder.EncodedSeeker</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-487">seeker</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.CellComparator,int)"> |
| <h3>CellBasedKeyBlockIndexReaderV2</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-489">CellBasedKeyBlockIndexReaderV2</a></span><wbr><span class="parameters">(<a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> c, |
| int treeLevel)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.CellComparator,int,org.apache.hadoop.hbase.io.hfile.HFileIndexBlockEncoder)"> |
| <h3>CellBasedKeyBlockIndexReaderV2</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-493">CellBasedKeyBlockIndexReaderV2</a></span><wbr><span class="parameters">(<a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> c, |
| int treeLevel, |
| <a href="HFileIndexBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFileIndexBlockEncoder</a> indexBlockEncoder)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-501">isEmpty</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#isEmpty()">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">Returns true if the block index is empty.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#isEmpty()">isEmpty</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadDataBlockWithScanInfo(org.apache.hadoop.hbase.ExtendedCell,org.apache.hadoop.hbase.io.hfile.HFileBlock,boolean,boolean,boolean,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)"> |
| <h3>loadDataBlockWithScanInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="BlockWithScanInfo.html" title="class in org.apache.hadoop.hbase.io.hfile">BlockWithScanInfo</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-506">loadDataBlockWithScanInfo</a></span><wbr><span class="parameters">(<a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> key, |
| <a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a> currentBlock, |
| boolean cacheBlocks, |
| boolean pread, |
| boolean isCompaction, |
| <a href="../encoding/DataBlockEncoding.html" title="enum class in org.apache.hadoop.hbase.io.encoding">DataBlockEncoding</a> expectedDataBlockEncoding, |
| <a href="HFile.CachingBlockReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.CachingBlockReader</a> cachingBlockReader)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#loadDataBlockWithScanInfo(org.apache.hadoop.hbase.ExtendedCell,org.apache.hadoop.hbase.io.hfile.HFileBlock,boolean,boolean,boolean,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">Return the BlockWithScanInfo, a data structure which contains the Data HFileBlock with other |
| scan info such as the key that starts the next HFileBlock. This function will only be called |
| when the HFile version is larger than 1.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#loadDataBlockWithScanInfo(org.apache.hadoop.hbase.ExtendedCell,org.apache.hadoop.hbase.io.hfile.HFileBlock,boolean,boolean,boolean,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)">loadDataBlockWithScanInfo</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>key</code> - the key we are looking for</dd> |
| <dd><code>currentBlock</code> - the current block, to avoid re-reading the same block</dd> |
| <dd><code>expectedDataBlockEncoding</code> - the data block encoding the caller is expecting the data |
| block to be in, or null to not perform this check and return |
| the block irrespective of the encoding.</dd> |
| <dt>Returns:</dt> |
| <dd>the BlockWithScanInfo which contains the DataBlock with other scan info such as |
| nextIndexedKey.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="midkey(org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)"> |
| <h3>midkey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-515">midkey</a></span><wbr><span class="parameters">(<a href="HFile.CachingBlockReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.CachingBlockReader</a> cachingBlockReader)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#midkey(org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">An approximation to the <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a>'s mid-key. Operates on block boundaries, and does not |
| go inside blocks. In other words, returns the first key of the middle block of the file.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#midkey(org.apache.hadoop.hbase.io.hfile.HFile.CachingBlockReader)">midkey</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the first key of the middle block</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRootBlockKey(int)"> |
| <h3>getRootBlockKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-523">getRootBlockKey</a></span><wbr><span class="parameters">(int i)</span></div> |
| <div class="block">from 0 to <a href="#getRootBlockCount()"><code>- 1</code></a></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#getRootBlockKey(int)">getRootBlockKey</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRootBlockCount()"> |
| <h3>getRootBlockCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-527">getRootBlockCount</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#getRootBlockCount()">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">Returns the number of root-level blocks in this block index</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.BlockIndexReader.html#getRootBlockCount()">getRootBlockCount</a></code> in class <code><a href="HFileBlockIndex.BlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.BlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rootBlockContainingKey(org.apache.hadoop.hbase.Cell)"> |
| <h3>rootBlockContainingKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-532">rootBlockContainingKey</a></span><wbr><span class="parameters">(<a href="../../Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#rootBlockContainingKey(org.apache.hadoop.hbase.Cell)">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">Finds the root-level index block containing the given key. Key to find</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#rootBlockContainingKey(org.apache.hadoop.hbase.Cell)">rootBlockContainingKey</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="calculateHeapSizeForBlockKeys(long)"> |
| <h3>calculateHeapSizeForBlockKeys</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-537">calculateHeapSizeForBlockKeys</a></span><wbr><span class="parameters">(long heapSize)</span></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#calculateHeapSizeForBlockKeys(long)">calculateHeapSizeForBlockKeys</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readMultiLevelIndexRoot(org.apache.hadoop.hbase.io.hfile.HFileBlock,int)"> |
| <h3>readMultiLevelIndexRoot</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-547">readMultiLevelIndexRoot</a></span><wbr><span class="parameters">(<a href="HFileBlock.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a> blk, |
| int numEntries)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="HFileBlockIndex.BlockIndexReader.html#readMultiLevelIndexRoot(org.apache.hadoop.hbase.io.hfile.HFileBlock,int)">HFileBlockIndex.BlockIndexReader</a></code></span></div> |
| <div class="block">Read the root-level metadata of a multi-level block index. Based on |
| <a href="HFileBlockIndex.BlockIndexReader.html#readRootIndex(java.io.DataInput,int)"><code>HFileBlockIndex.BlockIndexReader.readRootIndex(DataInput, int)</code></a>, but also reads metadata necessary to compute the |
| mid-key in a multi-level index.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.BlockIndexReader.html#readMultiLevelIndexRoot(org.apache.hadoop.hbase.io.hfile.HFileBlock,int)">readMultiLevelIndexRoot</a></code> in class <code><a href="HFileBlockIndex.BlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.BlockIndexReader</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>blk</code> - the HFile block</dd> |
| <dd><code>numEntries</code> - the number of root-level index entries</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlockIndex.CellBasedKeyBlockIndexReaderV2.html#line-553">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html#toString()">toString</a></code> in class <code><a href="HFileBlockIndex.CellBasedKeyBlockIndexReader.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileBlockIndex.CellBasedKeyBlockIndexReader</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
