org.apache.hadoop.hbase.io.hfile

Class NoOpDataBlockEncoder

java.lang.Object

org.apache.hadoop.hbase.io.hfile.NoOpDataBlockEncoder

All Implemented Interfaces:

HFileDataBlockEncoder

@InterfaceAudience.Private
public class NoOpDataBlockEncoder
extends java.lang.Object
implements HFileDataBlockEncoder

Does not perform any kind of encoding/decoding.

Field Summary

Fields

Modifier and Type	Field and Description
static NoOpDataBlockEncoder	INSTANCE

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

DATA_BLOCK_ENCODING

Method Summary

Modifier and Type	Method and Description
int	encode(Cell cell, HFileBlockEncodingContext encodingCtx, java.io.DataOutputStream out) Encodes a KeyValue.
void	endBlockEncoding(HFileBlockEncodingContext encodingCtx, java.io.DataOutputStream out, byte[] uncompressedBytesWithHeader, BlockType blockType) Ends encoding for a block of KeyValues.
DataBlockEncoding	getDataBlockEncoding()
DataBlockEncoding	getEffectiveEncodingInCache(boolean isCompaction)
HFileBlockDecodingContext	newDataBlockDecodingContext(HFileContext meta) create a encoder specific decoding context for reading.
HFileBlockEncodingContext	newDataBlockEncodingContext(byte[] dummyHeader, HFileContext meta) 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(HFileBlockEncodingContext encodingCtx, java.io.DataOutputStream out) Starts encoding for a block of KeyValues.
java.lang.String	toString()
boolean	useEncodedScanner() Decides whether we should use a scanner over encoded blocks.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final NoOpDataBlockEncoder INSTANCE

Method Detail

encode

public int encode(Cell cell,
                  HFileBlockEncodingContext encodingCtx,
                  java.io.DataOutputStream out)
           throws java.io.IOException

Description copied from interface: HFileDataBlockEncoder

Encodes a KeyValue.

Specified by:

encode in interface HFileDataBlockEncoder

Returns:

unencoded kv size

Throws:

java.io.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.

saveMetadata

public void saveMetadata(HFile.Writer writer)

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

getDataBlockEncoding

public DataBlockEncoding getDataBlockEncoding()

Specified by:

getDataBlockEncoding in interface HFileDataBlockEncoder

Returns:

the data block encoding

getEffectiveEncodingInCache

public 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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newDataBlockEncodingContext

public HFileBlockEncodingContext newDataBlockEncodingContext(byte[] dummyHeader,
                                                             HFileContext meta)

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

meta - HFile meta data

Returns:

a new HFileBlockEncodingContext object

newDataBlockDecodingContext

public HFileBlockDecodingContext newDataBlockDecodingContext(HFileContext meta)

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:

meta - - HFile meta data

Returns:

a new HFileBlockDecodingContext object

startBlockEncoding

public void startBlockEncoding(HFileBlockEncodingContext encodingCtx,
                               java.io.DataOutputStream out)
                        throws java.io.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:

java.io.IOException

endBlockEncoding

public void endBlockEncoding(HFileBlockEncodingContext encodingCtx,
                             java.io.DataOutputStream out,
                             byte[] uncompressedBytesWithHeader,
                             BlockType blockType)
                      throws java.io.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:

java.io.IOException