blob: cdf8bb11d12ad5bbed0543e034f2a4c49ce5e4d8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ReversedKeyValueHeap (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.regionserver, class: ReversedKeyValueHeap">
<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/ReversedKeyValueHeap.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<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>
<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>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.regionserver</a></div>
<h1 title="Class ReversedKeyValueHeap" class="title">Class ReversedKeyValueHeap</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="NonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner</a>
<div class="inheritance"><a href="NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner</a>
<div class="inheritance"><a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver.KeyValueHeap</a>
<div class="inheritance">org.apache.hadoop.hbase.regionserver.ReversedKeyValueHeap</div>
</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="InternalScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">InternalScanner</a></code>, <code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code>, <code><a href="Shipper.html" title="interface in org.apache.hadoop.hbase.regionserver">Shipper</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Private
</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-36">ReversedKeyValueHeap</a></span>
<span class="extends-implements">extends <a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></span></div>
<div class="block">ReversedKeyValueHeap is used for supporting reversed scanning. Compared with KeyValueHeap, its
scanner comparator is a little different (see ReversedKVScannerComparator), all seek is backward
seek(see <a href="KeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueScanner.backwardSeek(org.apache.hadoop.hbase.ExtendedCell)</code></a>), and it will jump to the previous row if it is
already at the end of one row when calling next().</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</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">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="ReversedKeyValueHeap.ReversedKVScannerComparator.html" class="type-name-link" title="class in org.apache.hadoop.hbase.regionserver">ReversedKeyValueHeap.ReversedKVScannerComparator</a></code></div>
<div class="col-last even-row-color">
<div class="block">In ReversedKVScannerComparator, we compare the row of scanners' peek values first, sort bigger
one before the smaller one.</div>
</div>
</div>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueHeap">Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.hbase.regionserver.<a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></h2>
<code><a href="KeyValueHeap.KVScannerComparator.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap.KVScannerComparator</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueHeap">Fields inherited from class&nbsp;org.apache.hadoop.hbase.regionserver.<a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></h3>
<code><a href="KeyValueHeap.html#comparator">comparator</a>, <a href="KeyValueHeap.html#current">current</a>, <a href="KeyValueHeap.html#heap">heap</a>, <a href="KeyValueHeap.html#scannersForDelayedClose">scannersForDelayedClose</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueScanner">Fields inherited from interface&nbsp;org.apache.hadoop.hbase.regionserver.<a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></h3>
<code><a href="KeyValueScanner.html#NO_NEXT_INDEXED_KEY">NO_NEXT_INDEXED_KEY</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(java.util.List,org.apache.hadoop.hbase.CellComparator)" class="member-name-link">ReversedKeyValueHeap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;? extends <a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a>&gt;&nbsp;scanners,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</code></div>
<div class="col-last even-row-color">&nbsp;</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>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">backwardSeek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Seek the scanner at or before the row of specified Cell, it firstly tries to seek the scanner
at or after the specified Cell, return if peek KeyValue of scanner has the same row with
specified Cell, otherwise seek the scanner at the first Cell of the row which is the previous
row of specified KeyValue</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="#next()" class="member-name-link">next</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the next Cell in this scanner, iterating the scanner</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)" class="member-name-link">requestSeek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;key,
boolean&nbsp;forward,
boolean&nbsp;useBloom)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Similar to <a href="KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueScanner.seek(org.apache.hadoop.hbase.ExtendedCell)</code></a> (or <a href="KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueScanner.reseek(org.apache.hadoop.hbase.ExtendedCell)</code></a> if forward is true) but only does a seek operation
after checking that it is really necessary for the row/column combination specified by the kv
parameter.</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="#reseek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">reseek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This function is identical to the <a href="KeyValueHeap.html#seek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueHeap.seek(ExtendedCell)</code></a> function except that
scanner.seek(seekKey) is changed to scanner.reseek(seekKey).</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Seeks all scanners at or below the specified seek key.</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="#seekToLastRow()" class="member-name-link">seekToLastRow</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Seek the scanner at the first KeyValue of last row</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seekToPreviousRow</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Seek the scanner at the first Cell of the row which is the previous row of specified key</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueHeap">Methods inherited from class&nbsp;org.apache.hadoop.hbase.regionserver.<a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></h3>
<code><a href="KeyValueHeap.html#close()">close</a>, <a href="KeyValueHeap.html#getCurrentForTesting()">getCurrentForTesting</a>, <a href="KeyValueHeap.html#getHeap()">getHeap</a>, <a href="KeyValueHeap.html#getNextIndexedKey()">getNextIndexedKey</a>, <a href="KeyValueHeap.html#isLatestCellFromMemstore()">isLatestCellFromMemstore</a>, <a href="KeyValueHeap.html#next(java.util.List,org.apache.hadoop.hbase.regionserver.ScannerContext)">next</a>, <a href="KeyValueHeap.html#peek()">peek</a>, <a href="KeyValueHeap.html#pollRealKV()">pollRealKV</a>, <a href="KeyValueHeap.html#recordBlockSize(java.util.function.IntConsumer)">recordBlockSize</a>, <a href="KeyValueHeap.html#shipped()">shipped</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner">Methods inherited from class&nbsp;org.apache.hadoop.hbase.regionserver.<a href="NonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonLazyKeyValueScanner</a></h3>
<code><a href="NonLazyKeyValueScanner.html#doRealSeek(org.apache.hadoop.hbase.regionserver.KeyValueScanner,org.apache.hadoop.hbase.ExtendedCell,boolean)">doRealSeek</a>, <a href="NonLazyKeyValueScanner.html#enforceSeek()">enforceSeek</a>, <a href="NonLazyKeyValueScanner.html#getFilePath()">getFilePath</a>, <a href="NonLazyKeyValueScanner.html#isFileScanner()">isFileScanner</a>, <a href="NonLazyKeyValueScanner.html#realSeekDone()">realSeekDone</a>, <a href="NonLazyKeyValueScanner.html#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)">shouldUseScanner</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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#toString()" title="class or interface in java.lang" class="external-link">toString</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>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.InternalScanner">Methods inherited from interface&nbsp;org.apache.hadoop.hbase.regionserver.<a href="InternalScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">InternalScanner</a></h3>
<code><a href="InternalScanner.html#next(java.util.List)">next</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueScanner">Methods inherited from interface&nbsp;org.apache.hadoop.hbase.regionserver.<a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></h3>
<code><a href="KeyValueScanner.html#enforceSeek()">enforceSeek</a>, <a href="KeyValueScanner.html#getFilePath()">getFilePath</a>, <a href="KeyValueScanner.html#getScannerOrder()">getScannerOrder</a>, <a href="KeyValueScanner.html#isFileScanner()">isFileScanner</a>, <a href="KeyValueScanner.html#realSeekDone()">realSeekDone</a>, <a href="KeyValueScanner.html#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)">shouldUseScanner</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(java.util.List,org.apache.hadoop.hbase.CellComparator)">
<h3>ReversedKeyValueHeap</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-41">ReversedKeyValueHeap</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;? extends <a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a>&gt;&nbsp;scanners,
<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>&nbsp;comparator)</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>
<dl class="notes">
<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>
</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="seek(org.apache.hadoop.hbase.ExtendedCell)">
<h3>seek</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-46">seek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</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:&nbsp;<code><a href="KeyValueHeap.html#seek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueHeap</a></code></span></div>
<div class="block">Seeks all scanners at or below the specified seek key. If we earlied-out of a row, we may end
up skipping values that were never reached yet. Rather than iterating down, we want to give the
opportunity to re-seek.
<p>
As individual scanners may run past their ends, those scanners are automatically closed and
removed from the heap.
<p>
This function (and <a href="KeyValueHeap.html#reseek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueHeap.reseek(ExtendedCell)</code></a>) does not do multi-column Bloom filter and
lazy-seek optimizations. To enable those, call
<a href="KeyValueHeap.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)"><code>KeyValueHeap.requestSeek(ExtendedCell, boolean, boolean)</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)">seek</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="KeyValueHeap.html#seek(org.apache.hadoop.hbase.ExtendedCell)">seek</a></code>&nbsp;in class&nbsp;<code><a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></code></dd>
<dt>Parameters:</dt>
<dd><code>seekKey</code> - KeyValue to seek at or after</dd>
<dt>Returns:</dt>
<dd>true if KeyValues exist at or after specified key, false if not</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="reseek(org.apache.hadoop.hbase.ExtendedCell)">
<h3>reseek</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-51">reseek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</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:&nbsp;<code><a href="KeyValueHeap.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueHeap</a></code></span></div>
<div class="block">This function is identical to the <a href="KeyValueHeap.html#seek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueHeap.seek(ExtendedCell)</code></a> function except that
scanner.seek(seekKey) is changed to scanner.reseek(seekKey).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">reseek</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="KeyValueHeap.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">reseek</a></code>&nbsp;in class&nbsp;<code><a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></code></dd>
<dt>Parameters:</dt>
<dd><code>seekKey</code> - seek value (should be non-null)</dd>
<dt>Returns:</dt>
<dd>true if scanner has values left, false if end of scanner</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="requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">
<h3>requestSeek</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-56">requestSeek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;key,
boolean&nbsp;forward,
boolean&nbsp;useBloom)</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:&nbsp;<code><a href="KeyValueHeap.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">KeyValueHeap</a></code></span></div>
<div class="block">Similar to <a href="KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueScanner.seek(org.apache.hadoop.hbase.ExtendedCell)</code></a> (or <a href="KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)"><code>KeyValueScanner.reseek(org.apache.hadoop.hbase.ExtendedCell)</code></a> if forward is true) but only does a seek operation
after checking that it is really necessary for the row/column combination specified by the kv
parameter. This function was added to avoid unnecessary disk seeks by checking row-column Bloom
filters before a seek on multi-column get/scan queries, and to optimize by looking up more
recent files first.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">requestSeek</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="KeyValueHeap.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">requestSeek</a></code>&nbsp;in class&nbsp;<code><a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></code></dd>
<dd><code>forward</code> - do a forward-only "reseek" instead of a random-access seek</dd>
<dd><code>useBloom</code> - whether to enable multi-column Bloom filter optimization</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="seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">
<h3>seekToPreviousRow</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-62">seekToPreviousRow</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</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 interface:&nbsp;<code><a href="KeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div>
<div class="block">Seek the scanner at the first Cell of the row which is the previous row of specified key</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">seekToPreviousRow</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="NonReversedNonLazyKeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">seekToPreviousRow</a></code>&nbsp;in class&nbsp;<code><a href="NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonReversedNonLazyKeyValueScanner</a></code></dd>
<dt>Parameters:</dt>
<dd><code>seekKey</code> - seek value</dd>
<dt>Returns:</dt>
<dd>true if the scanner at the first valid Cell of previous row, false if not existing such
Cell</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="backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">
<h3>backwardSeek</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-91">backwardSeek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>&nbsp;seekKey)</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 interface:&nbsp;<code><a href="KeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div>
<div class="block">Seek the scanner at or before the row of specified Cell, it firstly tries to seek the scanner
at or after the specified Cell, return if peek KeyValue of scanner has the same row with
specified Cell, otherwise seek the scanner at the first Cell of the row which is the previous
row of specified KeyValue</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">backwardSeek</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="NonReversedNonLazyKeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">backwardSeek</a></code>&nbsp;in class&nbsp;<code><a href="NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonReversedNonLazyKeyValueScanner</a></code></dd>
<dt>Parameters:</dt>
<dd><code>seekKey</code> - seek KeyValue</dd>
<dt>Returns:</dt>
<dd>true if the scanner is at the valid KeyValue, false if such KeyValue does not exist</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="next()">
<h3>next</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-120">next</a></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 interface:&nbsp;<code><a href="KeyValueScanner.html#next()">KeyValueScanner</a></code></span></div>
<div class="block">Return the next Cell in this scanner, iterating the scanner</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#next()">next</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="KeyValueHeap.html#next()">next</a></code>&nbsp;in class&nbsp;<code><a href="KeyValueHeap.html" title="class in org.apache.hadoop.hbase.regionserver">KeyValueHeap</a></code></dd>
<dt>Returns:</dt>
<dd>the next Cell</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="seekToLastRow()">
<h3>seekToLastRow</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ReversedKeyValueHeap.html#line-178">seekToLastRow</a></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 interface:&nbsp;<code><a href="KeyValueScanner.html#seekToLastRow()">KeyValueScanner</a></code></span></div>
<div class="block">Seek the scanner at the first KeyValue of last row</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="KeyValueScanner.html#seekToLastRow()">seekToLastRow</a></code>&nbsp;in interface&nbsp;<code><a href="KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="NonReversedNonLazyKeyValueScanner.html#seekToLastRow()">seekToLastRow</a></code>&nbsp;in class&nbsp;<code><a href="NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonReversedNonLazyKeyValueScanner</a></code></dd>
<dt>Returns:</dt>
<dd>true if scanner has values left, false if the underlying data is empty</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>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>