org.apache.hadoop.hbase.rest.model

Class CellModel

java.lang.Object

org.apache.hadoop.hbase.rest.model.CellModel

All Implemented Interfaces:

Serializable, ProtobufMessageHandler

@InterfaceAudience.Private
public class CellModel
extends Object
implements ProtobufMessageHandler, Serializable

Representation of a cell. A cell is a single value associated a column and optional qualifier, and either the timestamp when it was stored or the user- provided timestamp if one was explicitly supplied.

 <complexType name="Cell">
   <sequence>
     <element name="value" maxOccurs="1" minOccurs="1">
       <simpleType>
         <restriction base="base64Binary"/>
       </simpleType>
     </element>
   </sequence>
   <attribute name="column" type="base64Binary" />
   <attribute name="timestamp" type="int" />
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAGIC_LENGTH

Fields inherited from interface org.apache.hadoop.hbase.rest.ProtobufMessageHandler

BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
CellModel() Default constructor
CellModel(byte[] column, byte[] value) Constructor
CellModel(byte[] column, byte[] qualifier, byte[] value) Constructor
CellModel(byte[] family, byte[] qualifier, long timestamp, byte[] value) Constructor
CellModel(byte[] column, long timestamp, byte[] value) Constructor
CellModel(Cell cell) Constructor from KeyValue This avoids copying the value from the cell, and tries to optimize generating the column value.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getColumn() Returns the column
ProtobufMessageHandler	getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
long	getTimestamp() Returns the timestamp
byte[]	getValue() Returns the value
byte[]	getValueArray() Returns the backing array for value (may be the same as value)
int	getValueLength()
int	getValueOffset()
int	hashCode()
boolean	hasUserTimestamp() Returns true if the timestamp property has been specified by the user
static byte[]	makeColumn(byte[] family, int familyOffset, int familyLength, byte[] qualifier, int qualifierOffset, int qualifierLength) Makes a column in family:qualifier form from separate byte arrays with offset and length.
org.apache.hbase.thirdparty.com.google.protobuf.Message	messageFromObject() Convert to model to a protobuf Message object
void	setColumn(byte[] column)
void	setTimestamp(long timestamp)
void	setValue(byte[] value)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.rest.ProtobufMessageHandler

createProtobufOutput, getObjectFromMessage, getObjectFromMessage, writeProtobufOutput

Field Detail

MAGIC_LENGTH

public static final int MAGIC_LENGTH

See Also:

Constant Field Values

Constructor Detail

CellModel

public CellModel()

Default constructor

CellModel

public CellModel(byte[] column,
                 byte[] value)

Constructor

CellModel

public CellModel(byte[] column,
                 byte[] qualifier,
                 byte[] value)

Constructor

CellModel

public CellModel(Cell cell)

Constructor from KeyValue This avoids copying the value from the cell, and tries to optimize generating the column value.

CellModel

public CellModel(byte[] column,
                 long timestamp,
                 byte[] value)

Constructor

CellModel

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

Constructor

Method Detail

getColumn

public byte[] getColumn()

Returns the column

setColumn

public void setColumn(byte[] column)

Parameters:

column - the column to set

hasUserTimestamp

public boolean hasUserTimestamp()

Returns true if the timestamp property has been specified by the user

getTimestamp

public long getTimestamp()

Returns the timestamp

setTimestamp

public void setTimestamp(long timestamp)

Parameters:

timestamp - the timestamp to set

getValue

public byte[] getValue()

Returns the value

getValueArray

public byte[] getValueArray()

Returns the backing array for value (may be the same as value)

setValue

public void setValue(byte[] value)

Parameters:

value - the value to set

getValueOffset

public int getValueOffset()

getValueLength

public int getValueLength()

messageFromObject

public org.apache.hbase.thirdparty.com.google.protobuf.Message messageFromObject()

Description copied from interface: ProtobufMessageHandler

Convert to model to a protobuf Message object

Specified by:

messageFromObject in interface ProtobufMessageHandler

Returns:

the protobuf Message object

getObjectFromMessage

public ProtobufMessageHandler getObjectFromMessage(org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream cis)
                                            throws IOException

Specified by:

getObjectFromMessage in interface ProtobufMessageHandler

Throws:

IOException

makeColumn

public static byte[] makeColumn(byte[] family,
                                int familyOffset,
                                int familyLength,
                                byte[] qualifier,
                                int qualifierOffset,
                                int qualifierLength)

Makes a column in family:qualifier form from separate byte arrays with offset and length.

Not recommended for usage as this is old-style API.

Returns:

family:qualifier

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object