PrivateCellUtil.TagRewriteCell (Apache HBase 2.3.0 API)

java.lang.Object
- org.apache.hadoop.hbase.PrivateCellUtil.TagRewriteCell

All Implemented Interfaces:

Cell, ExtendedCell, HeapSize, RawCell

Direct Known Subclasses:

PrivateCellUtil.ValueAndTagRewriteCell

Enclosing class:

PrivateCellUtil
```
static class PrivateCellUtil.TagRewriteCell
extends Object
implements ExtendedCell
```
This can be used when a Cell has to change with addition/removal of one or more tags. This is an efficient way to do so in which only the tags bytes part need to recreated and copied. All other parts, refer to the original Cell.

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

protected Cell cell

private static int HEAP_SIZE_OVERHEAD

protected byte[] tags
- 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

Fields
Modifier and Type	Field and Description
`protected Cell`	`cell`
`private static int`	`HEAP_SIZE_OVERHEAD`
`protected byte[]`	`tags`

Constructor Summary

Constructors
Constructor and Description

TagRewriteCell(Cell cell, byte[] tags)

Constructors
Constructor and Description
`TagRewriteCell(Cell cell, byte[] tags)`

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()`
`int`	`getFamilyOffset()`
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()`
`int`	`getQualifierOffset()`
`byte[]`	`getRowArray()` Contiguous raw bytes that may start at any index in the containing array.
`short`	`getRowLength()`
`int`	`getRowOffset()`
`long`	`getSequenceId()` A region-specific unique monotonically increasing sequence ID given to each Cell.
`int`	`getSerializedSize(boolean withTags)`
`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()`
`long`	`getTimestamp()`
`byte`	`getTypeByte()`
`byte[]`	`getValueArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getValueLength()`
`int`	`getValueOffset()`
`long`	`heapSize()`
`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.
`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, toString, 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, getTag, getTags

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

- Field Detail
  - cell
```
protected Cell cell
```
  - tags
```
protected byte[] tags
```
  - HEAP_SIZE_OVERHEAD
```
private static final int HEAP_SIZE_OVERHEAD
```
- Constructor Detail
  - TagRewriteCell
```
public TagRewriteCell(Cell cell,
                      byte[] tags)
```
    Parameters:
    
    cell - The original Cell which it rewrites
    
    tags - the tags bytes. The array suppose to contain the tags bytes alone.
- 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.
  - getRowOffset
```
public int getRowOffset()
```
    Specified by:
    
    getRowOffset in interface Cell
    
    Returns:
    
    Array index of first row byte
  - getRowLength
```
public short getRowLength()
```
    Specified by:
    
    getRowLength in interface Cell
    
    Returns:
    
    Number of row bytes. Must be < rowArray.length - offset.
  - 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.
  - getFamilyOffset
```
public int getFamilyOffset()
```
    Specified by:
    
    getFamilyOffset in interface Cell
    
    Returns:
    
    Array index of first family byte
  - getFamilyLength
```
public byte getFamilyLength()
```
    Specified by:
    
    getFamilyLength in interface Cell
    
    Returns:
    
    Number of family bytes. Must be < familyArray.length - offset.
  - 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.
  - getQualifierOffset
```
public int getQualifierOffset()
```
    Specified by:
    
    getQualifierOffset in interface Cell
    
    Returns:
    
    Array index of first qualifier byte
  - getQualifierLength
```
public int getQualifierLength()
```
    Specified by:
    
    getQualifierLength in interface Cell
    
    Returns:
    
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
  - getTimestamp
```
public long getTimestamp()
```
    Specified by:
    
    getTimestamp in interface Cell
    
    Returns:
    
    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.
  - getTypeByte
```
public byte getTypeByte()
```
    Specified by:
    
    getTypeByte in interface Cell
    
    Specified by:
    
    getTypeByte in interface ExtendedCell
    
    Returns:
    
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - 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()
```
    Specified by:
    
    getValueOffset in interface Cell
    
    Returns:
    
    Array index of first value byte
  - getValueLength
```
public int getValueLength()
```
    Specified by:
    
    getValueLength in interface Cell
    
    Returns:
    
    Number of value bytes. Must be < valueArray.length - offset.
  - 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()
```
    Specified by:
    
    getTagsOffset in interface Cell
    
    Specified by:
    
    getTagsOffset in interface ExtendedCell
    
    Returns:
    
    the first offset where the tags start in the Cell
  - 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.
  - heapSize
```
public long heapSize()
```
    Specified by:
    
    heapSize in interface HeapSize
    
    Returns:
    
    Approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.
  - 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
  - setSequenceId
```
public void setSequenceId(long seqId)
                   throws IOException
```
    Description copied from interface: ExtendedCell
    
    Sets with the given seqId.
    
    Specified by:
    
    setSequenceId in interface ExtendedCell
    
    Parameters:
    
    seqId - sequence ID
    
    Throws:
    
    IOException
  - 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.
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize(boolean withTags)
```
    Specified by:
    
    getSerializedSize in interface ExtendedCell
    
    Parameters:
    
    withTags - Whether to write tags.
    
    Returns:
    
    Bytes count required to serialize this Cell 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>
  - 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.
  - 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 PrivateCellUtil.TagRewriteCell

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

cell

tags

HEAP_SIZE_OVERHEAD

Constructor Detail

TagRewriteCell

Method Detail

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

heapSize

setTimestamp

setTimestamp

setSequenceId

write

getSerializedSize

write

deepClone