co.cask.cdap.data2.dataset2.lib.table.leveldb

Class KeyValue

java.lang.Object

co.cask.cdap.data2.dataset2.lib.table.leveldb.KeyValue

public class KeyValue
extends Object

This is a copy of parts of HBase's KeyValue, to be used for the leveldb table implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyValue.KeyComparator Compare key portion of a KeyValue.
static class	KeyValue.SplitKeyValue Utility class that splits a KeyValue buffer into separate byte arrays.
static class	KeyValue.Type Key type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAMILY_LENGTH_SIZE Size of the family length field in bytes.
static KeyValue.KeyComparator	KEY_COMPARATOR Comparator for plain key; i.e.
static int	KEY_INFRASTRUCTURE_SIZE
static int	KEYVALUE_INFRASTRUCTURE_SIZE
static long	LATEST_TIMESTAMP Timestamp to use when we want to refer to the latest cell.
static long	OLDEST_TIMESTAMP Timestamp to use when we want to refer to the oldest cell.
static int	ROW_LENGTH_SIZE Size of the row length field in bytes.
static int	ROW_OFFSET
static int	TIMESTAMP_SIZE Size of the timestamp field in bytes.
static int	TIMESTAMP_TYPE_SIZE
static int	TYPE_SIZE Size of the key type field in bytes.

Constructor Summary

Constructors

Constructor and Description
KeyValue(byte[] bytes) Creates a KeyValue from the start of the specified byte array.
KeyValue(byte[] row, byte[] family, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength) Constructs KeyValue structure filled with specified values.
KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, byte[] value) Constructs KeyValue structure filled with specified values.
KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type) Constructs KeyValue structure filled with specified values.
KeyValue(byte[] row, byte[] family, byte[] qualifier, long timestamp, KeyValue.Type type, byte[] value) Constructs KeyValue structure filled with specified values.
KeyValue(byte[] bytes, int offset) Creates a KeyValue from the specified byte array and offset.
KeyValue(byte[] bytes, int offset, int length) Creates a KeyValue from the specified byte array, starting at offset, and for length length.
KeyValue(byte[] row, int roffset, int rlength, byte[] family, int foffset, int flength, byte[] qualifier, int qoffset, int qlength, long timestamp, KeyValue.Type type, byte[] value, int voffset, int vlength) Constructs KeyValue structure filled with specified values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object other)
static KeyValue	fromKey(byte[] key)
byte[]	getBuffer()
byte[]	getFamily() Primarily for use client-side.
byte	getFamilyLength()
byte	getFamilyLength(int foffset)
int	getFamilyOffset()
int	getFamilyOffset(int rlength)
byte[]	getKey() Do not use unless you have to.
int	getKeyLength()
int	getKeyOffset()
int	getLength()
int	getOffset()
byte[]	getQualifier() Primarily for use client-side.
int	getQualifierLength()
int	getQualifierLength(int rlength, int flength)
int	getQualifierOffset()
int	getQualifierOffset(int foffset)
byte[]	getRow() Primarily for use client-side.
short	getRowLength()
int	getRowOffset()
long	getTimestamp()
int	getTimestampOffset(int keylength)
byte	getType()
byte[]	getValue() Returns value in a new byte array.
int	getValueLength()
int	getValueOffset()
int	hashCode()
static String	humanReadableTimestamp(long timestamp)
static String	keyToString(byte[] b, int o, int l)
KeyValue.SplitKeyValue	split()
String	toString()
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

LATEST_TIMESTAMP

public static final long LATEST_TIMESTAMP

Timestamp to use when we want to refer to the latest cell. This is the timestamp sent by clients when no timestamp is specified on commit.

See Also:

Constant Field Values

OLDEST_TIMESTAMP

public static final long OLDEST_TIMESTAMP

Timestamp to use when we want to refer to the oldest cell.

See Also:

Constant Field Values

KEY_COMPARATOR

public static final KeyValue.KeyComparator KEY_COMPARATOR

Comparator for plain key; i.e. non-catalog table key. Works on Key portion of KeyValue only.

TYPE_SIZE

public static final int TYPE_SIZE

Size of the key type field in bytes.

See Also:

Constant Field Values

ROW_LENGTH_SIZE

public static final int ROW_LENGTH_SIZE

Size of the row length field in bytes.

See Also:

Constant Field Values

FAMILY_LENGTH_SIZE

public static final int FAMILY_LENGTH_SIZE

Size of the family length field in bytes.

See Also:

Constant Field Values

TIMESTAMP_SIZE

public static final int TIMESTAMP_SIZE

Size of the timestamp field in bytes.

See Also:

Constant Field Values

TIMESTAMP_TYPE_SIZE

public static final int TIMESTAMP_TYPE_SIZE

See Also:

Constant Field Values

KEY_INFRASTRUCTURE_SIZE

public static final int KEY_INFRASTRUCTURE_SIZE

See Also:

Constant Field Values

ROW_OFFSET

public static final int ROW_OFFSET

See Also:

Constant Field Values

KEYVALUE_INFRASTRUCTURE_SIZE

public static final int KEYVALUE_INFRASTRUCTURE_SIZE

See Also:

Constant Field Values

Constructor Detail

KeyValue

public KeyValue(byte[] bytes)

Creates a KeyValue from the start of the specified byte array. Presumes bytes content is formatted as a KeyValue blob.

Parameters:

bytes - byte array

KeyValue

public KeyValue(byte[] bytes,
        int offset)

Creates a KeyValue from the specified byte array and offset. Presumes bytes content starting at offset is formatted as a KeyValue blob.

Parameters:

bytes - byte array

offset - offset to start of KeyValue

KeyValue

public KeyValue(byte[] bytes,
        int offset,
        int length)

Creates a KeyValue from the specified byte array, starting at offset, and for length length.

Parameters:

bytes - byte array

offset - offset to start of the KeyValue

length - length of the KeyValue

KeyValue

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

Constructs KeyValue structure filled with specified values.

Parameters:

row - row key

family - family name

qualifier - column qualifier

timestamp - version timestamp

type - key type

Throws:

IllegalArgumentException

KeyValue

public KeyValue(byte[] row,
        byte[] family,
        byte[] qualifier,
        long timestamp,
        byte[] value)

Constructs KeyValue structure filled with specified values.

Parameters:

row - row key

family - family name

qualifier - column qualifier

timestamp - version timestamp

value - column value

Throws:

IllegalArgumentException

KeyValue

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

Constructs KeyValue structure filled with specified values.

Parameters:

row - row key

family - family name

qualifier - column qualifier

timestamp - version timestamp

type - key type

value - column value

Throws:

IllegalArgumentException

KeyValue

public KeyValue(byte[] row,
        byte[] family,
        byte[] qualifier,
        int qoffset,
        int qlength,
        long timestamp,
        KeyValue.Type type,
        byte[] value,
        int voffset,
        int vlength)

Constructs KeyValue structure filled with specified values.

Parameters:

row - row key

family - family name

qualifier - column qualifier

qoffset - qualifier offset

qlength - qualifier length

timestamp - version timestamp

type - key type

value - column value

voffset - value offset

vlength - value length

Throws:

IllegalArgumentException

KeyValue

public KeyValue(byte[] row,
        int roffset,
        int rlength,
        byte[] family,
        int foffset,
        int flength,
        byte[] qualifier,
        int qoffset,
        int qlength,
        long timestamp,
        KeyValue.Type type,
        byte[] value,
        int voffset,
        int vlength)

Constructs KeyValue structure filled with specified values.

Column is split into two fields, family and qualifier.

Parameters:

row - row key

roffset - row offset

rlength - row length

family - family name

foffset - family offset

flength - family length

qualifier - column qualifier

qoffset - qualifier offset

qlength - qualifier length

timestamp - version timestamp

type - key type

value - column value

voffset - value offset

vlength - value length

Throws:

IllegalArgumentException

Method Detail

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

keyToString

public static String keyToString(byte[] b,
                 int o,
                 int l)

humanReadableTimestamp

public static String humanReadableTimestamp(long timestamp)

getBuffer

public byte[] getBuffer()

Returns:

The byte array backing this KeyValue.

getOffset

public int getOffset()

Returns:

Offset into getBuffer() at which this KeyValue starts.

getLength

public int getLength()

Returns:

Length of bytes this KeyValue occupies in getBuffer().

getKeyOffset

public int getKeyOffset()

Returns:

Key offset in backing buffer..

getKeyLength

public int getKeyLength()

getValueOffset

public int getValueOffset()

Returns:

Value offset

getValueLength

public int getValueLength()

Returns:

Value length

getRowOffset

public int getRowOffset()

Returns:

Row offset

getRowLength

public short getRowLength()

Returns:

Row length

getFamilyOffset

public int getFamilyOffset()

Returns:

Family offset

getFamilyOffset

public int getFamilyOffset(int rlength)

Returns:

Family offset

getFamilyLength

public byte getFamilyLength()

Returns:

Family length

getFamilyLength

public byte getFamilyLength(int foffset)

Returns:

Family length

getQualifierOffset

public int getQualifierOffset()

Returns:

Qualifier offset

getQualifierOffset

public int getQualifierOffset(int foffset)

Returns:

Qualifier offset

getQualifierLength

public int getQualifierLength()

Returns:

Qualifier length

getQualifierLength

public int getQualifierLength(int rlength,
                     int flength)

Returns:

Qualifier length

getTimestampOffset

public int getTimestampOffset(int keylength)

Parameters:

keylength - Pass if you have it to save on a int creation.

Returns:

Timestamp offset

getKey

public byte[] getKey()

Do not use unless you have to. Used internally for compacting and testing. Use getRow(), getFamily(), getQualifier(), and getValue() if accessing a KeyValue client-side.

Returns:

Copy of the key portion only.

getValue

public byte[] getValue()

Returns value in a new byte array. Primarily for use client-side. If server-side, use getBuffer() with appropriate offsets and lengths instead to save on allocations.

Returns:

Value in a new byte array.

getRow

public byte[] getRow()

Primarily for use client-side. Returns the row of this KeyValue in a new byte array.

If server-side, use getBuffer() with appropriate offsets and lengths instead.

Returns:

Row in a new byte array.

getTimestamp

public long getTimestamp()

Returns:

Timestamp

getType

public byte getType()

Returns:

Type of this KeyValue.

getFamily

public byte[] getFamily()

Primarily for use client-side. Returns the family of this KeyValue in a new byte array.

If server-side, use getBuffer() with appropriate offsets and lengths instead.

Returns:

Returns family. Makes a copy.

getQualifier

public byte[] getQualifier()

Primarily for use client-side. Returns the column qualifier of this KeyValue in a new byte array.

If server-side, use getBuffer() with appropriate offsets and lengths instead. Use getBuffer() with appropriate offsets and lengths instead.

Returns:

Returns qualifier. Makes a copy.

split

public KeyValue.SplitKeyValue split()

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

fromKey

public static KeyValue fromKey(byte[] key)