【深入理解TcaplusDB技術】讀取列表指定位置資料介面說明——[List表]
阿新 • • 發佈：2022-04-22
摘要
實現從指定表格中讀取指定Key的列表，獲取指定位置的資料。
示例程式碼
同步呼叫參見章節：[List表]讀取列表指定位置資料示例程式碼。
非同步呼叫參見章節：非同步呼叫介面示例程式碼。
Request物件方法說明
注：如有未列出來的Request物件方法，即表示該方法在讀取資料的場景下是無效的。
| 方法簽名 | 方法說明 |
|---|---|
void setCmd(int cmd) |
設定請求型別（指令）。cmd：請求型別，固定為TcaplusProtocolCsConstants.TCAPLUS_CMD_LIST_GET_REQ。 |
void setTableName(String tableName) |
設定目標表名。tableName：目標表名，不能為null。 |
Record addRecord(int index) |
獲取資料物件（Record），用於設定讀取的資料的Key，使用者可以呼叫該物件的setKeyXXX方法設定各Key欄位的值。index：要讀取的資料在列表中的序號，從0開始，不能是負數。 |
void addFieldName(String fieldName) |
新增需要查詢的資料的Value欄位的名稱。fieldName：Value欄位名，不能為null。 |
Request中的Record物件方法說明
注：如有未列出來的Record物件方法，即表示該方法在讀取資料的場景下是無效的。
| 方法簽名 | 方法說明 |
|---|---|
void setVersion(int version) |
設定資料的版本號。version：如果設定為負數，表示當前資料不啟動版本控制。 |
void setKeyByte(String fieldName, byte value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的byte型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyShort(String fieldName, short value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的short型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyInt(String fieldName, int value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的int型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyLong(String fieldName, long value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的long型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyFloat(String fieldName, float value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的float型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyDouble(String fieldName, double value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的double型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyString(String fieldName, String value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的String型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
void setKeyBlob(String fieldName, byte[] value) |
設定指定名稱的Key欄位的值。注意：當TDR表描述檔案中定義的欄位型別與Java的byte[]型別對應時，才可呼叫該方法設定欄位值，否則服務端在處理請求時會引數錯誤。參見TDR表字段型別與Java型別對應關係。fieldName：欄位名稱，不可為null。value：欄位的新值。 |
Response物件方法說明
注：如有未列出來的Response物件方法，即表示該方法在查詢資料的場景下是無效的。
| 方法簽名 | 方法說明 |
|---|---|
int getResult() |
獲取讀取資料請求的響應碼。0表示操作成功。非0表示操作異常，參見響應碼含義說明。 |
Record fetchRecord() |
獲取讀取返回的資料物件。使用者可以迴圈呼叫該方法，逐條獲取返回的資料，當該方法返回null時，表示所有資料讀取完畢。使用者可以呼叫該物件的getValueXXX方法獲取各Value欄位的值。 |
Response中的Record物件方法說明
注：如有未列出來的Record物件方法，即表示該方法在讀取資料的場景下是無效的。
| 方法簽名 | 方法說明 |
|---|---|
int getVersion() |
獲取資料的版本號。 |
int getValueCount() |
獲取資料的Value欄位的個數。 |
byte getValueByte(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
short getValueShort(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
int getValueInt(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
long getValueLong(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
float getValueFloat(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
double getValueDouble(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
String getValueString(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |
byte[] getValueBlob(String fieldName) |
獲取指定名稱的Value欄位的值。fieldName：欄位名稱，不可為null。 |