org.apache.hadoop.hbase

Interface ExtendedCell

All Superinterfaces:

Cell, Cloneable, HeapSize, SettableSequenceId, SettableTimestamp

All Known Implementing Classes:

ByteBufferKeyValue, IndividualBytesFieldCell, KeyValue, KeyValue.KeyOnlyKeyValue, NoTagsByteBufferKeyValue, NoTagsKeyValue, SizeCachedKeyValue, SizeCachedNoTagsKeyValue

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
public interface ExtendedCell
extends Cell, SettableSequenceId, SettableTimestamp, HeapSize, Cloneable

Extension to Cell with server side required functions. Server side Cell implementations must implement this.

See Also:

SettableSequenceId, SettableTimestamp

Field Summary

Fields

Modifier and Type	Field and Description
static int	CELL_NOT_BASED_ON_CHUNK

Method Summary

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.
default int	getChunkId() Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized chunks as in case of MemstoreLAB
int	getSerializedSize(boolean withTags)
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 interface org.apache.hadoop.hbase.Cell

getFamilyArray, getFamilyLength, getFamilyOffset, getQualifierArray, getQualifierLength, getQualifierOffset, getRowArray, getRowLength, getRowOffset, getSequenceId, getTagsArray, getTagsLength, getTagsOffset, getTimestamp, getTypeByte, getValueArray, getValueLength, getValueOffset

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

setSequenceId

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

setTimestamp, setTimestamp

Methods inherited from interface org.apache.hadoop.hbase.io.HeapSize

heapSize

Field Detail

CELL_NOT_BASED_ON_CHUNK

static final int CELL_NOT_BASED_ON_CHUNK

See Also:

Constant Field Values

Method Detail

write

int write(OutputStream out,
          boolean withTags)
   throws IOException

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>

Parameters:

out - Stream to which cell has to be written

withTags - Whether to write tags.

Returns:

how many bytes are written.

Throws:

IOException

getSerializedSize

int getSerializedSize(boolean withTags)

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

void write(ByteBuffer buf,
           int offset)

Write this Cell into the given buf's offset in a KeyValue format.

Parameters:

buf - The buffer where to write the Cell.

offset - The offset within buffer, to write the Cell.

deepClone

ExtendedCell deepClone()

Does a deep copy of the contents to a new memory area and returns it as a new cell.

Returns:

The deep cloned cell

getChunkId

default int getChunkId()

Extracts the id of the backing bytebuffer of this cell if it was obtained from fixed sized chunks as in case of MemstoreLAB

Returns:

the chunk id if the cell is backed by fixed sized Chunks, else return -1