Field Detail

• block

  protected HFileBlock block

• nextIndexedKey

  protected Cell nextIndexedKey

  The next indexed key is to keep track of the indexed key of the next data block. If the nextIndexedKey is HConstants.NO_NEXT_INDEXED_KEY, it means that the current data block is the last data block. If the nextIndexedKey is null, it means the nextIndexedKey has not been loaded yet.

Constructor Detail

• HFileReaderV2.AbstractScannerV2

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

Method Detail

• getNextIndexedKey

  public Cell getNextIndexedKey()

  Returns:

  the next key in the index (the key to seek to the next block)

• getFirstKeyInBlock

  protected abstract ByteBuffer getFirstKeyInBlock(HFileBlock curBlock)

• loadBlockAndSeekToKey

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

  Throws:

  IOException

• seekTo

  public int seekTo(byte[] key,
           int offset,
           int length)
             throws IOException

  Throws:

  IOException

• reseekTo

  public int reseekTo(byte[] key,
             int offset,
             int length)
               throws IOException

  Throws:

  IOException

• seekTo

  public int seekTo(Cell key)
             throws IOException

  Throws:

  IOException

• reseekTo

  public int reseekTo(Cell key)
               throws IOException

  Throws:

  IOException

• seekTo

  public int seekTo(Cell key,
           boolean rewind)
             throws IOException

  An internal API function. Seek to the given key, optionally rewinding to the first key of the block before doing the seek.

  Parameters:

  key - - a cell representing the key that we need to fetch

  rewind - whether to rewind to the first key of the block before doing the seek. If this is false, we are assuming we never go back, otherwise the result is undefined.

  Returns:

  -1 if the key is earlier than the first key of the file, 0 if we are at the given key, 1 if we are past the given key -2 if the key is earlier than the first key of the file while using a faked index key

  Throws:

  IOException

• seekBefore

  public boolean seekBefore(byte[] key,
                   int offset,
                   int length)
                     throws IOException

  Throws:

  IOException

• seekBefore

  public boolean seekBefore(Cell key)
                     throws IOException

  Throws:

  IOException

• readNextDataBlock

  protected HFileBlock readNextDataBlock()
                                  throws IOException

  Scans blocks in the "scanned" section of the HFile until the next data block is found.

  Returns:

  the next block, or null if there are no more data blocks

  Throws:

  IOException

• getEffectiveDataBlockEncoding

  public DataBlockEncoding getEffectiveDataBlockEncoding()

• compareKey

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

  Compare the given key against the current key

  Parameters:

  comparator -

  key -

  offset -

  length -

  Returns:

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

• compareKey

  public abstract int compareKey(KeyValue.KVComparator comparator,
               Cell kv)