完整接口文档参考:https://wiki.smartbi.com.cn/api/javaqueryapi/
com.freequery.metadata
接口 IJavaQueryData
所有已知子接口: IJavaQueryData.ISimpleData
public interface IJavaQueryData
Java查询实现接口
嵌套类摘要 | |
---|---|
static interface | IJavaQueryData.IAggregateSupport 声明该实现类支持聚合 |
static interface | IJavaQueryData.ICalculateFieldSupport 声明该实现类支持计算字段 |
static interface | IJavaQueryData.IOrderSupport 声明该实现类支持排序 |
static interface | IJavaQueryData.ISimpleCalculateFieldSupport 声明该实现类支持计算字段,使用系统默认计算器 |
static interface | IJavaQueryData.ISimpleData 声明返回该类返回的数据量比较少,Smartbi会自动读取所有数据并支持计算字段、排序、聚合、条件的功能 |
static interface | IJavaQueryData.IWhereSupport 声明该实现类支持Where条件 |
static interface | IJavaQueryData.IDataSourceAware 允许在java查询类中得到数据源ID |
方法摘要 | |
---|---|
void | close() 关闭Java查询对象,关闭必要的资源 |
java.util.List<com.freequery.metadata.JavaQueryConfig> | getConfigs() 获取Java查询需要的配置信息 |
com.freequery.querydata.GridData | getGridData(int from, int count) 获取指定行的数据 |
java.util.List<com.freequery.metadata.JavaQueryOutputField> | getOutputFields() 返回Java查询的输出字段 |
java.util.List<com.freequery.metadata.JavaQueryParameter> | getParameters() 返回参数对象 |
int | getRowCount() 返回总行数,返回Integer.MAX_VALUE表示未知总行数 |
void | init() 根据配置信息初始化Java查询对象 |
void | loadConfigs(java.lang.String configs) 从保存的字符串中恢复配置信息 |
java.lang.String | saveConfigs() 保存配置信息 |
void | setConfigValue(java.lang.String key, java.lang.String value) 设置配置信息 |
void | setConfigValues(java.util.Map<java.lang.String,java.lang.String> configValues) 设置配置信息 |
void | setParameterValue(java.lang.String id, java.lang.String value, java.lang.String displayValue) 设置参数值 |
方法详细信息 |
---|
loadConfigs
void loadConfigs(java.lang.String configs)
从保存的字符串中恢复配置信息 参数:configs - 配置字符串
saveConfigs
java.lang.String saveConfigs()
保存配置信息 返回:返回配置字符串
getConfigs
java.util.List<com.freequery.metadata.JavaQueryConfig> getConfigs()
获取Java查询需要的配置信息
setConfigValue
void setConfigValue(java.lang.String key, java.lang.String value)
设置配置信息 参数:key - 名称value - 配置值
setConfigValues
void setConfigValues(java.util.Map<java.lang.String,java.lang.String> configValues)
设置配置信息
init
void init()
根据配置信息初始化Java查询对象
getParameters
java.util.List<com.freequery.metadata.JavaQueryParameter> getParameters()
返回参数对象
getOutputFields
java.util.List<com.freequery.metadata.JavaQueryOutputField> getOutputFields()
返回Java查询的输出字段
setParameterValue
void setParameterValue(java.lang.String id, java.lang.String value, java.lang.String displayValue)
设置参数值
getRowCount
int getRowCount()
返回总行数,返回Integer.MAX_VALUE表示未知总行数
getGridData
com.freequery.querydata.GridData getGridData(int from, int count)
获取指定行的数据
close
void close()
关闭Java查询对象,关闭必要的资源