Package org.apache.hadoop.hbase

Class KeyValue.KeyOnlyKeyValue

java.lang.Object

org.apache.hadoop.hbase.KeyValue

org.apache.hadoop.hbase.KeyValue.KeyOnlyKeyValue

All Implemented Interfaces:

Cloneable, Cell, ExtendedCell, HeapSize, RawCell

Enclosing class:

KeyValue

public static class KeyValue.KeyOnlyKeyValue
extends KeyValue

A simple form of KeyValue that creates a keyvalue with only the key part of the byte[] Mainly used in places where we need to compare two cells. Avoids copying of bytes In places like block index keys, we need to compare the key byte[] with a cell. Hence create a Keyvalue(aka Cell) that would help in comparing as two cells

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.KeyValue

KeyValue.KeyOnlyKeyValue, KeyValue.SamePrefixComparator<T>, KeyValue.Type

Field Summary

Fields

Modifier and Type	Field	Description
private short	rowLen

Fields inherited from class org.apache.hadoop.hbase.KeyValue

bytes, COLUMN_FAMILY_DELIM_ARRAY, COLUMN_FAMILY_DELIMITER, FAMILY_LENGTH_SIZE, FIXED_OVERHEAD, KEY_INFRASTRUCTURE_SIZE, KEY_LENGTH_SIZE, KEYVALUE_INFRASTRUCTURE_SIZE, KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE, length, LOWESTKEY, offset, ROW_KEY_OFFSET, ROW_LENGTH_SIZE, ROW_OFFSET, TAGS_LENGTH_SIZE, TIMESTAMP_SIZE, TIMESTAMP_TYPE_SIZE, TYPE_SIZE

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	Description
KeyOnlyKeyValue()
KeyOnlyKeyValue(byte[] b)
KeyOnlyKeyValue(byte[] b, int offset, int length)

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	equals(Object other)	Needed doing 'contains' on List.
byte[]	getFamilyArray()	Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)
byte	getFamilyLength()	Returns Family length
(package private) int	getFamilyLengthPosition(int rowLength)
int	getFamilyOffset()	Returns Family offset
byte[]	getKey()	Do not use unless you have to.
int	getKeyLength()	Returns Length of key portion.
int	getKeyOffset()	Returns Key offset in backing buffer..
byte[]	getQualifierArray()	Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)
int	getQualifierLength()	Returns Qualifier length
private int	getQualifierLength(int rlength, int flength)
int	getQualifierOffset()	Returns Qualifier offset
byte[]	getRowArray()	Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)
short	getRowLength()	Returns Row length
int	getRowOffset()	Returns Row offset
byte[]	getTagsArray()	Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)
int	getTagsLength()	Return the total length of the tag bytes
int	getTagsOffset()	Return the offset where the tag data starts.
long	getTimestamp()	Return the timestamp.
int	getTimestampOffset()	Returns Timestamp offset
byte	getTypeByte()	Returns KeyValue.TYPE byte representation
(package private) byte	getTypeByte(int keyLength)	Return the KeyValue.TYPE byte representation
byte[]	getValueArray()	Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)
int	getValueLength()	Returns Value length
int	getValueOffset()	Returns the value offset
int	hashCode()	In line with KeyValue.equals(Object), only uses the key portion, not the value.
long	heapSize()	HeapSize implementation
void	set(KeyValue.KeyOnlyKeyValue keyOnlyKeyValue)
void	setKey(byte[] key, int offset, int length)	A setter that helps to avoid object creation every time and whenever there is a need to create new KeyOnlyKeyValue.
String	toString()
int	write(OutputStream out, boolean withTags)	Write this cell to an OutputStream in a KeyValue format.

Methods inherited from class org.apache.hadoop.hbase.KeyValue

checkParameters, clone, create, create, createKeyOnly, deepClone, getBuffer, getDelimiter, getDelimiterInReverse, getFamilyLength, getFamilyOffset, getKeyDataStructureSize, getKeyString, getKeyValueDataStructureSize, getKeyValueDataStructureSize, getKeyValueDataStructureSize, getLength, getOffset, getQualifierLength, getQualifierOffset, getSequenceId, getSerializedSize, getSerializedSize, getTimestamp, humanReadableTimestamp, isLatestTimestamp, keyToString, keyToString, setSequenceId, setTimestamp, setTimestamp, shallowCopy, toStringMap, updateLatestStamp, write, write, writeByteArray

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

getChunkId, getType

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

cloneTags, getTag, getTags

Field Details

rowLen

private short rowLen

Constructor Details

KeyOnlyKeyValue

public KeyOnlyKeyValue()

KeyOnlyKeyValue

public KeyOnlyKeyValue(byte[] b)

KeyOnlyKeyValue

public KeyOnlyKeyValue(byte[] b,
 int offset,
 int length)

Method Details

set

public void set(KeyValue.KeyOnlyKeyValue keyOnlyKeyValue)

clear

public void clear()

getKeyOffset

public int getKeyOffset()

Description copied from class: KeyValue

Returns Key offset in backing buffer..

Overrides:

getKeyOffset in class KeyValue

setKey

public void setKey(byte[] key,
 int offset,
 int length)

A setter that helps to avoid object creation every time and whenever there is a need to create new KeyOnlyKeyValue.

Parameters:

key - Key to set

offset - Offset of the Key

length - length of the Key

getKey

public byte[] getKey()

Description copied from class: KeyValue

Do not use unless you have to. Used internally for compacting and testing. Use KeyValue.getRowArray(), KeyValue.getFamilyArray(), KeyValue.getQualifierArray(), and KeyValue.getValueArray() if accessing a KeyValue client-side.

Overrides:

getKey in class KeyValue

Returns:

Copy of the key portion only.

getRowArray

public byte[] getRowArray()

Description copied from class: KeyValue

Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)

Specified by:

getRowArray in interface Cell

Overrides:

getRowArray in class KeyValue

Returns:

The array containing the row bytes.

getRowOffset

public int getRowOffset()

Description copied from class: KeyValue

Returns Row offset

Specified by:

getRowOffset in interface Cell

Overrides:

getRowOffset in class KeyValue

getFamilyArray

public byte[] getFamilyArray()

Description copied from class: KeyValue

Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)

Specified by:

getFamilyArray in interface Cell

Overrides:

getFamilyArray in class KeyValue

Returns:

the array containing the family bytes.

getFamilyLength

public byte getFamilyLength()

Description copied from class: KeyValue

Returns Family length

Specified by:

getFamilyLength in interface Cell

Overrides:

getFamilyLength in class KeyValue

getFamilyLengthPosition

int getFamilyLengthPosition(int rowLength)

Overrides:

getFamilyLengthPosition in class KeyValue

getFamilyOffset

public int getFamilyOffset()

Description copied from class: KeyValue

Returns Family offset

Specified by:

getFamilyOffset in interface Cell

Overrides:

getFamilyOffset in class KeyValue

getQualifierArray

public byte[] getQualifierArray()

Description copied from class: KeyValue

Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)

Specified by:

getQualifierArray in interface Cell

Overrides:

getQualifierArray in class KeyValue

Returns:

The array containing the qualifier bytes.

getQualifierLength

public int getQualifierLength()

Description copied from class: KeyValue

Returns Qualifier length

Specified by:

getQualifierLength in interface Cell

Overrides:

getQualifierLength in class KeyValue

getQualifierOffset

public int getQualifierOffset()

Description copied from class: KeyValue

Returns Qualifier offset

Specified by:

getQualifierOffset in interface Cell

Overrides:

getQualifierOffset in class KeyValue

getKeyLength

public int getKeyLength()

Description copied from class: KeyValue

Returns Length of key portion.

Overrides:

getKeyLength in class KeyValue

getRowLength

public short getRowLength()

Description copied from class: KeyValue

Returns Row length

Specified by:

getRowLength in interface Cell

Overrides:

getRowLength in class KeyValue

getTypeByte

public byte getTypeByte()

Description copied from class: KeyValue

Returns KeyValue.TYPE byte representation

Specified by:

getTypeByte in interface ExtendedCell

Overrides:

getTypeByte in class KeyValue

getTypeByte

byte getTypeByte(int keyLength)

Description copied from class: KeyValue

Return the KeyValue.TYPE byte representation

Overrides:

getTypeByte in class KeyValue

getQualifierLength

private int getQualifierLength(int rlength,
 int flength)

getTimestamp

public long getTimestamp()

Description copied from class: KeyValue

Return the timestamp.

Specified by:

getTimestamp in interface Cell

Overrides:

getTimestamp in class KeyValue

getTimestampOffset

public int getTimestampOffset()

Description copied from class: KeyValue

Returns Timestamp offset

Overrides:

getTimestampOffset in class KeyValue

getTagsArray

public byte[] getTagsArray()

Description copied from class: KeyValue

Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)

Specified by:

getTagsArray in interface RawCell

Overrides:

getTagsArray in class KeyValue

Returns:

the tags byte array

getTagsOffset

public int getTagsOffset()

Description copied from class: KeyValue

Return the offset where the tag data starts.

Specified by:

getTagsOffset in interface RawCell

Overrides:

getTagsOffset in class KeyValue

getValueArray

public byte[] getValueArray()

Description copied from class: KeyValue

Returns the backing array of the entire KeyValue (all KeyValue fields are in a single array)

Specified by:

getValueArray in interface Cell

Overrides:

getValueArray in class KeyValue

Returns:

The array containing the value bytes.

getValueOffset

public int getValueOffset()

Description copied from class: KeyValue

Returns the value offset

Specified by:

getValueOffset in interface Cell

Overrides:

getValueOffset in class KeyValue

getValueLength

public int getValueLength()

Description copied from class: KeyValue

Returns Value length

Specified by:

getValueLength in interface Cell

Overrides:

getValueLength in class KeyValue

getTagsLength

public int getTagsLength()

Description copied from class: KeyValue

Return the total length of the tag bytes

Specified by:

getTagsLength in interface RawCell

Overrides:

getTagsLength in class KeyValue

Returns:

the total length of the tags in the Cell.

toString

public String toString()

Overrides:

toString in class KeyValue

hashCode

public int hashCode()

Description copied from class: KeyValue

In line with KeyValue.equals(Object), only uses the key portion, not the value.

Overrides:

hashCode in class KeyValue

equals

public boolean equals(Object other)

Description copied from class: KeyValue

Needed doing 'contains' on List. Only compares the key portion, not the value.

Overrides:

equals in class KeyValue

heapSize

public long heapSize()

Description copied from class: KeyValue

HeapSize implementation

We do not count the bytes in the rowCache because it should be empty for a KeyValue in the MemStore.

Specified by:

heapSize in interface HeapSize

Overrides:

heapSize in class KeyValue

write

public int write(OutputStream out,
 boolean withTags)
          throws IOException

Description copied from interface: ExtendedCell

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>

Specified by:

write in interface ExtendedCell

Overrides:

write in class KeyValue

Parameters:

out - Stream to which cell has to be written

withTags - Whether to write tags.

Returns:

how many bytes are written.

Throws:

IOException