org.apache.hadoop.hbase

Class IndividualBytesFieldCell

java.lang.Object

org.apache.hadoop.hbase.IndividualBytesFieldCell

All Implemented Interfaces:

Cloneable, Cell, ExtendedCell, HeapSize, RawCell

@InterfaceAudience.Private
public class IndividualBytesFieldCell
extends Object
implements ExtendedCell, Cloneable

Nested Class Summary

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

Cell.Type

Field Summary

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

Constructor Summary

Constructors

Constructor and Description
IndividualBytesFieldCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value)
IndividualBytesFieldCell(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, long seqId, byte[] value, byte[] tags)
IndividualBytesFieldCell(byte[] row, int rOffset, int rLength, byte[] family, int fOffset, int fLength, byte[] qualifier, int qOffset, int qLength, long timestamp, KeyValue.Type type, long seqId, byte[] value, int vOffset, int vLength, byte[] tags, int tagsOffset, int tagsLength)

Method Summary

Modifier and Type	Method and Description
Object	clone() Implement Cloneable interface
byte[]	getFamilyArray() Contiguous bytes composed of legal HDFS filename characters which may start at any index in the containing array.
byte	getFamilyLength()
int	getFamilyOffset()
byte[]	getQualifierArray() Contiguous raw bytes that may start at any index in the containing array.
int	getQualifierLength()
int	getQualifierOffset()
byte[]	getRowArray() Implement Cell interface
short	getRowLength()
int	getRowOffset()
long	getSequenceId() A region-specific unique monotonically increasing sequence ID given to each 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()
long	getTimestamp()
byte	getTypeByte()
byte[]	getValueArray() Contiguous raw bytes that may start at any index in the containing array.
int	getValueLength()
int	getValueOffset()
long	heapSize() Implement HeapSize interface
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.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, 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, cloneTags, getTag, getTags

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

getType

Constructor Detail

IndividualBytesFieldCell

public IndividualBytesFieldCell(byte[] row,
                                byte[] family,
                                byte[] qualifier,
                                long timestamp,
                                KeyValue.Type type,
                                byte[] value)

IndividualBytesFieldCell

public IndividualBytesFieldCell(byte[] row,
                                byte[] family,
                                byte[] qualifier,
                                long timestamp,
                                KeyValue.Type type,
                                long seqId,
                                byte[] value,
                                byte[] tags)

IndividualBytesFieldCell

public IndividualBytesFieldCell(byte[] row,
                                int rOffset,
                                int rLength,
                                byte[] family,
                                int fOffset,
                                int fLength,
                                byte[] qualifier,
                                int qOffset,
                                int qLength,
                                long timestamp,
                                KeyValue.Type type,
                                long seqId,
                                byte[] value,
                                int vOffset,
                                int vLength,
                                byte[] tags,
                                int tagsOffset,
                                int tagsLength)

Method Detail

getRowArray

public byte[] getRowArray()

Implement Cell interface

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

Specified by:

getTypeByte in interface ExtendedCell

Returns:

The byte representation of the KeyValue.TYPE of this cell: one of Put, Delete, etc

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()

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()

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()

Specified by:

getTagsOffset in interface Cell

Specified by:

getTagsOffset in interface ExtendedCell

Returns:

the first offset where the tags start in the Cell

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.

heapSize

public long heapSize()

Implement HeapSize interface

Specified by:

heapSize in interface HeapSize

Returns:

Approximate 'exclusive deep size' of implementing object. Includes count of payload and hosting object sizings.

clone

public Object clone()
             throws CloneNotSupportedException

Implement Cloneable interface

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

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

toString

public String toString()

Overrides:

toString in class Object