org.apache.hadoop.hbase.codec.prefixtree

Class PrefixTreeCodec

java.lang.Object

org.apache.hadoop.hbase.codec.prefixtree.PrefixTreeCodec

All Implemented Interfaces:

DataBlockEncoder

@InterfaceAudience.Private
public class PrefixTreeCodec
extends Object
implements DataBlockEncoder

This class is created via reflection in DataBlockEncoding enum. Update the enum if class name or package changes.

PrefixTreeDataBlockEncoder implementation of DataBlockEncoder. This is the primary entry point for PrefixTree encoding and decoding. Encoding is delegated to instances of PrefixTreeEncoder, and decoding is delegated to instances of CellSearcher. Encoder and decoder instances are created and recycled by static PtEncoderFactory and PtDecoderFactory.

Nested Class Summary

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

DataBlockEncoder.EncodedSeeker

Constructor Summary

Constructors

Constructor and Description
PrefixTreeCodec() no-arg constructor for reflection

Method Summary

Methods

Modifier and Type	Method and Description
DataBlockEncoder.EncodedSeeker	createSeeker(KeyValue.KVComparator comparator, HFileBlockDecodingContext decodingCtx) Is this the correct handling of an illegal comparator? How to prevent that from getting all the way to this point.
ByteBuffer	decodeKeyValues(DataInputStream source, HFileBlockDecodingContext decodingCtx)
ByteBuffer	decodeKeyValues(DataInputStream source, int allocateHeaderLength, int skipLastBytes, HFileBlockDecodingContext decodingCtx) I don't think this method is called during normal HBase operation, so efficiency is not important.
int	encode(Cell cell, HFileBlockEncodingContext encodingCtx, DataOutputStream out)
void	endBlockEncoding(HFileBlockEncodingContext encodingCtx, DataOutputStream out, byte[] uncompressedBytesWithHeader)
ByteBuffer	getFirstKeyInBlock(ByteBuffer block)
HFileBlockDecodingContext	newDataBlockDecodingContext(HFileContext meta)
HFileBlockEncodingContext	newDataBlockEncodingContext(DataBlockEncoding encoding, byte[] header, HFileContext meta)
void	startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx, DataOutputStream out)

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixTreeCodec

public PrefixTreeCodec()

no-arg constructor for reflection

Method Detail

decodeKeyValues

public ByteBuffer decodeKeyValues(DataInputStream source,
                         HFileBlockDecodingContext decodingCtx)
                           throws IOException

Specified by:

decodeKeyValues in interface DataBlockEncoder

Throws:

IOException

decodeKeyValues

public ByteBuffer decodeKeyValues(DataInputStream source,
                         int allocateHeaderLength,
                         int skipLastBytes,
                         HFileBlockDecodingContext decodingCtx)
                           throws IOException

I don't think this method is called during normal HBase operation, so efficiency is not important.

Throws:

IOException

getFirstKeyInBlock

public ByteBuffer getFirstKeyInBlock(ByteBuffer block)

Specified by:

getFirstKeyInBlock in interface DataBlockEncoder

newDataBlockEncodingContext

public HFileBlockEncodingContext newDataBlockEncodingContext(DataBlockEncoding encoding,
                                                    byte[] header,
                                                    HFileContext meta)

Specified by:

newDataBlockEncodingContext in interface DataBlockEncoder

newDataBlockDecodingContext

public HFileBlockDecodingContext newDataBlockDecodingContext(HFileContext meta)

Specified by:

newDataBlockDecodingContext in interface DataBlockEncoder

createSeeker

public DataBlockEncoder.EncodedSeeker createSeeker(KeyValue.KVComparator comparator,
                                          HFileBlockDecodingContext decodingCtx)

Is this the correct handling of an illegal comparator? How to prevent that from getting all the way to this point.

Specified by:

createSeeker in interface DataBlockEncoder

encode

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

Specified by:

encode in interface DataBlockEncoder

Throws:

IOException

startBlockEncoding

public void startBlockEncoding(HFileBlockEncodingContext blkEncodingCtx,
                      DataOutputStream out)
                        throws IOException

Specified by:

startBlockEncoding in interface DataBlockEncoder

Throws:

IOException

endBlockEncoding

public void endBlockEncoding(HFileBlockEncodingContext encodingCtx,
                    DataOutputStream out,
                    byte[] uncompressedBytesWithHeader)
                      throws IOException

Specified by:

endBlockEncoding in interface DataBlockEncoder

Throws:

IOException