org.apache.hudi.io.hfile

Class HFileDataBlock

java.lang.Object

org.apache.hudi.io.hfile.HFileBlock

org.apache.hudi.io.hfile.HFileDataBlock

public class HFileDataBlock
extends HFileBlock

Represents a HFileBlockType.DATA block.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	uncompressedContentEndRelativeOffset

Fields inherited from class org.apache.hudi.io.hfile.HFileBlock

byteBuff, bytesPerChecksum, compressedByteBuff, context, HFILEBLOCK_HEADER_SIZE, HFILEBLOCK_HEADER_SIZE_NO_CHECKSUM, onDiskSizeWithoutHeader, sizeCheckSum, startOffsetInBuff, startOffsetInCompressedBuff, uncompressedEndOffset, uncompressedSizeWithoutHeader

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HFileDataBlock(HFileContext context, byte[] byteBuff, int startOffsetInBuff)

Method Summary

Modifier and Type	Method and Description
boolean	next(HFileCursor cursor, int blockStartOffsetInFile) Moves the cursor to next KeyValue.
KeyValue	readKeyValue(int offset) Reads the key value at the offset.
int	seekTo(HFileCursor cursor, Key key, int blockStartOffsetInFile) Seeks to the key to look up.

Methods inherited from class org.apache.hudi.io.hfile.HFileBlock

allocateBufferForUnpacking, getBlockType, getByteBuff, getOnDiskSizeWithHeader, parse, unpack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uncompressedContentEndRelativeOffset

protected final int uncompressedContentEndRelativeOffset

Constructor Detail

HFileDataBlock

protected HFileDataBlock(HFileContext context,
                         byte[] byteBuff,
                         int startOffsetInBuff)

Method Detail

seekTo

public int seekTo(HFileCursor cursor,
                  Key key,
                  int blockStartOffsetInFile)

Seeks to the key to look up. The key may not have an exact match.

Parameters:

cursor - HFileCursor containing the current position relative to the beginning of the HFile (not the block start offset).

key - key to look up.

blockStartOffsetInFile - the start offset of the block relative to the beginning of the HFile.

Returns:

0 if the block contains the exact same key as the lookup key, and the cursor points to the key; or 1 if the lookup key does not exist, and the cursor points to the lexicographically largest key that is smaller than the lookup key.

readKeyValue

public KeyValue readKeyValue(int offset)

Reads the key value at the offset.

Parameters:

offset - offset to read relative to the start of byteBuff.

Returns:

the KeyValue instance.

next

public boolean next(HFileCursor cursor,
                    int blockStartOffsetInFile)

Moves the cursor to next KeyValue.

Parameters:

cursor - HFileCursor instance containing the current position.

blockStartOffsetInFile - the start offset of the block relative to the beginning of the HFile.

Returns:

true if there is next KeyValue; {code false} otherwise.