| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>DataBlockEncoder.EncodedSeeker (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DataBlockEncoder.EncodedSeeker (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/DataBlockEncoder.EncodedSeeker.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/hadoop/hbase/io/encoding/DataBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.encoding"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoding.html" title="enum in org.apache.hadoop.hbase.io.encoding"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html" target="_top">Frames</a></li> |
| <li><a href="DataBlockEncoder.EncodedSeeker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.io.encoding</div> |
| <h2 title="Interface DataBlockEncoder.EncodedSeeker" class="title">Interface DataBlockEncoder.EncodedSeeker</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/AbstractDataBlockEncoder.AbstractEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">AbstractDataBlockEncoder.AbstractEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/BufferedDataBlockEncoder.BufferedEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.BufferedEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/CopyKeyDataBlockEncoder.SeekerStateBufferedEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">CopyKeyDataBlockEncoder.SeekerStateBufferedEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DiffKeyDeltaEncoder.DiffSeekerStateBufferedEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">DiffKeyDeltaEncoder.DiffSeekerStateBufferedEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/FastDiffDeltaEncoder.FastDiffSeekerStateBufferedEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">FastDiffDeltaEncoder.FastDiffSeekerStateBufferedEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/PrefixKeyDeltaEncoder.SeekerStateBufferedEncodedSeeker.html" title="class in org.apache.hadoop.hbase.io.encoding">PrefixKeyDeltaEncoder.SeekerStateBufferedEncodedSeeker</a>, <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/RowIndexSeekerV1.html" title="class in org.apache.hadoop.hbase.io.encoding">RowIndexSeekerV1</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.encoding">DataBlockEncoder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.html#line.122">DataBlockEncoder.EncodedSeeker</a></pre> |
| <div class="block">An interface which enable to seek while underlying data is encoded. |
| |
| It works on one HFileBlock, but it is reusable. See |
| <a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#setCurrentBuffer-org.apache.hadoop.hbase.nio.ByteBuff-"><code>setCurrentBuffer(ByteBuff)</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></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>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#compareKey-org.apache.hadoop.hbase.CellComparator-org.apache.hadoop.hbase.Cell-">compareKey</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator, |
| <a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key)</code> |
| <div class="block">Compare the given key against the current key</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#getCell--">getCell</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#getKey--">getKey</a></span>()</code> |
| <div class="block">From the current position creates a cell using the key part |
| of the current buffer</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#getValueShallowCopy--">getValueShallowCopy</a></span>()</code> |
| <div class="block">Does a shallow copy of the value at the current position.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#next--">next</a></span>()</code> |
| <div class="block">Move to next position</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#rewind--">rewind</a></span>()</code> |
| <div class="block">Set position to beginning of given block</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#seekToKeyInBlock-org.apache.hadoop.hbase.Cell-boolean-">seekToKeyInBlock</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key, |
| boolean seekBefore)</code> |
| <div class="block">Moves the seeker position within the current block to: |
| |
| the last key that that is less than or equal to the given key if |
| <code>seekBefore</code> is false |
| the last key that is strictly less than the given key if <code> |
| seekBefore</code> is true.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#setCurrentBuffer-org.apache.hadoop.hbase.nio.ByteBuff-">setCurrentBuffer</a></span>(<a href="../../../../../../org/apache/hadoop/hbase/nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> buffer)</code> |
| <div class="block">Set on which buffer there will be done seeking.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setCurrentBuffer-org.apache.hadoop.hbase.nio.ByteBuff-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentBuffer</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.127">setCurrentBuffer</a>(<a href="../../../../../../org/apache/hadoop/hbase/nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a> buffer)</pre> |
| <div class="block">Set on which buffer there will be done seeking.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>buffer</code> - Used for seeking.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKey</h4> |
| <pre><a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.134">getKey</a>()</pre> |
| <div class="block">From the current position creates a cell using the key part |
| of the current buffer</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>key at current position</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValueShallowCopy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueShallowCopy</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.142">getValueShallowCopy</a>()</pre> |
| <div class="block">Does a shallow copy of the value at the current position. A shallow |
| copy is possible because the returned buffer refers to the backing array |
| of the original encoded buffer.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>value at current position</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCell--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCell</h4> |
| <pre><a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.147">getCell</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Cell at the current position. Includes memstore timestamp.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="rewind--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>rewind</h4> |
| <pre>void <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.150">rewind</a>()</pre> |
| <div class="block">Set position to beginning of given block</div> |
| </li> |
| </ul> |
| <a name="next--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>next</h4> |
| <pre>boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.156">next</a>()</pre> |
| <div class="block">Move to next position</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true on success, false if there is no more positions.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="seekToKeyInBlock-org.apache.hadoop.hbase.Cell-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>seekToKeyInBlock</h4> |
| <pre>int <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.173">seekToKeyInBlock</a>(<a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key, |
| boolean seekBefore)</pre> |
| <div class="block">Moves the seeker position within the current block to: |
| <ul> |
| <li>the last key that that is less than or equal to the given key if |
| <code>seekBefore</code> is false</li> |
| <li>the last key that is strictly less than the given key if <code> |
| seekBefore</code> is true. The caller is responsible for loading the |
| previous block if the requested key turns out to be the first key of the |
| current block.</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - - Cell to which the seek should happen</dd> |
| <dd><code>seekBefore</code> - find the key strictly less than the given key in case |
| of an exact match. Does not matter in case of an inexact match.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>0 on exact match, 1 on inexact match.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compareKey-org.apache.hadoop.hbase.CellComparator-org.apache.hadoop.hbase.Cell-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>compareKey</h4> |
| <pre>int <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html#line.179">compareKey</a>(<a href="../../../../../../org/apache/hadoop/hbase/CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator, |
| <a href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> key)</pre> |
| <div class="block">Compare the given key against the current key</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>-1 is the passed key is smaller than the current key, 0 if equal and 1 if greater</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/DataBlockEncoder.EncodedSeeker.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/hadoop/hbase/io/encoding/DataBlockEncoder.html" title="interface in org.apache.hadoop.hbase.io.encoding"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/hadoop/hbase/io/encoding/DataBlockEncoding.html" title="enum in org.apache.hadoop.hbase.io.encoding"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/hadoop/hbase/io/encoding/DataBlockEncoder.EncodedSeeker.html" target="_top">Frames</a></li> |
| <li><a href="DataBlockEncoder.EncodedSeeker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
