org.apache.hadoop.hbase.io.encoding

Class HFileBlockDefaultEncodingContext

java.lang.Object

org.apache.hadoop.hbase.io.encoding.HFileBlockDefaultEncodingContext

All Implemented Interfaces:

HFileBlockEncodingContext

@InterfaceAudience.Private
public class HFileBlockDefaultEncodingContext
extends Object
implements HFileBlockEncodingContext

A default implementation of HFileBlockEncodingContext. It will compress the data section as one continuous buffer.

See Also:

for the decompression part

Constructor Summary

Constructors

Constructor and Description
HFileBlockDefaultEncodingContext(org.apache.hadoop.conf.Configuration conf, DataBlockEncoding encoding, byte[] headerBytes, HFileContext fileContext)

Method Summary

Modifier and Type	Method and Description
void	close() Releases the compressor this writer uses to compress blocks into the compressor pool.
Bytes	compressAndEncrypt(byte[] data, int offset, int length) Compress and encrypt the supplied encoded block data with header.
BlockType	getBlockType() Returns the block type after encoding
DataBlockEncoding	getDataBlockEncoding() Returns the DataBlockEncoding encoding used
EncodingState	getEncodingState() Returns the encoding state
HFileContext	getHFileContext() Returns HFile context information
TagCompressionContext	getTagCompressionContext()
void	postEncoding(BlockType blockType) Do any action that needs to be performed after the encoding.
void	prepareEncoding(DataOutputStream out) prepare to start a new encoding.
void	setEncodingState(EncodingState state) Sets the encoding state.
void	setTagCompressionContext(TagCompressionContext tagCompressionContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

HFileBlockDefaultEncodingContext

public HFileBlockDefaultEncodingContext(org.apache.hadoop.conf.Configuration conf,
                                        DataBlockEncoding encoding,
                                        byte[] headerBytes,
                                        HFileContext fileContext)

Parameters:

conf - configuraton

encoding - encoding used

headerBytes - dummy header bytes

fileContext - HFile meta data

Method Detail

prepareEncoding

public void prepareEncoding(DataOutputStream out)
                     throws IOException

prepare to start a new encoding.

Throws:

IOException

postEncoding

public void postEncoding(BlockType blockType)
                  throws IOException

Description copied from interface: HFileBlockEncodingContext

Do any action that needs to be performed after the encoding. Compression is also included if a non-null compression algorithm is used

Specified by:

postEncoding in interface HFileBlockEncodingContext

Throws:

IOException

compressAndEncrypt

public Bytes compressAndEncrypt(byte[] data,
                                int offset,
                                int length)
                         throws IOException

Description copied from interface: HFileBlockEncodingContext

Compress and encrypt the supplied encoded block data with header.

Specified by:

compressAndEncrypt in interface HFileBlockEncodingContext

Parameters:

data - encoded bytes with header

offset - the offset in encoded data to start at

length - the number of encoded bytes

Returns:

Bytes with header which are ready to write out to disk. This is compressed and encrypted bytes applying the set compression algorithm and encryption. The bytes may be changed. If need a Bytes reference for later use, clone the bytes and use that. Null if the data doesn't need to be compressed and encrypted.

Throws:

IOException

getBlockType

public BlockType getBlockType()

Description copied from interface: HFileBlockEncodingContext

Returns the block type after encoding

Specified by:

getBlockType in interface HFileBlockEncodingContext

close

public void close()

Releases the compressor this writer uses to compress blocks into the compressor pool.

Specified by:

close in interface HFileBlockEncodingContext

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

Description copied from interface: HFileBlockEncodingContext

Returns the DataBlockEncoding encoding used

Specified by:

getDataBlockEncoding in interface HFileBlockEncodingContext

getHFileContext

public HFileContext getHFileContext()

Description copied from interface: HFileBlockEncodingContext

Returns HFile context information

Specified by:

getHFileContext in interface HFileBlockEncodingContext

getTagCompressionContext

public TagCompressionContext getTagCompressionContext()

setTagCompressionContext

public void setTagCompressionContext(TagCompressionContext tagCompressionContext)

getEncodingState

public EncodingState getEncodingState()

Description copied from interface: HFileBlockEncodingContext

Returns the encoding state

Specified by:

getEncodingState in interface HFileBlockEncodingContext

setEncodingState

public void setEncodingState(EncodingState state)

Description copied from interface: HFileBlockEncodingContext

Sets the encoding state.

Specified by:

setEncodingState in interface HFileBlockEncodingContext