cproc.datacube.client.api

接口 ClientDevelopApi

public interface ClientDevelopApi

物联网平台应用开发包扩展接口（主要针对硬件接入数据，建议使用）

版本:

1.0

作者:

zhu guangyao

方法概要

限定符和类型	方法和说明
ReObject	addDevice(AppInfo app, DeviceConditionInfo deviceCon) 添加设备
ReObject	getAllAppDevices(AppInfo app) 查询该应用下所有设备
ReObject	getDeviceTopOneResult(AppInfo app, java.lang.String devid, java.util.List<java.lang.String> colNames) 获取指定设备最新一条数据
ReObject	getDevsStatisticWithTimeDivision(AppInfo app, java.util.List<java.lang.String> dev_id, java.lang.String timeDvisionType, java.lang.String startTimeStr, int countNum, java.util.List<java.lang.String> colNames) 按照时间分片统计数据
ReObject	getHardWareStatisticWithTimeDivision(AppInfo app, java.lang.String dev_id, java.lang.String timeDvisionType, java.lang.String startTimeStr, int countNum, Conditions con, java.util.List<java.lang.String> colNames) 按照时间分片统计数据
ReObject	getServerCurrentTime(AppInfo app) 获取服务器时间
ReObject	getStatisticByColumn(AppInfo app, java.lang.String tableName, java.lang.String startPK, java.lang.String endPK, Conditions con, java.lang.String colName) 多条件统计查询
ReObject	getTableRows(AppInfo app, java.lang.String tableName, Conditions con, java.util.List<java.lang.String> colNames) 多条件不带分页查询（返回固定条数，条数可以指定，默认1000）
RePageObject	getTableRowsByNewPageCondition(AppInfo app, java.lang.String tableName, Conditions con, java.util.List<java.lang.String> colNames) 多条件分页查询 分页查询实现方式:1.建议采用----使用前段缓存的方式，用getTableRows方法，设置conditions条件里resultCount属性，批量获取一定数量的结果(如1000条)，在应用前段针对这1000条数据进行分页。
ReObject	getTableRowsByPage(AppInfo app, java.lang.String tableName, java.lang.String startPK, java.lang.String endPK, Conditions con, java.util.List<java.lang.String> colNames) 已过时。
ReObject	getTableRowsByPKRange(AppInfo app, java.lang.String tableName, java.lang.String startPK, java.lang.String endPK, Conditions con, java.util.List<java.lang.String> colNames) 多条件指定主键范围不带分页查询
ReObject	getTopOneResult(AppInfo app, java.lang.String tableName, Conditions con, java.util.List<java.lang.String> colNames) 获取指定应用的最新一条数据
ReJSONData	queryDeviceDataAvgValues(AppInfo app, java.lang.String deviceId, cn.cstor.cproc.java.thrift.AvgQueryType avgQueryType, java.util.Date startTime, java.util.Date endTime, java.lang.String[] columns) 查询小时，天，周，月，年的平均值
ReObject	queryHourDevicesDataCount(AppInfo app, java.lang.String startPK, java.lang.String endPK) 查询指定小时内的每个设备的数据上报量
ReData	queryLongitudeLatitude(AppInfo app, java.util.List<java.lang.String> deviceIds) 按照设备号查询经纬度

方法详细资料

addDevice

ReObject addDevice(AppInfo app,
                   DeviceConditionInfo deviceCon)
            throws org.apache.thrift.TException

添加设备

参数:

app - 应用信息, 需要的属性:accessid, appid

deviceCon - 设备信息

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

queryDeviceDataAvgValues

ReJSONData queryDeviceDataAvgValues(AppInfo app,
                                    java.lang.String deviceId,
                                    cn.cstor.cproc.java.thrift.AvgQueryType avgQueryType,
                                    java.util.Date startTime,
                                    java.util.Date endTime,
                                    java.lang.String[] columns)
                             throws org.apache.thrift.TException

查询小时，天，周，月，年的平均值

参数:

app - 应用信息, 需要的属性:accessid, appid

deviceId - 设备号

avgQueryType - 枚举类型，表示按天，按小时。。。。

startTime - 开始时间

endTime - 结束时间

columns - 需要计算平均值的列

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

queryHourDevicesDataCount

ReObject queryHourDevicesDataCount(AppInfo app,
                                   java.lang.String startPK,
                                   java.lang.String endPK)
                            throws org.apache.thrift.TException

查询指定小时内的每个设备的数据上报量

参数:

app - 应用信息, 需要的属性:accessid, appid

startPK - 起始主键(非空)

endPK - 结束主键(非空)

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

queryLongitudeLatitude

ReData queryLongitudeLatitude(AppInfo app,
                              java.util.List<java.lang.String> deviceIds)
                       throws org.apache.thrift.TException

按照设备号查询经纬度

参数:

app - 应用信息, 需要的属性:accessid, appid

deviceIds - 设备号

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getAllAppDevices

ReObject getAllAppDevices(AppInfo app)
                   throws org.apache.thrift.TException

查询该应用下所有设备

参数:

app - 应用信息, 需要的属性:accessid, appid

返回:

抛出:

org.apache.thrift.TException

getDeviceTopOneResult

ReObject getDeviceTopOneResult(AppInfo app,
                               java.lang.String devid,
                               java.util.List<java.lang.String> colNames)
                        throws org.apache.thrift.TException

获取指定设备最新一条数据

参数:

app - 应用信息, 需要的属性:accessid, appid

devid - 设备号

colNames - 列名称集合

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getDevsStatisticWithTimeDivision

ReObject getDevsStatisticWithTimeDivision(AppInfo app,
                                          java.util.List<java.lang.String> dev_id,
                                          java.lang.String timeDvisionType,
                                          java.lang.String startTimeStr,
                                          int countNum,
                                          java.util.List<java.lang.String> colNames)
                                   throws org.apache.thrift.TException

按照时间分片统计数据

参数:

app - 应用信息, 需要的属性:accessid, appid

dev_id - 设备号

timeDvisionType - 时间分片类型，按照hour还是按照day

startTimeStr - 统计开始时间

countNum - 统计的天数或者小时数

colNames - 列名称

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getHardWareStatisticWithTimeDivision

ReObject getHardWareStatisticWithTimeDivision(AppInfo app,
                                              java.lang.String dev_id,
                                              java.lang.String timeDvisionType,
                                              java.lang.String startTimeStr,
                                              int countNum,
                                              Conditions con,
                                              java.util.List<java.lang.String> colNames)
                                       throws org.apache.thrift.TException

按照时间分片统计数据

参数:

app - 应用信息, 需要的属性:accessid, appid

dev_id - 设备号

timeDvisionType - 时间分片类型，按照hour还是按照day

startTimeStr - 统计开始时间

countNum - 统计的天数或者小时数

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空

colNames - 列名称

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getServerCurrentTime

ReObject getServerCurrentTime(AppInfo app)
                       throws org.apache.thrift.TException

获取服务器时间

参数:

app - 应用信息, 需要的属性:accessid, appid

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getStatisticByColumn

ReObject getStatisticByColumn(AppInfo app,
                              java.lang.String tableName,
                              java.lang.String startPK,
                              java.lang.String endPK,
                              Conditions con,
                              java.lang.String colName)
                       throws org.apache.thrift.TException

多条件统计查询

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名称

startPK - 起始主键(非空)

endPK - 截止主键(非空)

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空

colName - 列名（为空时不统计列求和，列最大值，列最小值）

返回:

reObject.getData 统计结果集合（总记录数，列求和，列最大值，列最小值，列平均值）

抛出:

org.apache.thrift.TException

getTableRows

ReObject getTableRows(AppInfo app,
                      java.lang.String tableName,
                      Conditions con,
                      java.util.List<java.lang.String> colNames)
               throws org.apache.thrift.TException

多条件不带分页查询（返回固定条数，条数可以指定，默认1000）

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空 pageCon--分页条件，不建议使用，使用pageQueryCondition替代 pageQueryCondition--分页条件，结果会返回下一页开始的startkey，或者标识为最后一页 starttime--查询的入库开始时间 endtime--查询的入库结束时间 resultCount--返回结果条数(默认1000)

colNames - 列名称集合

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getTableRowsByNewPageCondition

RePageObject getTableRowsByNewPageCondition(AppInfo app,
                                            java.lang.String tableName,
                                            Conditions con,
                                            java.util.List<java.lang.String> colNames)
                                     throws org.apache.thrift.TException

多条件分页查询 分页查询实现方式:1.建议采用----使用前段缓存的方式，用getTableRows方法，设置conditions条件里resultCount属性，批量获取一定数量的结果(如1000条)，在应用前段针对这1000条数据进行分页。 2.采用此方法查询，指定下一页的startkey(第一页不虚指定，以后每页的startkey会在上一页返回的分页结果中返回nextstartkey属性)和pagesize，此方法点击上一页需要再页面缓存每一页的startkey，第一页不需要缓存和指定，可以即时刷新最新数据

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空 pageCon--分页条件，不建议使用，使用pageQueryCondition替代 pageQueryCondition--分页条件，结果会返回下一页开始的startkey，或者标识为最后一页 starttime--查询的入库开始时间 endtime--查询的入库结束时间 resultCount--返回结果条数(默认1000)

colNames - 列名称集合

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getTableRowsByPKRange

ReObject getTableRowsByPKRange(AppInfo app,
                               java.lang.String tableName,
                               java.lang.String startPK,
                               java.lang.String endPK,
                               Conditions con,
                               java.util.List<java.lang.String> colNames)
                        throws org.apache.thrift.TException

多条件指定主键范围不带分页查询

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名

startPK - 起始主键(非空)

endPK - 截止主键(非空)

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空 pageCon--分页条件，不建议使用，使用pageQueryCondition替代 pageQueryCondition--分页条件，结果会返回下一页开始的startkey，或者标识为最后一页 starttime--查询的入库开始时间 endtime--查询的入库结束时间 resultCount--返回结果条数(默认1000)

colNames - 列名称集合

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getTableRowsByPage

@Deprecated
ReObject getTableRowsByPage(AppInfo app,
                                         java.lang.String tableName,
                                         java.lang.String startPK,
                                         java.lang.String endPK,
                                         Conditions con,
                                         java.util.List<java.lang.String> colNames)
                                  throws org.apache.thrift.TException

已过时。

多条件查询指定列,不建议使用该查询的分页，建议使用 getTableRowsByNewPageCondition getTableRows getTableRowsByPKRange

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名称

startPK - 起始主键(非空)

endPK - 截止主键(非空)

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空 pageCon--分页条件，不建议使用，使用pageQueryCondition替代 pageQueryCondition--分页条件，结果会返回下一页开始的startkey，或者标识为最后一页 starttime--查询的入库开始时间 endtime--查询的入库结束时间 resultCount--返回结果条数(默认1000)

colNames - 列名集合，空表示查询所有列

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException

getTopOneResult

ReObject getTopOneResult(AppInfo app,
                         java.lang.String tableName,
                         Conditions con,
                         java.util.List<java.lang.String> colNames)
                  throws org.apache.thrift.TException

获取指定应用的最新一条数据

参数:

app - 应用信息, 需要的属性:accessid, appid

tableName - 表名称

con - 过滤条件 substrKeyCons--主键截字符比较条件，无此条件时传空 splitKeyCons--主键按分隔符比较条件，无此条件时传空 colCons--列条件，无此条件时传空 pageCon--分页条件，不建议使用，使用pageQueryCondition替代 pageQueryCondition--分页条件，结果会返回下一页开始的startkey，或者标识为最后一页 starttime--查询的入库开始时间 endtime--查询的入库结束时间 resultCount--返回结果条数(默认1000)

colNames - 列名集合

返回:

ReObject 查询结果集合

抛出:

org.apache.thrift.TException