Constructor Detail

• HFileReaderV2.ScannerV2

  public HFileReaderV2.ScannerV2(HFileReaderV2 r,
                         boolean cacheBlocks,
                         boolean pread,
                         boolean isCompaction)

Method Detail

• getKeyValue

  public Cell getKeyValue()

  Returns:

  Instance of KeyValue.

• formNoTagsKeyValue

  protected Cell formNoTagsKeyValue()

• getCellBufSize

  protected int getCellBufSize()

• getKey

  public ByteBuffer getKey()

  Description copied from interface: HFileScanner
  Gets a buffer view to the current key. You must call HFileScanner.seekTo(byte[]) before this method.

  Returns:

  byte buffer for the key. The limit is set to the key size, and the position is 0, the start of the buffer view.

• compareKey

  public int compareKey(KeyValue.KVComparator comparator,
               byte[] key,
               int offset,
               int length)

  Description copied from class: HFileReaderV2.AbstractScannerV2
  Compare the given key against the current key

  Specified by:

  compareKey in class HFileReaderV2.AbstractScannerV2

  Returns:

  -1 is the passed key is smaller than the current key, 0 if equal and 1 if greater

• getValue

  public ByteBuffer getValue()

  Description copied from interface: HFileScanner
  Gets a buffer view to the current value. You must call HFileScanner.seekTo(byte[]) before this method.

  Returns:

  byte buffer for the value. The limit is set to the value size, and the position is 0, the start of the buffer view.

• setNonSeekedState

  protected void setNonSeekedState()

• next

  public boolean next()
               throws IOException

  Go to the next key/value in the block section. Loads the next block if necessary. If successful, getKey() and getValue() can be called.

  Returns:

  true if successfully navigated to the next key/value

  Throws:

  IOException

• getNextCellStartPosition

  protected int getNextCellStartPosition()

• seekTo

  public boolean seekTo()
                 throws IOException

  Positions this scanner at the start of the file.

  Returns:

  false if empty file; i.e. a call to next would return false and the current key and value are undefined.

  Throws:

  IOException

• loadBlockAndSeekToKey

  protected int loadBlockAndSeekToKey(HFileBlock seekToBlock,
                          Cell nextIndexedKey,
                          boolean rewind,
                          Cell key,
                          boolean seekBefore)
                               throws IOException

  Specified by:

  loadBlockAndSeekToKey in class HFileReaderV2.AbstractScannerV2

  Throws:

  IOException

• updateCurrBlock

  protected void updateCurrBlock(HFileBlock newBlock)

  Updates the current block to be the given HFileBlock. Seeks to the the first key/value pair.

  Parameters:

  newBlock - the block to make current

• checkKeyLen

  protected final boolean checkKeyLen(int v)

  Parameters:

  v -

  Returns:

  True if v <= 0 or v > current block buffer limit.

• checkLen

  protected final boolean checkLen(int v)

  Parameters:

  v -

  Returns:

  True if v < 0 or v > current block buffer limit.

• checkKeyValueLen

  protected final void checkKeyValueLen()

  Check key and value lengths are wholesome.

• readKeyValueLen

  protected void readKeyValueLen()

• readMvccVersion

  protected void readMvccVersion(int position)

  Read mvcc. Does checks to see if we even need to read the mvcc at all.

  Parameters:

  position -

• readMvccVersion

  protected void readMvccVersion()

• blockSeek

  protected int blockSeek(Cell key,
              boolean seekBefore)

  Within a loaded block, seek looking for the last key that is smaller than (or equal to?) the key we are interested in. A note on the seekBefore: if you have seekBefore = true, AND the first key in the block = key, then you'll get thrown exceptions. The caller has to check for that case and load the previous block as appropriate.

  Parameters:

  key - the key to find

  seekBefore - find the key before the given key in case of exact match.

  Returns:

  0 in case of an exact key match, 1 in case of an inexact match, -2 in case of an inexact match and furthermore, the input key less than the first key of current block(e.g. using a faked index key)

• getFirstKeyInBlock

  protected ByteBuffer getFirstKeyInBlock(HFileBlock curBlock)

  Specified by:

  getFirstKeyInBlock in class HFileReaderV2.AbstractScannerV2

• getKeyString

  public String getKeyString()

  Description copied from interface: HFileScanner
  Convenience method to get a copy of the key as a string - interpreting the bytes as UTF8. You must call HFileScanner.seekTo(byte[]) before this method.

  Returns:

  key as a string

• getValueString

  public String getValueString()

  Description copied from interface: HFileScanner
  Convenience method to get a copy of the value as a string - interpreting the bytes as UTF8. You must call HFileScanner.seekTo(byte[]) before this method.

  Returns:

  value as a string

• compareKey

  public int compareKey(KeyValue.KVComparator comparator,
               Cell key)

  Specified by:

  compareKey in class HFileReaderV2.AbstractScannerV2