Mutation.CellWrapper (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.client.Mutation.CellWrapper

All Implemented Interfaces:: Cell, ExtendedCell, HeapSize, RawCell

Enclosing class:: Mutation

private static final class Mutation.CellWrapper
extends Object
implements ExtendedCell

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 Cell cell

private static long FIXED_OVERHEAD

private long sequenceId

private long timestamp
- 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
`private Cell`	`cell`
`private static long`	`FIXED_OVERHEAD`
`private long`	`sequenceId`
`private long`	`timestamp`

Constructor Summary

Constructors
Constructor and Description

CellWrapper(Cell cell)

Constructors
Constructor and Description
`CellWrapper(Cell cell)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`cloneTags()` Allows cloning the tags in the cell to a new byte[]
`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.
`Optional<Tag>`	`getTag(byte type)` Returns the specific tag of the given type
`Iterator<Tag>`	`getTags()` Creates a list of tags in the current cell
`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
`private long`	`heapOverhead()`
`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.

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
deepClone, getChunkId, getSerializedSize, getSerializedSize, write, write

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

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

- Field Detail
  - FIXED_OVERHEAD
```
private static final long FIXED_OVERHEAD
```
  - cell
```
private final Cell cell
```
  - sequenceId
```
private long sequenceId
```
  - timestamp
```
private long timestamp
```
- Constructor Detail
  - CellWrapper
```
CellWrapper(Cell cell)
```
- Method Detail
  - 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
  - setTimestamp
```
public void setTimestamp(long ts)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - timestamp
  - setTimestamp
```
public void setTimestamp(byte[] ts)
```
    Description copied from interface: ExtendedCell
    
    Sets with the given timestamp.
    
    Specified by:
    
    setTimestamp in interface ExtendedCell
    
    Parameters:
    
    ts - buffer containing the timestamp value
  - 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.
  - 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()
```
    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
  - 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()
```
    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
  - 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()
```
    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
  - getTag
```
public Optional<Tag> getTag(byte type)
```
    Description copied from interface: RawCell
    
    Returns the specific tag of the given type
    
    Specified by:
    
    getTag in interface RawCell
    
    Parameters:
    
    type - the type of the tag
    
    Returns:
    
    the specific tag if available or null
  - getTags
```
public Iterator<Tag> getTags()
```
    Description copied from interface: RawCell
    
    Creates a list of tags in the current cell
    
    Specified by:
    
    getTags in interface RawCell
    
    Returns:
    
    a list of tags
  - cloneTags
```
public byte[] cloneTags()
```
    Description copied from interface: RawCell
    
    Allows cloning the tags in the cell to a new byte[]
    
    Specified by:
    
    cloneTags in interface RawCell
    
    Returns:
    
    the byte[] having the tags
  - heapOverhead
```
private long heapOverhead()
```
  - 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

Class Mutation.CellWrapper

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

cell

sequenceId

timestamp

Constructor Detail

CellWrapper

Method Detail

setSequenceId

setTimestamp

setTimestamp

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getTag

getTags

cloneTags

heapOverhead

heapSize