BufferedDataBlockEncoder (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.io.encoding.BufferedDataBlockEncoder

All Implemented Interfaces:

DataBlockEncoder

Direct Known Subclasses:

CopyKeyDataBlockEncoder, DiffKeyDeltaEncoder, FastDiffDeltaEncoder, PrefixKeyDeltaEncoder
```
@InterfaceAudience.Private
abstract class BufferedDataBlockEncoder
extends Object
implements DataBlockEncoder
```
Base class for all data block encoders that use a buffer.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`BufferedDataBlockEncoder.BufferedDataBlockEncodingState`
`protected static class`	`BufferedDataBlockEncoder.BufferedEncodedSeeker<STATE extends BufferedDataBlockEncoder.SeekerState>`
`protected static class`	`BufferedDataBlockEncoder.ClonedSeekerState` 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 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

Fields
Modifier and Type	Field and Description
`private static int`	`INITIAL_KEY_BUFFER_SIZE`

Constructor Summary

Constructors
Constructor and Description

BufferedDataBlockEncoder()

Constructors
Constructor and Description
`BufferedDataBlockEncoder()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`afterDecodingKeyValue(DataInputStream source, ByteBuffer dest, HFileBlockDefaultDecodingContext decodingCtx)`
`protected int`	`afterEncodingKeyValue(Cell cell, DataOutputStream out, HFileBlockDefaultEncodingContext encodingCtx)`
`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.
`protected abstract ByteBuffer`	`internalDecodeKeyValues(DataInputStream source, int allocateHeaderLength, int skipLastBytes, HFileBlockDefaultDecodingContext decodingCtx)`
`abstract int`	`internalEncode(Cell cell, HFileBlockDefaultEncodingContext encodingCtx, DataOutputStream out)`
`HFileBlockDecodingContext`	`newDataBlockDecodingContext(HFileContext meta)` Creates an encoder specific decoding context, which will prepare the data before actual decoding
`HFileBlockEncodingContext`	`newDataBlockEncodingContext(DataBlockEncoding encoding, byte[] header, HFileContext meta)` Creates a encoder specific encoding context
`void`	`startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx, DataOutputStream out)` Starts encoding for a block of KeyValues.

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

Field Detail

INITIAL_KEY_BUFFER_SIZE

private static int INITIAL_KEY_BUFFER_SIZE

Constructor Detail
- BufferedDataBlockEncoder
```
BufferedDataBlockEncoder()
```

Method Detail

decodeKeyValues
```
public ByteBuffer decodeKeyValues(DataInputStream source,
                         HFileBlockDecodingContext blkDecodingCtx)
                           throws IOException
```
Description copied from interface: DataBlockEncoder

Decode.

Specified by:

decodeKeyValues in interface DataBlockEncoder

Parameters:
source - Compressed stream of KeyValues.

Returns:
Uncompressed block of KeyValues.

Throws:

IOException - If there is an error in source.

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

newDataBlockEncodingContext
```
public HFileBlockEncodingContext newDataBlockEncodingContext(DataBlockEncoding encoding,
                                                    byte[] header,
                                                    HFileContext meta)
```
Description copied from interface: DataBlockEncoder

Creates a encoder specific encoding context

Specified by:

newDataBlockEncodingContext in interface DataBlockEncoder

Parameters:
encoding - encoding strategy used
header - header bytes to be written, put a dummy header here if the header is unknown
meta - HFile meta data

Returns:
a newly created encoding context

newDataBlockDecodingContext
```
public HFileBlockDecodingContext newDataBlockDecodingContext(HFileContext meta)
```
Description copied from interface: DataBlockEncoder

Creates an encoder specific decoding context, which will prepare the data before actual decoding

Specified by:

newDataBlockDecodingContext in interface DataBlockEncoder

Parameters:
meta - HFile meta data

Returns:
a newly created decoding context

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.

Specified by:

startBlockEncoding in interface DataBlockEncoder

Throws:

IOException

encode
```
public int encode(Cell cell,
         HFileBlockEncodingContext encodingCtx,
         DataOutputStream out)
           throws IOException
```
Description copied from interface: DataBlockEncoder

Encodes a KeyValue.

Specified by:

encode in interface DataBlockEncoder

Returns:
unencoded kv size written

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.

Specified by:

endBlockEncoding in interface DataBlockEncoder

Throws:

IOException

Class BufferedDataBlockEncoder

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_KEY_BUFFER_SIZE

Constructor Detail

BufferedDataBlockEncoder

Method Detail

decodeKeyValues

afterEncodingKeyValue

afterDecodingKeyValue

newDataBlockEncodingContext

newDataBlockDecodingContext

internalDecodeKeyValues

ensureSpace

startBlockEncoding

encode

internalEncode

endBlockEncoding