KeyOnlyFilter.KeyOnlyCell (Apache HBase 2.5.0 API)

java.lang.Object
- org.apache.hadoop.hbase.filter.KeyOnlyFilter.KeyOnlyCell

All Implemented Interfaces:: Cell, HeapSize

Enclosing class:: KeyOnlyFilter

static class KeyOnlyFilter.KeyOnlyCell
extends Object
implements 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

private Cell cell

private int keyLen

private boolean lenAsVal

Fields
Modifier and Type	Field and Description
`private Cell`	`cell`
`private int`	`keyLen`
`private boolean`	`lenAsVal`

Constructor Summary

Constructors
Constructor and Description

KeyOnlyCell(Cell c, boolean lenAsVal)

Constructors
Constructor and Description
`KeyOnlyCell(Cell c, boolean lenAsVal)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Returns Serialized size (defaults to include tag length if has some 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()` Return 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.
`Cell.Type`	`getType()` Returns the type of cell in a human readable format using `Cell.Type`.
`byte`	`getTypeByte()` Return 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.

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

- Field Detail
  - cell
```
private Cell cell
```
  - keyLen
```
private int keyLen
```
  - lenAsVal
```
private boolean lenAsVal
```
- Constructor Detail
  - KeyOnlyCell
```
public KeyOnlyCell(Cell c,
                   boolean lenAsVal)
```
- 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()
```
    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: Cell
    
    Return the byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc
    
    Specified by:
    
    getTypeByte in interface Cell
  - getType
```
public Cell.Type getType()
```
    Description copied from interface: Cell
    
    Returns the type of cell in a human readable format using Cell.Type. Note : This does not expose the internal types of Cells like KeyValue.Type.Maximum and KeyValue.Type.Minimum
    
    Specified by:
    
    getType in interface Cell
    
    Returns:
    
    The data type this cell: one of Put, Delete, etc
  - 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()
```
    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
  - getSerializedSize
```
public int getSerializedSize()
```
    Description copied from interface: Cell
    
    Returns Serialized size (defaults to include tag length if has some tags).
    
    Specified by:
    
    getSerializedSize in interface Cell
  - getTagsArray
```
public byte[] getTagsArray()
```
    Description copied from interface: Cell
    
    Contiguous raw bytes representing tags that may start at any index in the containing array.
    
    Specified by:
    
    getTagsArray in interface Cell
    
    Returns:
    
    the tags byte array
  - getTagsOffset
```
public int getTagsOffset()
```
    Description copied from interface: Cell
    
    Return the first offset where the tags start in the Cell
    
    Specified by:
    
    getTagsOffset in interface Cell
  - getTagsLength
```
public int getTagsLength()
```
    Description copied from interface: Cell
    
    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
    
    Returns:
    
    the total length of the tags in the Cell.
  - 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 KeyOnlyFilter.KeyOnlyCell

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cell

keyLen

lenAsVal

Constructor Detail

KeyOnlyCell

Method Detail

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getTimestamp

getTypeByte

getType

getSequenceId

getValueArray

getValueOffset

getValueLength

getSerializedSize

getTagsArray

getTagsOffset

getTagsLength

heapSize