com.tencent.tcaplus.client
Interface Record


public interface Record

the record interface

Version:
Version 1.0
Author:
yahuiwang,elviszhu

Method Summary
 int getIndex()
          get the record index
 byte[] getKeyBlob(java.lang.String fieldName)
          get the key content of byte[] type
 byte getKeyByte(java.lang.String fieldName)
          get the key content of byte type
 int getKeyCount()
          get the key field num
 double getKeyDouble(java.lang.String fieldName)
          get the key content of double type
 float getKeyFloat(java.lang.String fieldName)
          get the key content of float type
 int getKeyInt(java.lang.String fieldName)
          get the key content of int type
 long getKeyLong(java.lang.String fieldName)
          get the key content of long type
 short getKeyShort(java.lang.String fieldName)
          get the key content of short type
 java.lang.String getKeyString(java.lang.String fieldName)
          get the key content of String type
 long getLastAccessTime()
          return the last access time
 byte[] getValueBlob(java.lang.String fieldName)
          get the value content of byte[] type
 byte getValueByte(java.lang.String fieldName)
          get the value content of byte type
 int getValueCount()
          get the value field num
 double getValueDouble(java.lang.String fieldName)
          get the value content of double type
 float getValueFloat(java.lang.String fieldName)
          get the value content of float type
 int getValueInt(java.lang.String fieldName)
          get the value content of int type
 long getValueLong(java.lang.String fieldName)
          get the value content of long type
 short getValueShort(java.lang.String fieldName)
          get the value content of short type
 java.lang.String getValueString(java.lang.String fieldName)
          get the value content of String type
 int getVersion()
          get the record version
 void setKeyBlob(java.lang.String fieldName, byte[] value)
          set the key content of byte[] type
 void setKeyByte(java.lang.String fieldName, byte value)
          set the key content of byte type
 void setKeyDouble(java.lang.String fieldName, double value)
          set the key content of double type
 void setKeyFloat(java.lang.String fieldName, float value)
          set the key content of float type
 void setKeyInt(java.lang.String fieldName, int value)
          set the key content of int type
 void setKeyLong(java.lang.String fieldName, long value)
          set the key content of long type
 void setKeyShort(java.lang.String fieldName, short value)
          set the key content of short type
 void setKeyString(java.lang.String fieldName, java.lang.String value)
          set the key content of String type
 void setValueBlob(java.lang.String fieldName, byte[] value)
          set the value content of byte[] type
 void setValueByte(java.lang.String fieldName, byte value)
          set the value content of byte type
 void setValueDouble(java.lang.String fieldName, double value)
          set the value content of double type
 void setValueFloat(java.lang.String fieldName, float value)
          set the value content of float type
 void setValueInt(java.lang.String fieldName, int value)
          set the value content of int type
 void setValueLong(java.lang.String fieldName, long value)
          set the value content of long type
 void setValueShort(java.lang.String fieldName, short value)
          set the value content of short type
 void setValueString(java.lang.String fieldName, java.lang.String value)
          set the value content of String type
 void setVersion(int version)
          set the record version
 java.lang.String toString()
          visualize the content of the record
 

Method Detail

setVersion

void setVersion(int version)
                throws com.tencent.tcaplus.util.TCaplusException
set the record version

Parameters:
int - version: record version, when <=0 means the version is not used.
Throws:
com.tencent.tcaplus.util.TCaplusException

getVersion

int getVersion()
               throws com.tencent.tcaplus.util.TCaplusException
get the record version

Returns:
int: record version
Throws:
com.tencent.tcaplus.util.TCaplusException

toString

java.lang.String toString()
                          throws com.tencent.tcaplus.util.TCaplusException
visualize the content of the record

Overrides:
toString in class java.lang.Object
Returns:
璁板綍鍐呭
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyByte

void setKeyByte(java.lang.String fieldName,
                byte value)
                throws com.tencent.tcaplus.util.TCaplusException
set the key content of byte type

Parameters:
String - fieldName: filedName, max size 32 bytes
byte - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyShort

void setKeyShort(java.lang.String fieldName,
                 short value)
                 throws com.tencent.tcaplus.util.TCaplusException
set the key content of short type

Parameters:
String - fieldName: filedName, max size 32 bytes
short - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyInt

void setKeyInt(java.lang.String fieldName,
               int value)
               throws com.tencent.tcaplus.util.TCaplusException
set the key content of int type

Parameters:
String - fieldName: filedName, max size 32 bytes
int - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyLong

void setKeyLong(java.lang.String fieldName,
                long value)
                throws com.tencent.tcaplus.util.TCaplusException
set the key content of long type

Parameters:
String - fieldName: filedName, max size 32 bytes
long - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyFloat

void setKeyFloat(java.lang.String fieldName,
                 float value)
                 throws com.tencent.tcaplus.util.TCaplusException
set the key content of float type

Parameters:
String - fieldName: filedName, max size 32 bytes
float - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyDouble

void setKeyDouble(java.lang.String fieldName,
                  double value)
                  throws com.tencent.tcaplus.util.TCaplusException
set the key content of double type

Parameters:
String - fieldName: filedName, max size 32 bytes
double - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyString

void setKeyString(java.lang.String fieldName,
                  java.lang.String value)
                  throws com.tencent.tcaplus.util.TCaplusException
set the key content of String type

Parameters:
String - fieldName: filedName, max size 32 bytes
String - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setKeyBlob

void setKeyBlob(java.lang.String fieldName,
                byte[] value)
                throws com.tencent.tcaplus.util.TCaplusException
set the key content of byte[] type

Parameters:
String - fieldName: filedName, max size 32 bytes
byte[] - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueByte

void setValueByte(java.lang.String fieldName,
                  byte value)
                  throws com.tencent.tcaplus.util.TCaplusException
set the value content of byte type

Parameters:
String - fieldName: filedName, max size 32 bytes
byte - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueShort

void setValueShort(java.lang.String fieldName,
                   short value)
                   throws com.tencent.tcaplus.util.TCaplusException
set the value content of short type

Parameters:
String - fieldName: filedName, max size 32 bytes
short - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueInt

void setValueInt(java.lang.String fieldName,
                 int value)
                 throws com.tencent.tcaplus.util.TCaplusException
set the value content of int type

Parameters:
String - fieldName: filedName, max size 32 bytes
int - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueLong

void setValueLong(java.lang.String fieldName,
                  long value)
                  throws com.tencent.tcaplus.util.TCaplusException
set the value content of long type

Parameters:
String - fieldName: filedName, max size 32 bytes
long - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueFloat

void setValueFloat(java.lang.String fieldName,
                   float value)
                   throws com.tencent.tcaplus.util.TCaplusException
set the value content of float type

Parameters:
String - fieldName: filedName, max size 32 bytes
float - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueDouble

void setValueDouble(java.lang.String fieldName,
                    double value)
                    throws com.tencent.tcaplus.util.TCaplusException
set the value content of double type

Parameters:
String - fieldName: filedName, max size 32 bytes
double - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueString

void setValueString(java.lang.String fieldName,
                    java.lang.String value)
                    throws com.tencent.tcaplus.util.TCaplusException
set the value content of String type

Parameters:
String - fieldName: filedName, max size 32 bytes
String - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

setValueBlob

void setValueBlob(java.lang.String fieldName,
                  byte[] value)
                  throws com.tencent.tcaplus.util.TCaplusException
set the value content of byte[] type

Parameters:
String - fieldName: filedName, max size 32 bytes
byte[] - value: field content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyByte

byte getKeyByte(java.lang.String fieldName)
                throws com.tencent.tcaplus.util.TCaplusException
get the key content of byte type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
byte: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyShort

short getKeyShort(java.lang.String fieldName)
                  throws com.tencent.tcaplus.util.TCaplusException
get the key content of short type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
short: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyInt

int getKeyInt(java.lang.String fieldName)
              throws com.tencent.tcaplus.util.TCaplusException
get the key content of int type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
int: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyLong

long getKeyLong(java.lang.String fieldName)
                throws com.tencent.tcaplus.util.TCaplusException
get the key content of long type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
long: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyFloat

float getKeyFloat(java.lang.String fieldName)
                  throws com.tencent.tcaplus.util.TCaplusException
get the key content of float type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
float: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyDouble

double getKeyDouble(java.lang.String fieldName)
                    throws com.tencent.tcaplus.util.TCaplusException
get the key content of double type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
double: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyString

java.lang.String getKeyString(java.lang.String fieldName)
                              throws com.tencent.tcaplus.util.TCaplusException
get the key content of String type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
String: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyBlob

byte[] getKeyBlob(java.lang.String fieldName)
                  throws com.tencent.tcaplus.util.TCaplusException
get the key content of byte[] type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
byte[]: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getKeyCount

int getKeyCount()
                throws com.tencent.tcaplus.util.TCaplusException
get the key field num

Returns:
int: the key field num
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueByte

byte getValueByte(java.lang.String fieldName)
                  throws com.tencent.tcaplus.util.TCaplusException
get the value content of byte type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
byte: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueShort

short getValueShort(java.lang.String fieldName)
                    throws com.tencent.tcaplus.util.TCaplusException
get the value content of short type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
short: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueInt

int getValueInt(java.lang.String fieldName)
                throws com.tencent.tcaplus.util.TCaplusException
get the value content of int type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
int: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueLong

long getValueLong(java.lang.String fieldName)
                  throws com.tencent.tcaplus.util.TCaplusException
get the value content of long type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
long: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueFloat

float getValueFloat(java.lang.String fieldName)
                    throws com.tencent.tcaplus.util.TCaplusException
get the value content of float type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
float: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueDouble

double getValueDouble(java.lang.String fieldName)
                      throws com.tencent.tcaplus.util.TCaplusException
get the value content of double type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
double: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueString

java.lang.String getValueString(java.lang.String fieldName)
                                throws com.tencent.tcaplus.util.TCaplusException
get the value content of String type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
String: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueBlob

byte[] getValueBlob(java.lang.String fieldName)
                    throws com.tencent.tcaplus.util.TCaplusException
get the value content of byte[] type

Parameters:
String - fieldName: filedName, max size 32 bytes
Returns:
byte[]: the filed content
Throws:
com.tencent.tcaplus.util.TCaplusException

getValueCount

int getValueCount()
                  throws com.tencent.tcaplus.util.TCaplusException
get the value field num

Returns:
int: the value field num
Throws:
com.tencent.tcaplus.util.TCaplusException

getIndex

int getIndex()
get the record index

Returns:
int: the record index

getLastAccessTime

long getLastAccessTime()
                       throws com.tencent.tcaplus.util.TCaplusException
return the last access time

Returns:
long: the last access time
Throws:
com.tencent.tcaplus.util.TCaplusException
See Also:
funtion is only used when the operation are :Get, Replace, TableTraverse, GetByPartKey