TagRewriteCell (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

Cell, HeapSize, SettableSequenceId, SettableTimestamp
```
@InterfaceAudience.Private
public class TagRewriteCell
extends Object
implements Cell, SettableSequenceId, SettableTimestamp, HeapSize
```
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.

Field Summary

Fields
Modifier and Type Field and Description

private Cell cell

private byte[] tags

Fields
Modifier and Type	Field and Description
`private Cell`	`cell`
`private byte[]`	`tags`

Constructor Summary

Constructors
Constructor and Description

TagRewriteCell(Cell cell, byte[] tags)

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

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`getFamily()` Deprecated.
`byte[]`	`getFamilyArray()` Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
`byte`	`getFamilyLength()`
`int`	`getFamilyOffset()`
`long`	`getMvccVersion()` Deprecated.
`byte[]`	`getQualifier()` Deprecated.
`byte[]`	`getQualifierArray()` Contiguous raw bytes that may start at any index in the containing array.
`int`	`getQualifierLength()`
`int`	`getQualifierOffset()`
`byte[]`	`getRow()` Deprecated.
`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.
`byte[]`	`getTagsArray()`
`int`	`getTagsLength()`
`int`	`getTagsOffset()`
`long`	`getTimestamp()`
`byte`	`getTypeByte()`
`byte[]`	`getValue()` Deprecated.
`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, int tsOffset)` Sets with the given timestamp.
`void`	`setTimestamp(long ts)` Sets with the given timestamp.

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

- Field Detail
  - cell
```
private Cell cell
```
  - tags
```
private byte[] tags
```
- 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
    
    Returns:
    The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
  - getMvccVersion
```
@Deprecated
public long getMvccVersion()
```
    Deprecated.
    
    Specified by:
    
    getMvccVersion in interface Cell
    
    Returns:
    mvccVersion (always >= 0 if exists), or 0 if it no longer exists
  - getSequenceId
```
public long getSequenceId()
```
    Description copied from interface: Cell
    
    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
    
    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()
```
    Specified by:
    
    getTagsArray in interface Cell
    
    Returns:
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Specified by:
    
    getTagsOffset in interface Cell
    
    Returns:
    the first offset where the tags start in the Cell
  - getTagsLength
```
public int getTagsLength()
```
    Specified by:
    
    getTagsLength in interface Cell
    
    Returns:
    the total length of the tags in the Cell.
  - getValue
```
@Deprecated
public byte[] getValue()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's value. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getValue in interface Cell
  - getFamily
```
@Deprecated
public byte[] getFamily()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's family. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getFamily in interface Cell
  - getQualifier
```
@Deprecated
public byte[] getQualifier()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. This gets an arraycopy of the cell's qualifier. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getQualifier in interface Cell
  - getRow
```
@Deprecated
public byte[] getRow()
```
    Deprecated.
    
    Description copied from interface: Cell
    
    WARNING do not use, expensive. this gets an arraycopy of the cell's row. Added to ease transition from 0.94 -> 0.96.
    
    Specified by:
    
    getRow in interface 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: SettableTimestamp
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface SettableTimestamp
    
    Throws:
    
    IOException
  - setTimestamp
```
public void setTimestamp(byte[] ts,
                int tsOffset)
                  throws IOException
```
    Description copied from interface: SettableTimestamp
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface SettableTimestamp
    
    Parameters:
    ts - buffer containing the timestamp value
    tsOffset - offset to the new timestamp
    
    Throws:
    
    IOException
  - setSequenceId
```
public void setSequenceId(long seqId)
                   throws IOException
```
    Description copied from interface: SettableSequenceId
    
    Sets with the given seqId.
    
    Specified by:
    
    setSequenceId in interface SettableSequenceId
    
    Throws:
    
    IOException

Class TagRewriteCell

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cell

tags

Constructor Detail

TagRewriteCell

Method Detail

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getMvccVersion

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getValue

getFamily

getQualifier

getRow

heapSize

setTimestamp

setTimestamp

setSequenceId