RowIndexSeekerV1 (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder.AbstractEncodedSeeker
- - org.apache.hadoop.hbase.io.encoding.RowIndexSeekerV1

All Implemented Interfaces:: DataBlockEncoder.EncodedSeeker

@InterfaceAudience.Private
public class RowIndexSeekerV1
extends AbstractDataBlockEncoder.AbstractEncodedSeeker

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class RowIndexSeekerV1.SeekerState

Nested Classes
Modifier and Type	Class and Description
`protected class`	`RowIndexSeekerV1.SeekerState`

Field Summary
- Fields inherited from class org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder.AbstractEncodedSeeker
  comparator, decodingCtx

Constructor Summary

Constructors
Constructor and Description

RowIndexSeekerV1(KeyValue.KVComparator comparator, HFileBlockDecodingContext decodingCtx)

Constructors
Constructor and Description
`RowIndexSeekerV1(KeyValue.KVComparator comparator, HFileBlockDecodingContext decodingCtx)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareKey(KeyValue.KVComparator comparator, byte[] key, int offset, int length)` Compare the given key against the current key
`int`	`compareKey(KeyValue.KVComparator comparator, Cell key)`
`protected ByteBuffer`	`createKVBuffer()`
`protected void`	`decodeAtPosition(int position)`
`protected void`	`decodeFirst()`
`protected void`	`decodeNext()`
`protected void`	`decodeTags()`
`ByteBuffer`	`getKeyDeepCopy()` Does a deep copy of the key at the current position.
`Cell`	`getKeyValue()`
`ByteBuffer`	`getValueShallowCopy()` Does a shallow copy of the value at the current position.
`boolean`	`next()` Move to next position
`void`	`rewind()` Set position to beginning of given block
`int`	`seekToKeyInBlock(byte[] key, int offset, int length, boolean seekBefore)` Moves the seeker position within the current block to: the last key that that is less than or equal to the given key if `seekBefore` is false the last key that is strictly less than the given key if `seekBefore` is true.
`int`	`seekToKeyInBlock(Cell seekCell, boolean seekBefore)` Moves the seeker position within the current block to: the last key that that is less than or equal to the given key if `seekBefore` is false the last key that is strictly less than the given key if `seekBefore` is true.
`void`	`setCurrentBuffer(ByteBuffer buffer)` Set on which buffer there will be done seeking.

Methods inherited from class org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder.AbstractEncodedSeeker
includesMvcc, includesTags

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RowIndexSeekerV1
```
public RowIndexSeekerV1(KeyValue.KVComparator comparator,
                HFileBlockDecodingContext decodingCtx)
```
- Method Detail
  - setCurrentBuffer
```
public void setCurrentBuffer(ByteBuffer buffer)
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Set on which buffer there will be done seeking.
    
    Parameters:
    buffer - Used for seeking.
  - getKeyDeepCopy
```
public ByteBuffer getKeyDeepCopy()
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Does a deep copy of the key at the current position. A deep copy is necessary because buffers are reused in the decoder.
    
    Returns:
    key at current position
  - getValueShallowCopy
```
public ByteBuffer getValueShallowCopy()
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    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.
    
    Returns:
    value at current position
  - createKVBuffer
```
protected ByteBuffer createKVBuffer()
```
  - getKeyValue
```
public Cell getKeyValue()
```
    Returns:
    the KeyValue object at the current position. Includes memstore timestamp.
  - rewind
```
public void rewind()
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Set position to beginning of given block
  - next
```
public boolean next()
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Move to next position
    
    Returns:
    true on success, false if there is no more positions.
  - seekToKeyInBlock
```
public int seekToKeyInBlock(byte[] key,
                   int offset,
                   int length,
                   boolean seekBefore)
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    Moves the seeker position within the current block to:
    - the last key that that is less than or equal to the given key if seekBefore is false
    - the last key that is strictly less than the given key if seekBefore 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.
    Parameters:
    key - byte array containing the key
    offset - key position the array
    length - key length in bytes
    seekBefore - find the key strictly less than the given key in case of an exact match. Does not matter in case of an inexact match.
    
    Returns:
    0 on exact match, 1 on inexact match.
  - seekToKeyInBlock
```
public int seekToKeyInBlock(Cell seekCell,
                   boolean seekBefore)
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    Moves the seeker position within the current block to:
    - the last key that that is less than or equal to the given key if seekBefore is false
    - the last key that is strictly less than the given key if seekBefore 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.
    Parameters:
    seekCell - - Cell to which the seek should happen
    seekBefore - find the key strictly less than the given key in case of an exact match. Does not matter in case of an inexact match.
    
    Returns:
    0 on exact match, 1 on inexact match.
  - compareKey
```
public int compareKey(KeyValue.KVComparator comparator,
             byte[] key,
             int offset,
             int length)
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Compare the given key against the current key
    
    Returns:
    -1 is the passed key is smaller than the current key, 0 if equal and 1 if greater
  - compareKey
```
public int compareKey(KeyValue.KVComparator comparator,
             Cell key)
```
  - decodeFirst
```
protected void decodeFirst()
```
  - decodeAtPosition
```
protected void decodeAtPosition(int position)
```
  - decodeNext
```
protected void decodeNext()
```
  - decodeTags
```
protected void decodeTags()
```

Class RowIndexSeekerV1

Nested Class Summary

Field Summary

Fields inherited from class org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder.AbstractEncodedSeeker

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder.AbstractEncodedSeeker

Methods inherited from class java.lang.Object

Constructor Detail

RowIndexSeekerV1

Method Detail

setCurrentBuffer

getKeyDeepCopy

getValueShallowCopy

createKVBuffer

getKeyValue

rewind

next

seekToKeyInBlock

seekToKeyInBlock

compareKey

compareKey

decodeFirst

decodeAtPosition

decodeNext

decodeTags