org.apache.hadoop.hbase.io.encoding

Class PrefixKeyDeltaEncoder

java.lang.Object

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

org.apache.hadoop.hbase.io.encoding.PrefixKeyDeltaEncoder

All Implemented Interfaces:

DataBlockEncoder

@InterfaceAudience.Private
public class PrefixKeyDeltaEncoder
extends AbstractDataBlockEncoder

Compress key by storing size of common prefix with previous KeyValue and storing raw size of rest. Format: 1-5 bytes: compressed key length minus prefix (7-bit encoding) 1-5 bytes: compressed value length (7-bit encoding) 1-3 bytes: compressed length of common key prefix ... bytes: rest of key (including timestamp) ... bytes: value In a worst case compressed KeyValue will be three bytes longer than original.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BufferedDataBlockEncoder.BufferedEncodedSeeker<STATE extends BufferedDataBlockEncoder.SeekerState>
protected static class	BufferedDataBlockEncoder.OffheapDecodedExtendedCell
protected static class	BufferedDataBlockEncoder.OnheapDecodedCell Copies only the key part of the keybuffer by doing a deep copy and passes the seeker state members for taking a clone.
protected static class	BufferedDataBlockEncoder.SeekerState

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
PrefixKeyDeltaEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	afterDecodingKeyValue(DataInputStream source, ByteBuffer dest, HFileBlockDefaultDecodingContext decodingCtx)
protected int	afterEncodingKeyValue(Cell cell, DataOutputStream out, HFileBlockDefaultEncodingContext encodingCtx)
static int	compareCommonFamilyPrefix(Cell left, Cell right, int familyCommonPrefix)
static int	compareCommonQualifierPrefix(Cell left, Cell right, int qualCommonPrefix)
static int	compareCommonRowPrefix(Cell left, Cell right, int rowCommonPrefix) common prefixes
DataBlockEncoder.EncodedSeeker	createSeeker(CellComparator comparator, HFileBlockDecodingContext decodingCtx) Create a HFileBlock seeker which find KeyValues within a block.
ByteBuffer	decodeKeyValues(DataInputStream source, HFileBlockDecodingContext blkDecodingCtx) 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.
protected static void	ensureSpace(ByteBuffer out, int length) Asserts that there is at least the given amount of unfilled space remaining in the given buffer.
Cell	getFirstKeyCellInBlock(ByteBuff block) Return first key in block as a cell.
protected ByteBuffer	internalDecodeKeyValues(DataInputStream source, int allocateHeaderLength, int skipLastBytes, HFileBlockDefaultDecodingContext decodingCtx)
int	internalEncode(Cell cell, HFileBlockDefaultEncodingContext encodingContext, DataOutputStream out)
void	startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx, DataOutputStream out) Starts encoding for a block of KeyValues.
String	toString()

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, wait, wait, wait

Constructor Detail

PrefixKeyDeltaEncoder

public PrefixKeyDeltaEncoder()

Method Detail

internalEncode

public int internalEncode(Cell cell,
                          HFileBlockDefaultEncodingContext encodingContext,
                          DataOutputStream out)
                   throws IOException

Throws:

IOException

internalDecodeKeyValues

protected ByteBuffer internalDecodeKeyValues(DataInputStream source,
                                             int allocateHeaderLength,
                                             int skipLastBytes,
                                             HFileBlockDefaultDecodingContext decodingCtx)
                                      throws IOException

Throws:

IOException

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.

toString

public String toString()

Overrides:

toString in class Object

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.

decodeKeyValues

public ByteBuffer decodeKeyValues(DataInputStream source,
                                  HFileBlockDecodingContext blkDecodingCtx)
                           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.

compareCommonRowPrefix

public static int compareCommonRowPrefix(Cell left,
                                         Cell right,
                                         int rowCommonPrefix)

common prefixes

compareCommonFamilyPrefix

public static int compareCommonFamilyPrefix(Cell left,
                                            Cell right,
                                            int familyCommonPrefix)

compareCommonQualifierPrefix

public static int compareCommonQualifierPrefix(Cell left,
                                               Cell right,
                                               int qualCommonPrefix)

afterEncodingKeyValue

protected final int afterEncodingKeyValue(Cell cell,
                                          DataOutputStream out,
                                          HFileBlockDefaultEncodingContext encodingCtx)
                                   throws IOException

Parameters:

cell -

out -

encodingCtx -

Returns:

unencoded size added

Throws:

IOException

afterDecodingKeyValue

protected final void afterDecodingKeyValue(DataInputStream source,
                                           ByteBuffer dest,
                                           HFileBlockDefaultDecodingContext decodingCtx)
                                    throws IOException

Throws:

IOException

ensureSpace

protected static void ensureSpace(ByteBuffer out,
                                  int length)
                           throws EncoderBufferTooSmallException

Asserts that there is at least the given amount of unfilled space remaining in the given buffer.

Parameters:

out - typically, the buffer we are writing to

length - the required space in the buffer

Throws:

EncoderBufferTooSmallException - If there are no enough bytes.

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