BufferedDataBlockEncoder.BufferedEncodedSeeker (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.BufferedDataBlockEncoder.BufferedEncodedSeeker<STATE>

All Implemented Interfaces:: DataBlockEncoder.EncodedSeeker

Enclosing class:: BufferedDataBlockEncoder

protected abstract static class BufferedDataBlockEncoder.BufferedEncodedSeeker<STATE extends BufferedDataBlockEncoder.SeekerState>
extends Object
implements DataBlockEncoder.EncodedSeeker

Field Summary

Fields
Modifier and Type	Field and Description
`protected KeyValue.KVComparator`	`comparator`
`protected STATE`	`current`
`protected ByteBuffer`	`currentBuffer`
`protected HFileBlockDecodingContext`	`decodingCtx`
`protected STATE`	`previous`
`protected KeyValue.SamePrefixComparator<byte[]>`	`samePrefixComparator`
`protected TagCompressionContext`	`tagCompressionContext`

Constructor Summary

Constructors
Constructor and Description
`BufferedDataBlockEncoder.BufferedEncodedSeeker(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)`
`private int`	`compareTypeBytes(Cell key, Cell right)`
`protected STATE`	`createSeekerState()`
`protected abstract void`	`decodeFirst()`
`protected abstract 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.
`protected boolean`	`includesMvcc()`
`protected boolean`	`includesTags()`
`private void`	`moveToPrevious()`
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - decodingCtx
```
protected HFileBlockDecodingContext decodingCtx
```
  - comparator
```
protected final KeyValue.KVComparator comparator
```
  - samePrefixComparator
```
protected final KeyValue.SamePrefixComparator<byte[]> samePrefixComparator
```
  - currentBuffer
```
protected ByteBuffer currentBuffer
```
  - current
```
protected STATE extends BufferedDataBlockEncoder.SeekerState current
```
  - previous
```
protected STATE extends BufferedDataBlockEncoder.SeekerState previous
```
  - tagCompressionContext
```
protected TagCompressionContext tagCompressionContext
```
- Constructor Detail
  - BufferedDataBlockEncoder.BufferedEncodedSeeker
```
public BufferedDataBlockEncoder.BufferedEncodedSeeker(KeyValue.KVComparator comparator,
                                              HFileBlockDecodingContext decodingCtx)
```
- Method Detail
  - includesMvcc
```
protected boolean includesMvcc()
```
  - includesTags
```
protected boolean includesTags()
```
  - 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
    
    Specified by:
    
    compareKey in interface DataBlockEncoder.EncodedSeeker
    
    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)
```
    Specified by:
    
    compareKey in interface DataBlockEncoder.EncodedSeeker
  - setCurrentBuffer
```
public void setCurrentBuffer(ByteBuffer buffer)
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Set on which buffer there will be done seeking.
    
    Specified by:
    
    setCurrentBuffer in interface DataBlockEncoder.EncodedSeeker
    
    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.
    
    Specified by:
    
    getKeyDeepCopy in interface DataBlockEncoder.EncodedSeeker
    
    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.
    
    Specified by:
    
    getValueShallowCopy in interface DataBlockEncoder.EncodedSeeker
    
    Returns:
    value at current position
  - getKeyValue
```
public Cell getKeyValue()
```
    Specified by:
    
    getKeyValue in interface DataBlockEncoder.EncodedSeeker
    
    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
    
    Specified by:
    
    rewind in interface DataBlockEncoder.EncodedSeeker
  - next
```
public boolean next()
```
    Description copied from interface: DataBlockEncoder.EncodedSeeker
    
    Move to next position
    
    Specified by:
    
    next in interface DataBlockEncoder.EncodedSeeker
    
    Returns:
    true on success, false if there is no more positions.
  - decodeTags
```
protected void decodeTags()
```
  - 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.
    Specified by:
    
    seekToKeyInBlock in interface DataBlockEncoder.EncodedSeeker
    
    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.
    Specified by:
    
    seekToKeyInBlock in interface DataBlockEncoder.EncodedSeeker
    
    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.
  - compareTypeBytes
```
private int compareTypeBytes(Cell key,
                   Cell right)
```
  - moveToPrevious
```
private void moveToPrevious()
```
  - createSeekerState
```
protected STATE createSeekerState()
```
  - decodeFirst
```
protected abstract void decodeFirst()
```
  - decodeNext
```
protected abstract void decodeNext()
```

Class BufferedDataBlockEncoder.BufferedEncodedSeeker<STATE extends BufferedDataBlockEncoder.SeekerState>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

decodingCtx

comparator

samePrefixComparator

currentBuffer

current

previous

tagCompressionContext

Constructor Detail

BufferedDataBlockEncoder.BufferedEncodedSeeker

Method Detail

includesMvcc

includesTags

compareKey

compareKey

setCurrentBuffer

getKeyDeepCopy

getValueShallowCopy

getKeyValue

rewind

next

decodeTags

seekToKeyInBlock

seekToKeyInBlock

compareTypeBytes

moveToPrevious

createSeekerState

decodeFirst

decodeNext