org.apache.hadoop.hbase.io.encoding

Class RowIndexCodecV1

java.lang.Object

org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder

org.apache.hadoop.hbase.io.encoding.RowIndexCodecV1

All Implemented Interfaces:

DataBlockEncoder

@InterfaceAudience.Private
public class RowIndexCodecV1
extends AbstractDataBlockEncoder

Store cells following every row's start offset, so we can binary search to a row's cells. Format: flat cells integer: number of rows integer: row0's offset integer: row1's offset .... integer: dataSize

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.io.encoding.AbstractDataBlockEncoder

AbstractDataBlockEncoder.AbstractEncodedSeeker

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.io.encoding.DataBlockEncoder

DataBlockEncoder.EncodedSeeker

Constructor Summary

Constructors

Constructor and Description
RowIndexCodecV1()

Method Summary

Modifier and Type	Method and Description
DataBlockEncoder.EncodedSeeker	createSeeker(CellComparator comparator, HFileBlockDecodingContext decodingCtx) Create a HFileBlock seeker which find KeyValues within a block.
ByteBuffer	decodeKeyValues(DataInputStream source, HFileBlockDecodingContext decodingCtx) Decode.
int	encode(Cell cell, HFileBlockEncodingContext encodingCtx, DataOutputStream out) Encodes a KeyValue.
void	endBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out, byte[] uncompressedBytesWithHeader) Ends encoding for a block of KeyValues.
Cell	getFirstKeyCellInBlock(ByteBuff block) Return first key in block as a cell.
void	startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx, DataOutputStream out) Starts encoding for a block of KeyValues.

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

createFirstKeyCell, newDataBlockDecodingContext, newDataBlockEncodingContext, postEncoding

Methods inherited from class java.lang.Object

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

Constructor Detail

RowIndexCodecV1

public RowIndexCodecV1()

Method Detail

startBlockEncoding

public void startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx,
                               DataOutputStream out)
                        throws IOException

Description copied from interface: DataBlockEncoder

Starts encoding for a block of KeyValues. Call DataBlockEncoder.endBlockEncoding(HFileBlockEncodingContext, DataOutputStream, byte[]) to finish encoding of a block.

Throws:

IOException

encode

public int encode(Cell cell,
                  HFileBlockEncodingContext encodingCtx,
                  DataOutputStream out)
           throws IOException

Description copied from interface: DataBlockEncoder

Encodes a KeyValue.

Returns:

unencoded kv size written

Throws:

IOException

endBlockEncoding

public void endBlockEncoding(HFileBlockEncodingContext encodingCtx,
                             DataOutputStream out,
                             byte[] uncompressedBytesWithHeader)
                      throws IOException

Description copied from interface: DataBlockEncoder

Ends encoding for a block of KeyValues. Gives a chance for the encoder to do the finishing stuff for the encoded block. It must be called at the end of block encoding.

Throws:

IOException

decodeKeyValues

public ByteBuffer decodeKeyValues(DataInputStream source,
                                  HFileBlockDecodingContext decodingCtx)
                           throws IOException

Description copied from interface: DataBlockEncoder

Decode.

Parameters:

source - Compressed stream of KeyValues.

Returns:

Uncompressed block of KeyValues.

Throws:

IOException - If there is an error in source.

getFirstKeyCellInBlock

public Cell getFirstKeyCellInBlock(ByteBuff block)

Description copied from interface: DataBlockEncoder

Return first key in block as a cell. Useful for indexing. Typically does not make a deep copy but returns a buffer wrapping a segment of the actual block's byte array. This is because the first key in block is usually stored unencoded.

Parameters:

block - encoded block we want index, the position will not change

Returns:

First key in block as a cell.

createSeeker

public DataBlockEncoder.EncodedSeeker createSeeker(CellComparator comparator,
                                                   HFileBlockDecodingContext decodingCtx)

Description copied from interface: DataBlockEncoder

Create a HFileBlock seeker which find KeyValues within a block.

Parameters:

comparator - what kind of comparison should be used

Returns:

A newly created seeker.