org.apache.hadoop.hbase.io.hfile

Class HFileDataBlockEncoderImpl

java.lang.Object

org.apache.hadoop.hbase.io.hfile.HFileDataBlockEncoderImpl

All Implemented Interfaces:

HFileDataBlockEncoder

@InterfaceAudience.Private
public class HFileDataBlockEncoderImpl
extends Object
implements HFileDataBlockEncoder

Do different kinds of data block encoding according to column family options.

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.io.hfile.HFileDataBlockEncoder

DATA_BLOCK_ENCODING

Constructor Summary

Constructors

Constructor and Description
HFileDataBlockEncoderImpl(org.apache.hadoop.hbase.io.encoding.DataBlockEncoding encoding) Do data block encoding with specified options.

Method Summary

Modifier and Type	Method and Description
static HFileDataBlockEncoder	createFromFileInfo(HFile.FileInfo fileInfo)
int	encode(org.apache.hadoop.hbase.Cell cell, org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx, DataOutputStream out) Encodes a KeyValue.
void	endBlockEncoding(org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx, DataOutputStream out, byte[] uncompressedBytesWithHeader, org.apache.hadoop.hbase.io.hfile.BlockType blockType) Ends encoding for a block of KeyValues.
org.apache.hadoop.hbase.io.encoding.DataBlockEncoding	getDataBlockEncoding()
org.apache.hadoop.hbase.io.encoding.DataBlockEncoding	getEffectiveEncodingInCache(boolean isCompaction)
org.apache.hadoop.hbase.io.encoding.HFileBlockDecodingContext	newDataBlockDecodingContext(org.apache.hadoop.hbase.io.hfile.HFileContext fileContext) create a encoder specific decoding context for reading.
org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext	newDataBlockEncodingContext(byte[] dummyHeader, org.apache.hadoop.hbase.io.hfile.HFileContext fileContext) Create an encoder specific encoding context object for writing.
void	saveMetadata(HFile.Writer writer) Save metadata in HFile which will be written to disk
void	startBlockEncoding(org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx, DataOutputStream out) Starts encoding for a block of KeyValues.
String	toString()
boolean	useEncodedScanner() Decides whether we should use a scanner over encoded blocks.
boolean	useEncodedScanner(boolean isCompaction)

Methods inherited from class java.lang.Object

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

Constructor Detail

HFileDataBlockEncoderImpl

public HFileDataBlockEncoderImpl(org.apache.hadoop.hbase.io.encoding.DataBlockEncoding encoding)

Do data block encoding with specified options.

Parameters:

encoding - What kind of data block encoding will be used.

Method Detail

createFromFileInfo

public static HFileDataBlockEncoder createFromFileInfo(HFile.FileInfo fileInfo)
                                                throws IOException

Throws:

IOException

saveMetadata

public void saveMetadata(HFile.Writer writer)
                  throws IOException

Description copied from interface: HFileDataBlockEncoder

Save metadata in HFile which will be written to disk

Specified by:

saveMetadata in interface HFileDataBlockEncoder

Parameters:

writer - writer for a given HFile

Throws:

IOException - on disk problems

getDataBlockEncoding

public org.apache.hadoop.hbase.io.encoding.DataBlockEncoding getDataBlockEncoding()

Specified by:

getDataBlockEncoding in interface HFileDataBlockEncoder

Returns:

the data block encoding

useEncodedScanner

public boolean useEncodedScanner(boolean isCompaction)

getEffectiveEncodingInCache

public org.apache.hadoop.hbase.io.encoding.DataBlockEncoding getEffectiveEncodingInCache(boolean isCompaction)

Specified by:

getEffectiveEncodingInCache in interface HFileDataBlockEncoder

Returns:

the effective in-cache data block encoding, taking into account whether we are doing a compaction.

encode

public int encode(org.apache.hadoop.hbase.Cell cell,
                  org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx,
                  DataOutputStream out)
           throws IOException

Description copied from interface: HFileDataBlockEncoder

Encodes a KeyValue.

Specified by:

encode in interface HFileDataBlockEncoder

Returns:

unencoded kv size

Throws:

IOException

useEncodedScanner

public boolean useEncodedScanner()

Description copied from interface: HFileDataBlockEncoder

Decides whether we should use a scanner over encoded blocks.

Specified by:

useEncodedScanner in interface HFileDataBlockEncoder

Returns:

Whether to use encoded scanner.

toString

public String toString()

Overrides:

toString in class Object

newDataBlockEncodingContext

public org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext newDataBlockEncodingContext(byte[] dummyHeader,
                                                                                                 org.apache.hadoop.hbase.io.hfile.HFileContext fileContext)

Description copied from interface: HFileDataBlockEncoder

Create an encoder specific encoding context object for writing. And the encoding context should also perform compression if compressionAlgorithm is valid.

Specified by:

newDataBlockEncodingContext in interface HFileDataBlockEncoder

Parameters:

dummyHeader - header bytes

fileContext - HFile meta data

Returns:

a new HFileBlockEncodingContext object

newDataBlockDecodingContext

public org.apache.hadoop.hbase.io.encoding.HFileBlockDecodingContext newDataBlockDecodingContext(org.apache.hadoop.hbase.io.hfile.HFileContext fileContext)

Description copied from interface: HFileDataBlockEncoder

create a encoder specific decoding context for reading. And the decoding context should also do decompression if compressionAlgorithm is valid.

Specified by:

newDataBlockDecodingContext in interface HFileDataBlockEncoder

Parameters:

fileContext - - HFile meta data

Returns:

a new HFileBlockDecodingContext object

startBlockEncoding

public void startBlockEncoding(org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx,
                               DataOutputStream out)
                        throws IOException

Description copied from interface: HFileDataBlockEncoder

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

Specified by:

startBlockEncoding in interface HFileDataBlockEncoder

Throws:

IOException

endBlockEncoding

public void endBlockEncoding(org.apache.hadoop.hbase.io.encoding.HFileBlockEncodingContext encodingCtx,
                             DataOutputStream out,
                             byte[] uncompressedBytesWithHeader,
                             org.apache.hadoop.hbase.io.hfile.BlockType blockType)
                      throws IOException

Description copied from interface: HFileDataBlockEncoder

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 HFileDataBlockEncoder

Throws:

IOException