org.apache.hadoop.hbase.io.encoding

Class BufferedDataBlockEncoder

java.lang.Object

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

org.apache.hadoop.hbase.io.encoding.BufferedDataBlockEncoder

All Implemented Interfaces:

DataBlockEncoder

Direct Known Subclasses:

CopyKeyDataBlockEncoder, DiffKeyDeltaEncoder, FastDiffDeltaEncoder, PrefixKeyDeltaEncoder

@InterfaceAudience.Private
abstract class BufferedDataBlockEncoder
extends AbstractDataBlockEncoder

Base class for all data block encoders that use a buffer.

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

Field Summary

Fields

Modifier and Type	Field and Description
private static int	INITIAL_KEY_BUFFER_SIZE TODO: This datablockencoder is dealing in internals of hfileblocks.

Constructor Summary

Constructors

Constructor and Description
BufferedDataBlockEncoder()

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
ByteBuffer	decodeKeyValues(DataInputStream source, HFileBlockDecodingContext blkDecodingCtx) Decode.
void	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.
protected abstract ByteBuffer	internalDecodeKeyValues(DataInputStream source, int allocateHeaderLength, int skipLastBytes, HFileBlockDefaultDecodingContext decodingCtx)
abstract int	internalEncode(Cell cell, HFileBlockDefaultEncodingContext encodingCtx, DataOutputStream out)
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

Methods inherited from interface org.apache.hadoop.hbase.io.encoding.DataBlockEncoder

createSeeker, getFirstKeyCellInBlock

Field Detail

INITIAL_KEY_BUFFER_SIZE

private static int INITIAL_KEY_BUFFER_SIZE

TODO: This datablockencoder is dealing in internals of hfileblocks. Purge reference to HFBs

Constructor Detail

BufferedDataBlockEncoder

BufferedDataBlockEncoder()

Method Detail

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

Returns:

unencoded size added

Throws:

IOException

afterDecodingKeyValue

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

Throws:

IOException

internalDecodeKeyValues

protected abstract ByteBuffer internalDecodeKeyValues(DataInputStream source,
                                                      int allocateHeaderLength,
                                                      int skipLastBytes,
                                                      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 void encode(Cell cell,
                   HFileBlockEncodingContext encodingCtx,
                   DataOutputStream out)
            throws IOException

Description copied from interface: DataBlockEncoder

Encodes a KeyValue. After the encode, EncodingState.postCellEncode(int, int) needs to be called to keep track of the encoded and unencoded data size

Throws:

IOException

internalEncode

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

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