BufferedDataBlockEncoder.OnheapDecodedCell (Apache HBase 2.5.0 API)

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

All Implemented Interfaces:

Cell, ExtendedCell, HeapSize, RawCell

Enclosing class:

BufferedDataBlockEncoder
```
protected static class BufferedDataBlockEncoder.OnheapDecodedCell
extends Object
implements ExtendedCell
```
Copies only the key part of the keybuffer by doing a deep copy and passes the seeker state members for taking a clone. Note that the value byte[] part is still pointing to the currentBuffer and represented by the valueOffset and valueLength

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Cell
  Cell.Type

Field Summary

Fields
Modifier and Type	Field and Description
`private byte`	`familyLength`
`private int`	`familyOffset`
`private static long`	`FIXED_OVERHEAD`
`private byte[]`	`keyOnlyBuffer`
`private int`	`qualifierLength`
`private int`	`qualifierOffset`
`private short`	`rowLength`
`private long`	`seqId`
`private byte[]`	`tagsBuffer`
`private int`	`tagsLength`
`private int`	`tagsOffset`
`private long`	`timeStamp`
`private byte`	`typeByte`
`private byte[]`	`valueBuffer`
`private int`	`valueLength`
`private int`	`valueOffset`

Fields inherited from interface org.apache.hadoop.hbase.ExtendedCell
CELL_NOT_BASED_ON_CHUNK

Fields inherited from interface org.apache.hadoop.hbase.RawCell
MAX_TAGS_LENGTH

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`OnheapDecodedCell(byte[] keyBuffer, short rowLength, int familyOffset, byte familyLength, int qualOffset, int qualLength, long timeStamp, byte typeByte, byte[] valueBuffer, int valueOffset, int valueLen, long seqId, byte[] tagsBuffer, int tagsOffset, int tagsLength)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExtendedCell`	`deepClone()` Does a deep copy of the contents to a new memory area and returns it as a new cell.
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`byte`	`getFamilyLength()` Returns Number of family bytes.
`int`	`getFamilyOffset()` Returns Array index of first family byte
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()` Returns Number of qualifier bytes.
`int`	`getQualifierOffset()` Returns Array index of first qualifier byte
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`short`	`getRowLength()` Returns Number of row bytes.
`int`	`getRowOffset()` Returns Array index of first row byte
`long`	`getSequenceId()` A region-specific unique monotonically increasing sequence ID given to each Cell.
`int`	`getSerializedSize(boolean withTags)` KeyValue format `<4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> <tags>`
`byte[]`	`getTagsArray()` Contiguous raw bytes representing tags that may start at any index in the containing array.
`int`	`getTagsLength()` HBase internally uses 2 bytes to store tags length in Cell.
`int`	`getTagsOffset()` Returns the first offset where the tags start in the Cell
`long`	`getTimestamp()` Return a long value representing time at which this cell was "Put" into the row.
`byte`	`getTypeByte()` Returns The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
`byte[]`	`getValueArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getValueLength()` Returns Number of value bytes.
`int`	`getValueOffset()` Returns Array index of first value byte
`long`	`heapSize()` Return the approximate 'exclusive deep size' of implementing object.
`void`	`setSequenceId(long seqId)` Sets with the given seqId.
`void`	`setTimestamp(byte[] ts)` Sets with the given timestamp.
`void`	`setTimestamp(long ts)` Sets with the given timestamp.
`String`	`toString()`
`void`	`write(ByteBuffer buf, int offset)` Write this Cell into the given buf's offset in a `KeyValue` format.
`int`	`write(OutputStream out, boolean withTags)` Write this cell to an OutputStream in a `KeyValue` format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.ExtendedCell
getChunkId, getSerializedSize

Methods inherited from interface org.apache.hadoop.hbase.RawCell
checkForTagsLength, cloneTags, createCell, getTag, getTags

Methods inherited from interface org.apache.hadoop.hbase.Cell
getType

- Field Detail
  - FIXED_OVERHEAD
```
private static final long FIXED_OVERHEAD
```
  - keyOnlyBuffer
```
private byte[] keyOnlyBuffer
```
  - rowLength
```
private short rowLength
```
  - familyOffset
```
private int familyOffset
```
  - familyLength
```
private byte familyLength
```
  - qualifierOffset
```
private int qualifierOffset
```
  - qualifierLength
```
private int qualifierLength
```
  - timeStamp
```
private long timeStamp
```
  - typeByte
```
private byte typeByte
```
  - valueBuffer
```
private byte[] valueBuffer
```
  - valueOffset
```
private int valueOffset
```
  - valueLength
```
private int valueLength
```
  - tagsBuffer
```
private byte[] tagsBuffer
```
  - tagsOffset
```
private int tagsOffset
```
  - tagsLength
```
private int tagsLength
```
  - seqId
```
private long seqId
```
- Constructor Detail
  - OnheapDecodedCell
```
protected OnheapDecodedCell(byte[] keyBuffer,
                            short rowLength,
                            int familyOffset,
                            byte familyLength,
                            int qualOffset,
                            int qualLength,
                            long timeStamp,
                            byte typeByte,
                            byte[] valueBuffer,
                            int valueOffset,
                            int valueLen,
                            long seqId,
                            byte[] tagsBuffer,
                            int tagsOffset,
                            int tagsLength)
```
- Method Detail
  - getRowArray
```
public byte[] getRowArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Short.MAX_VALUE which is 32,767 bytes.
    
    Specified by:
    
    getRowArray in interface Cell
    
    Returns:
    
    The array containing the row bytes.
  - getFamilyArray
```
public byte[] getFamilyArray()
```
    Description copied from interface: Cell
    
    Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array. Max length is Byte.MAX_VALUE, which is 127 bytes.
    
    Specified by:
    
    getFamilyArray in interface Cell
    
    Returns:
    
    the array containing the family bytes.
  - getQualifierArray
```
public byte[] getQualifierArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array.
    
    Specified by:
    
    getQualifierArray in interface Cell
    
    Returns:
    
    The array containing the qualifier bytes.
  - getRowOffset
```
public int getRowOffset()
```
    Description copied from interface: Cell
    
    Returns Array index of first row byte
    
    Specified by:
    
    getRowOffset in interface Cell
  - getRowLength
```
public short getRowLength()
```
    Description copied from interface: Cell
    
    Returns Number of row bytes. Must be < rowArray.length - offset.
    
    Specified by:
    
    getRowLength in interface Cell
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Description copied from interface: Cell
    
    Returns Array index of first family byte
    
    Specified by:
    
    getFamilyOffset in interface Cell
  - getFamilyLength
```
public byte getFamilyLength()
```
    Description copied from interface: Cell
    
    Returns Number of family bytes. Must be < familyArray.length - offset.
    
    Specified by:
    
    getFamilyLength in interface Cell
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Description copied from interface: Cell
    
    Returns Array index of first qualifier byte
    
    Specified by:
    
    getQualifierOffset in interface Cell
  - getQualifierLength
```
public int getQualifierLength()
```
    Description copied from interface: Cell
    
    Returns Number of qualifier bytes. Must be < qualifierArray.length - offset.
    
    Specified by:
    
    getQualifierLength in interface Cell
  - getTimestamp
```
public long getTimestamp()
```
    Description copied from interface: Cell
    
    Return a long value representing time at which this cell was "Put" into the row. Typically represents the time of insertion, but can be any value from 0 to Long.MAX_VALUE.
    
    Specified by:
    
    getTimestamp in interface Cell
  - getTypeByte
```
public byte getTypeByte()
```
    Description copied from interface: ExtendedCell
    
    Returns The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
    
    Specified by:
    
    getTypeByte in interface Cell
    
    Specified by:
    
    getTypeByte in interface ExtendedCell
  - getSequenceId
```
public long getSequenceId()
```
    Description copied from interface: ExtendedCell
    
    A region-specific unique monotonically increasing sequence ID given to each Cell. It always exists for cells in the memstore but is not retained forever. It will be kept for HConstants.KEEP_SEQID_PERIOD days, but generally becomes irrelevant after the cell's row is no longer involved in any operations that require strict consistency.
    
    Specified by:
    
    getSequenceId in interface Cell
    
    Specified by:
    
    getSequenceId in interface ExtendedCell
    
    Returns:
    
    seqId (always > 0 if exists), or 0 if it no longer exists
  - getValueArray
```
public byte[] getValueArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes that may start at any index in the containing array. Max length is Integer.MAX_VALUE which is 2,147,483,647 bytes.
    
    Specified by:
    
    getValueArray in interface Cell
    
    Returns:
    
    The array containing the value bytes.
  - getValueOffset
```
public int getValueOffset()
```
    Description copied from interface: Cell
    
    Returns Array index of first value byte
    
    Specified by:
    
    getValueOffset in interface Cell
  - getValueLength
```
public int getValueLength()
```
    Description copied from interface: Cell
    
    Returns Number of value bytes. Must be < valueArray.length - offset.
    
    Specified by:
    
    getValueLength in interface Cell
  - getTagsArray
```
public byte[] getTagsArray()
```
    Description copied from interface: ExtendedCell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    Specified by:
    
    getTagsArray in interface Cell
    
    Specified by:
    
    getTagsArray in interface ExtendedCell
    
    Returns:
    
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Description copied from interface: ExtendedCell
    
    Returns the first offset where the tags start in the Cell
    
    Specified by:
    
    getTagsOffset in interface Cell
    
    Specified by:
    
    getTagsOffset in interface ExtendedCell
  - getTagsLength
```
public int getTagsLength()
```
    Description copied from interface: ExtendedCell
    
    HBase internally uses 2 bytes to store tags length in Cell. As the tags length is always a non-negative number, to make good use of the sign bit, the max of tags length is defined 2 * Short.MAX_VALUE + 1 = 65535. As a result, the return type is int, because a short is not capable of handling that. Please note that even if the return type is int, the max tags length is far less than Integer.MAX_VALUE.
    
    Specified by:
    
    getTagsLength in interface Cell
    
    Specified by:
    
    getTagsLength in interface ExtendedCell
    
    Returns:
    
    the total length of the tags in the Cell.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setSequenceId
```
public void setSequenceId(long seqId)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given seqId.
    
    Specified by:
    
    setSequenceId in interface ExtendedCell
    
    Parameters:
    
    seqId - sequence ID
  - heapSize
```
public long heapSize()
```
    Description copied from interface: HeapSize
    
    Return the approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.
    
    Specified by:
    
    heapSize in interface HeapSize
  - write
```
public int write(OutputStream out,
                 boolean withTags)
          throws IOException
```
    Description copied from interface: ExtendedCell
    
    Write this cell to an OutputStream in a KeyValue format.
    KeyValue format
    <4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> <tags>
    
    Specified by:
    
    write in interface ExtendedCell
    
    Parameters:
    
    out - Stream to which cell has to be written
    
    withTags - Whether to write tags.
    
    Returns:
    
    how many bytes are written. n
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize(boolean withTags)
```
    Description copied from interface: ExtendedCell
    
    KeyValue format
    <4 bytes keylength> <4 bytes valuelength> <2 bytes rowlength> <row> <1 byte columnfamilylength> <columnfamily> <columnqualifier> <8 bytes timestamp> <1 byte keytype> <value> <2 bytes tagslength> <tags>
    
    Specified by:
    
    getSerializedSize in interface ExtendedCell
    
    Parameters:
    
    withTags - Whether to write tags.
    
    Returns:
    
    Bytes count required to serialize this Cell in a KeyValue format.
  - write
```
public void write(ByteBuffer buf,
                  int offset)
```
    Description copied from interface: ExtendedCell
    
    Write this Cell into the given buf's offset in a KeyValue format.
    
    Specified by:
    
    write in interface ExtendedCell
    
    Parameters:
    
    buf - The buffer where to write the Cell.
    
    offset - The offset within buffer, to write the Cell.
  - setTimestamp
```
public void setTimestamp(long ts)
                  throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - timestamp
    
    Throws:
    
    IOException
  - setTimestamp
```
public void setTimestamp(byte[] ts)
                  throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - buffer containing the timestamp value
    
    Throws:
    
    IOException
  - deepClone
```
public ExtendedCell deepClone()
```
    Description copied from interface: ExtendedCell
    
    Does a deep copy of the contents to a new memory area and returns it as a new cell.
    
    Specified by:
    
    deepClone in interface ExtendedCell
    
    Returns:
    
    The deep cloned cell

Class BufferedDataBlockEncoder.OnheapDecodedCell

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Cell

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.ExtendedCell

Fields inherited from interface org.apache.hadoop.hbase.RawCell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.ExtendedCell

Methods inherited from interface org.apache.hadoop.hbase.RawCell

Methods inherited from interface org.apache.hadoop.hbase.Cell

Field Detail

FIXED_OVERHEAD

keyOnlyBuffer

rowLength

familyOffset

familyLength

qualifierOffset

qualifierLength

timeStamp

typeByte

valueBuffer

valueOffset

valueLength

tagsBuffer

tagsOffset

tagsLength

seqId

Constructor Detail

OnheapDecodedCell

Method Detail

getRowArray

getFamilyArray

getQualifierArray

getRowOffset

getRowLength

getFamilyOffset

getFamilyLength

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

toString

setSequenceId

heapSize

write

getSerializedSize

write

setTimestamp

setTimestamp

deepClone