ByteBufferedCell (Apache HBase 2.0.0-SNAPSHOT API)

Frames

Frames

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

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

-
-
All Implemented Interfaces:
-
Cell
-
-
-
Direct Known Subclasses:
-
BufferedDataBlockEncoder.OffheapDecodedCell, ByteBufferedKeyOnlyKeyValue, CellUtil.EmptyByteBufferedCell, KeyOnlyFilter.KeyOnlyByteBufferedCell, OffheapKeyValue, P refixTreeCell, PrefixTreeSeeker.OffheapPrefixTreeCell
-
-
-
-
```
@InterfaceAudience.Private
-public abstract class ByteBufferedCell
-extends Object
-implements Cell
```
-
This class is a server side extension to the Cell interface. It is used when the - Cell is backed by a ByteBuffer: i.e. cell instanceof ByteBufferedCell. - -
This class has getters for the row, column family, column qualifier, value and tags hosting - ByteBuffers. It also has getters of the *position* within a ByteBuffer where these - field bytes begin. These are needed because a single ByteBuffer may back one or many Cell - instances -- it depends on the implementation -- so the ByteBuffer position as returned by - ByteBuffer.arrayOffset() cannot be relied upon. Also, do not confuse these position - methods with the getXXXOffset methods from the super Interface, Cell; dependent up on - implementation, the Cell getXXXOffset methods can return the same value as a call to its - equivalent position method from below BUT they can also stray; if a ByteBufferedCell, use the - below position methods to find where a field begins. - -
Use the getXXXLength methods from Cell to find a fields length. - -
A Cell object can be of this type only on the server side. - -
WARNING: If a Cell is backed by an offheap ByteBuffer, any call to getXXXArray() will result - in a temporary byte array creation and a bytes copy. Avoid these allocations by using the - appropriate Cell access server-side: i.e. ByteBufferedCell when backed by a ByteBuffer and Cell - when it is not.
-

- -

- - -
Constructor Summary
- - - - - - - - -
Constructors
Constructor and Description
ByteBufferedCell()
-

Constructors
Constructor and Description
`ByteBufferedCell()`

- -

- - -

Method Summary

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract ByteBuffer`	`getFamilyByteBuffer()`
`abstract int`	`getFamilyPosition()`
`abstract ByteBuffer`	`getQualifierByteBuffer()`
`abstract int`	`getQualifierPosition()`
`abstract ByteBuffer`	`getRowByteBuffer()`
`abstract int`	`getRowPosition()`
`abstract ByteBuffer`	`getTagsByteBuffer()`
`abstract int`	`getTagsPosition()`
`abstract ByteBuffer`	`getValueByteBuffer()`
`abstract int`	`getValuePosition()`

- - -
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.Cell
-getFamilyArray, getFamilyLength, getFamilyOffset, getQualifierArray, getQualifierLength, getQualifierOffset, getRowArray, getRowLength, getRowOffset, getSequenceId, getTagsArray, getTagsLength, getTagsOffset, getTimestamp, getTypeByte, getValueArray, getValueLength, getValueOffset

- -
- - - -
  Constructor Detail
  - - - -
  - -
    ByteBufferedCell
    -
```
public ByteBufferedCell()
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    getRowByteBuffer
    -
```
public abstract ByteBuffer getRowByteBuffer()
```
    -
    -
    Returns:
    -
    The ByteBuffer containing the row bytes.
    -
    -
  - - - -
  - -
    getRowPosition
    -
```
public abstract int getRowPosition()
```
    -
    -
    Returns:
    -
    Position in the ByteBuffer where row bytes start
    -
    -
  - - - -
  - -
    getFamilyByteBuffer
    -
```
public abstract ByteBuffer getFamilyByteBuffer()
```
    -
    -
    Returns:
    -
    The ByteBuffer containing the column family bytes.
    -
    -
  - - - -
  - -
    getFamilyPosition
    -
```
public abstract int getFamilyPosition()
```
    -
    -
    Returns:
    -
    Position in the ByteBuffer where column family bytes start
    -
    -
  - - - -
  - -
    getQualifierByteBuffer
    -
```
public abstract ByteBuffer getQualifierByteBuffer()
```
    -
    -
    Returns:
    -
    The ByteBuffer containing the column qualifier bytes.
    -
    -
  - - - -
  - -
    getQualifierPosition
    -
```
public abstract int getQualifierPosition()
```
    -
    -
    Returns:
    -
    Position in the ByteBuffer where column qualifier bytes start
    -
    -
  - - - -
  - -
    getValueByteBuffer
    -
```
public abstract ByteBuffer getValueByteBuffer()
```
    -
    -
    Returns:
    -
    The ByteBuffer containing the value bytes.
    -
    -
  - - - -
  - -
    getValuePosition
    -
```
public abstract int getValuePosition()
```
    -
    -
    Returns:
    -
    Position in the ByteBuffer where value bytes start
    -
    -
  - - - -
  - -
    getTagsByteBuffer
    -
```
public abstract ByteBuffer getTagsByteBuffer()
```
    -
    -
    Returns:
    -
    The ByteBuffer containing the tag bytes.
    -
    -
  - - - -
  - -
    getTagsPosition
    -
```
public abstract int getTagsPosition()
```
    -
    -
    Returns:
    -
    Position in the ByteBuffer where tag bytes start
    -
    -
  -
-

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

ByteBufferedKeyOnlyKeyValue (Apache HBase 2.0.0-SNAPSHOT API)

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

java.lang.Object
-
- org.apache.hadoop.hbase.ByteBufferedCell
- -
  - org.apache.hadoop.hbase.ByteBufferedKeyOnlyKeyValue
  -
-

-
-
All Implemented Interfaces:
-
Cell
-
-
-
-
```
@InterfaceAudience.Private
-public class ByteBufferedKeyOnlyKeyValue
-extends ByteBufferedCell
```
-
This is a key only Cell implementation which is identical to KeyValue.KeyOnlyKeyValue - with respect to key serialization but have its data in the form of Byte buffer - (onheap and offheap).
-

- -

- - -
Field Summary
- - - - - - - - - - - - - - - - - - - - - - -
Fields
Modifier and Type Field and Description
private ByteBuffer buf
private int length
private int offset
private short rowLen
-

Fields
Modifier and Type	Field and Description
`private ByteBuffer`	`buf`
`private int`	`length`
`private int`	`offset`
`private short`	`rowLen`

- -

- - -

Constructor Summary

- - - - - - - - - - - -

Constructors
Constructor and Description
`ByteBufferedKeyOnlyKeyValue()` - Used in cases where we want to avoid lot of garbage by allocating new objects with different - keys. -
`ByteBufferedKeyOnlyKeyValue(ByteBuffer buf, - int offset, - int length)`

- -

- - -

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. -
`ByteBuffer`	`getFamilyByteBuffer()`
`byte`	`getFamilyLength()`
`private byte`	`getFamilyLength(int famLenPos)`
`private int`	`getFamilyLengthPosition()`
`int`	`getFamilyOffset()`
`int`	`getFamilyPosition()`
`byte[]`	`getQualifierArray()` - Contiguous raw bytes that may start at any index in the containing array. -
`ByteBuffer`	`getQualifierByteBuffer()`
`int`	`getQualifierLength()`
`private int`	`getQualifierLength(int rlength, - int flength)`
`int`	`getQualifierOffset()`
`int`	`getQualifierPosition()`
`byte[]`	`getRowArray()` - Contiguous raw bytes that may start at any index in the containing array. -
`ByteBuffer`	`getRowByteBuffer()`
`short`	`getRowLength()`
`int`	`getRowOffset()`
`int`	`getRowPosition()`
`long`	`getSequenceId()` - A region-specific unique monotonically increasing sequence ID given to each Cell. -
`byte[]`	`getTagsArray()`
`ByteBuffer`	`getTagsByteBuffer()`
`int`	`getTagsLength()`
`int`	`getTagsOffset()`
`int`	`getTagsPosition()`
`long`	`getTimestamp()`
`private int`	`getTimestampOffset()`
`byte`	`getTypeByte()`
`byte[]`	`getValueArray()` - Contiguous raw bytes that may start at any index in the containing array. -
`ByteBuffer`	`getValueByteBuffer()`
`int`	`getValueLength()`
`int`	`getValueOffset()`
`int`	`getValuePosition()`
`void`	`setKey(ByteBuffer key, - int offset, - int length)` - A setter that helps to avoid object creation every time and whenever - there is a need to create new OffheapKeyOnlyKeyValue. -
`String`	`toString()`

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

- -
- - - -
  Field Detail
  - - - -
  - -
    buf
    -
```
private ByteBuffer buf
```
    -
  - - - -
  - -
    offset
    -
```
private int offset
```
    -
  - - - -
  - -
    length
    -
```
private int length
```
    -
  - - - -
  - -
    rowLen
    -
```
private short rowLen
```
    -
  -
- -
- - - -
  Constructor Detail
  - - - -
  - -
    ByteBufferedKeyOnlyKeyValue
    -
```
public ByteBufferedKeyOnlyKeyValue()
```
    -
    Used in cases where we want to avoid lot of garbage by allocating new objects with different - keys. Use the emtpy construtor and set the keys using setKey(ByteBuffer, int, int)
    -
  - - - -
  - -
    ByteBufferedKeyOnlyKeyValue
    -
```
public ByteBufferedKeyOnlyKeyValue(ByteBuffer buf,
-                                   int offset,
-                                   int length)
```
    -
  -
- -
- - - -
  Method Detail
  - - - -
  - -
    setKey
    -
```
public void setKey(ByteBuffer key,
-                   int offset,
-                   int length)
```
    -
    A setter that helps to avoid object creation every time and whenever - there is a need to create new OffheapKeyOnlyKeyValue.
    -
    -
    Parameters:
    -
    key -
    -
    offset -
    -
    length -
    -
    -
  - - - -
  - -
    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.
    -
    -
    Returns:
    -
    The array containing the row bytes.
    -
    -
  - - - -
  - -
    getRowOffset
    -
```
public int getRowOffset()
```
    -
    -
    Returns:
    -
    Array index of first row byte
    -
    -
  - - - -
  - -
    getRowLength
    -
```
public short getRowLength()
```
    -
    -
    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.
    -
    -
    Returns:
    -
    the array containing the family bytes.
    -
    -
  - - - -
  - -
    getFamilyOffset
    -
```
public int getFamilyOffset()
```
    -
    -
    Returns:
    -
    Array index of first family byte
    -
    -
  - - - -
  - -
    getFamilyLength
    -
```
public byte getFamilyLength()
```
    -
    -
    Returns:
    -
    Number of family bytes. Must be < familyArray.length - offset.
    -
    -
  - - - -
  - -
    getFamilyLength
    -
```
private byte getFamilyLength(int famLenPos)
```
    -
  - - - -
  - -
    getQualifierArray
    -
```
public byte[] getQualifierArray()
```
    -
    Description copied from interface: Cell
    -
    Contiguous raw bytes that may start at any index in the containing array.
    -
    -
    Returns:
    -
    The array containing the qualifier bytes.
    -
    -
  - - - -
  - -
    getQualifierOffset
    -
```
public int getQualifierOffset()
```
    -
    -
    Returns:
    -
    Array index of first qualifier byte
    -
    -
  - - - -
  - -
    getQualifierLength
    -
```
public int getQualifierLength()
```
    -
    -
    Returns:
    -
    Number of qualifier bytes. Must be < qualifierArray.length - offset.
    -
    -
  - - - -
  - -
    getQualifierLength
    -
```
private int getQualifierLength(int rlength,
-                               int flength)
```
    -
  - - - -
  - -
    getTimestamp
    -
```
public long getTimestamp()
```
    -
    -
    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.
    -
    -
  - - - -
  - -
    getTimestampOffset
    -
```
private int getTimestampOffset()
```
    -
  - - - -
  - -
    getTypeByte
    -
```
public byte getTypeByte()
```
    -
    -
    Returns:
    -
    The byte representation of the KeyValue.TYPE of 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.
    -
    -
    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.
    -
    -
    Returns:
    -
    The array containing the value bytes.
    -
    -
  - - - -
  - -
    getValueOffset
    -
```
public int getValueOffset()
```
    -
    -
    Returns:
    -
    Array index of first value byte
    -
    -
  - - - -
  - -
    getValueLength
    -
```
public int getValueLength()
```
    -
    -
    Returns:
    -
    Number of value bytes. Must be < valueArray.length - offset.
    -
    -
  - - - -
  - -
    getTagsArray
    -
```
public byte[] getTagsArray()
```
    -
    -
    Returns:
    -
    the tags byte array
    -
    -
  - - - -
  - -
    getTagsOffset
    -
```
public int getTagsOffset()
```
    -
    -
    Returns:
    -
    the first offset where the tags start in the Cell
    -
    -
  - - - -
  - -
    getTagsLength
    -
```
public int getTagsLength()
```
    -
    -
    Returns:
    -
    the total length of the tags in the Cell.
    -
    -
  - - - -
  - -
    getRowByteBuffer
    -
```
public ByteBuffer getRowByteBuffer()
```
    -
    -
    Specified by:
    -
    getRowByteBuffer in class ByteBufferedCell
    -
    Returns:
    -
    The ByteBuffer containing the row bytes.
    -
    -
  - - - -
  - -
    getRowPosition
    -
```
public int getRowPosition()
```
    -
    -
    Specified by:
    -
    getRowPosition in class ByteBufferedCell
    -
    Returns:
    -
    Position in the ByteBuffer where row bytes start
    -
    -
  - - - -
  - -
    getFamilyByteBuffer
    -
```
public ByteBuffer getFamilyByteBuffer()
```
    -
    -
    Specified by:
    -
    getFamilyByteBuffer in class ByteBufferedCell
    -
    Returns:
    -
    The ByteBuffer containing the column family bytes.
    -
    -
  - - - -
  - -
    getFamilyPosition
    -
```
public int getFamilyPosition()
```
    -
    -
    Specified by:
    -
    getFamilyPosition in class ByteBufferedCell
    -
    Returns:
    -
    Position in the ByteBuffer where column family bytes start
    -
    -
  - - - -
  - -
    getFamilyLengthPosition
    -
```
private int getFamilyLengthPosition()
```
    -
  - - - -
  - -
    getQualifierByteBuffer
    -
```
public ByteBuffer getQualifierByteBuffer()
```
    -
    -
    Specified by:
    -
    getQualifierByteBuffer in class ByteBufferedCell
    -
    Returns:
    -
    The ByteBuffer containing the column qualifier bytes.
    -
    -
  - - - -
  - -
    getQualifierPosition
    -
```
public int getQualifierPosition()
```
    -
    -
    Specified by:
    -
    getQualifierPosition in class ByteBufferedCell
    -
    Returns:
    -
    Position in the ByteBuffer where column qualifier bytes start
    -
    -
  - - - -
  - -
    getValueByteBuffer
    -
```
public ByteBuffer getValueByteBuffer()
```
    -
    -
    Specified by:
    -
    getValueByteBuffer in class ByteBufferedCell
    -
    Returns:
    -
    The ByteBuffer containing the value bytes.
    -
    -
  - - - -
  - -
    getValuePosition
    -
```
public int getValuePosition()
```
    -
    -
    Specified by:
    -
    getValuePosition in class ByteBufferedCell
    -
    Returns:
    -
    Position in the ByteBuffer where value bytes start
    -
    -
  - - - -
  - -
    getTagsByteBuffer
    -
```
public ByteBuffer getTagsByteBuffer()
```
    -
    -
    Specified by:
    -
    getTagsByteBuffer in class ByteBufferedCell
    -
    Returns:
    -
    The ByteBuffer containing the tag bytes.
    -
    -
  - - - -
  - -
    getTagsPosition
    -
```
public int getTagsPosition()
```
    -
    -
    Specified by:
    -
    getTagsPosition in class ByteBufferedCell
    -
    Returns:
    -
    Position in the ByteBuffer where tag bytes start
    -
    -
  - - - -
  - -
    toString
    -
```
public String toString()
```
    -
    -
    Overrides:
    -
    toString in class Object
    -
    -
  -
-

- - -

Skip navigation links

- - - -

Prev Class
Next Class

Frames
No Frames

All Classes

- -

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

- - -

Class ByteBufferedCell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBufferedCell

Method Detail

getRowByteBuffer

getRowPosition

getFamilyByteBuffer

getFamilyPosition

getQualifierByteBuffer

getQualifierPosition

getValueByteBuffer

getValuePosition

getTagsByteBuffer

getTagsPosition

Class ByteBufferedKeyOnlyKeyValue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buf

offset

length

rowLen

Constructor Detail

ByteBufferedKeyOnlyKeyValue

ByteBufferedKeyOnlyKeyValue

Method Detail

setKey

getRowArray

getRowOffset

getRowLength

getFamilyArray

getFamilyOffset

getFamilyLength

getFamilyLength

getQualifierArray

getQualifierOffset

getQualifierLength

getQualifierLength

getTimestamp

getTimestampOffset

getTypeByte

getSequenceId

getValueArray

getValueOffset

getValueLength

getTagsArray

getTagsOffset

getTagsLength

getRowByteBuffer

getRowPosition

getFamilyByteBuffer

getFamilyPosition

getFamilyLengthPosition

getQualifierByteBuffer

getQualifierPosition

getValueByteBuffer

getValuePosition

getTagsByteBuffer

getTagsPosition

toString