smartbi.sdk.service.simplereport

类 Report

java.lang.Object

smartbi.sdk.service.simplereport.Report

public class Report
extends java.lang.Object

报表服务对象,包括打开报表、执行报表、关闭报表、导出报表等。

构造器概要

构造器

构造器和说明
Report(ClientConnector connector) 构造函数

方法概要

限定符和类型	方法和说明
java.lang.String	cloneQuery(java.lang.String reportId, java.lang.String parentNodeId, java.lang.String name, java.lang.String alias, java.lang.String desc) 把报表查询结果复制在另一张新的报表中,注意：只有执行本类中的open()方法后的报表才能成功复制。
void	close() 关闭报表。
void	doExport(java.lang.String type, java.lang.String delimiter, java.lang.String maxRow, java.io.OutputStream os) 导出报表。
void	doExport(java.lang.String type, java.lang.String delimiter, java.lang.String maxRow, java.io.OutputStream os, java.lang.String resourceBasePath)
void	doExport(java.lang.String type, java.lang.String delimiter, java.lang.String maxRow, java.io.OutputStream os, java.lang.String resourceBasePath, java.lang.String valueType)
void	doExport(java.lang.String type, java.lang.String delimiter, java.lang.String maxRow, java.io.OutputStream os, java.lang.String resourceBasePath, java.lang.String valueType, java.lang.String postData)
void	dump(java.lang.String reportId) 读取报表数据
int	execute(int rowsPerPage) 执行报表
java.lang.String	getClientConfig()
java.lang.String	getCurrentReportName() 取得当前报表名
RunningInfo	getExecutingState() 获取执行状态
java.util.List	getFields() 取得报表的字段信息
ReportData	getPage(int pageIndex) 取得报表的指定页。
java.util.List	getParameters() 取得报表的参数信息
java.util.List	getParamStandbyValue(java.lang.String paramId) 获得某个参数的候选值列表
int	getRowsPerPage() 取得每页行数
void	open(java.lang.String reportId) 打开一个报表。
void	openWithoutInit(java.lang.String reportId)
void	setAutoCondition(java.lang.String fieldId, java.lang.String operator, java.lang.String value) 指定报表过滤条件。
void	setClientConfig(java.lang.String clientConfig)
boolean	setCustomCondition(CustomFilterDataBean filterData) 设置自定义过滤条件。
void	setFieldAggregate(java.lang.String fieldId, java.lang.String aggregate) 指定某个字段的聚合方式。
void	setOrderByType(java.lang.String fieldId, java.lang.String orderType) 指定某个字段的排序方式。
void	setParamValue(java.lang.String paramId, java.lang.String paramValue) 设置参数值,不设置参数显示值。
void	setParamValue(java.lang.String paramId, java.lang.String paramValue, java.lang.String displayValue) 设置参数值。
java.lang.String	toString()
void	updateQuery() 修改报表

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

Report

public Report(ClientConnector connector)

构造函数

参数:

connector - 应用连接器

方法详细资料

getCurrentReportName

public java.lang.String getCurrentReportName()

取得当前报表名

返回:

当前报表名

getRowsPerPage

public int getRowsPerPage()

取得每页行数

返回:

每页行数

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

getParameters

public java.util.List getParameters()

取得报表的参数信息

返回:

参数列表

getFields

public java.util.List getFields()

取得报表的字段信息

返回:

字段列表

openWithoutInit

public void openWithoutInit(java.lang.String reportId)

参数:

reportId - 报表ID

open

public void open(java.lang.String reportId)

打开一个报表。

参数:

reportId - 报表ID

execute

public int execute(int rowsPerPage)

执行报表

参数:

rowsPerPage - 指定每页行数

返回:

报表总行数

getPage

public ReportData getPage(int pageIndex)

取得报表的指定页。

参数:

pageIndex - 页码

返回:

报表数据

close

public void close()

关闭报表。

setParamValue

public void setParamValue(java.lang.String paramId,
                          java.lang.String paramValue)

设置参数值,不设置参数显示值。注意：在执行报表之前应该设置所有的参数值，否则报表执行会抛出错误。

参数:

paramId - 参数ID

paramValue - 参数值

setParamValue

public void setParamValue(java.lang.String paramId,
                          java.lang.String paramValue,
                          java.lang.String displayValue)

设置参数值。注意：在执行报表之前应该设置所有的参数值，否则报表执行会抛出错误。

参数:

paramId - 参数ID

paramValue - 参数值

displayValue - 参数显示值

doExport

public void doExport(java.lang.String type,
                     java.lang.String delimiter,
                     java.lang.String maxRow,
                     java.io.OutputStream os)

导出报表。注意：只有执行过后的报表才有数据导出，doExport不会自动执行报表。

参数:

type - 指定导出类型 EXCEL, TXT, CSV

delimiter - 指定分割符（EXCEL类型不需要）

maxRow - 指定最大行数

os - 指定报表输出流

doExport

public void doExport(java.lang.String type,
                     java.lang.String delimiter,
                     java.lang.String maxRow,
                     java.io.OutputStream os,
                     java.lang.String resourceBasePath)

参数:

type - 类型

delimiter - 分隔符

maxRow - 最大行数

os - 输出流

resourceBasePath - 资源基础路径

doExport

public void doExport(java.lang.String type,
                     java.lang.String delimiter,
                     java.lang.String maxRow,
                     java.io.OutputStream os,
                     java.lang.String resourceBasePath,
                     java.lang.String valueType)

参数:

type - 类型

delimiter - 分隔符

maxRow - 最大行数

os - 输出流

resourceBasePath - 资源基础路径

valueType - 值类型

doExport

public void doExport(java.lang.String type,
                     java.lang.String delimiter,
                     java.lang.String maxRow,
                     java.io.OutputStream os,
                     java.lang.String resourceBasePath,
                     java.lang.String valueType,
                     java.lang.String postData)

参数:

type - 类型

delimiter - 分隔符

maxRow - 最大行数

os - 输出流

resourceBasePath - 资源基础路径

valueType - 值类型

postData - 数据

setOrderByType

public void setOrderByType(java.lang.String fieldId,
                           java.lang.String orderType)

指定某个字段的排序方式。注意：只有在下一次执行时才有效。

参数:

fieldId - 字段ID

orderType - 排序方式 ASC, DESC, NONE

setFieldAggregate

public void setFieldAggregate(java.lang.String fieldId,
                              java.lang.String aggregate)

指定某个字段的聚合方式。注意：只有在下一次执行时才有效。

参数:

fieldId - 字段ID

aggregate - 聚合方式 SUM, MIN, MAX, COUNT, DISTINCT_COUNT, AVG, NULL

setAutoCondition

public void setAutoCondition(java.lang.String fieldId,
                             java.lang.String operator,
                             java.lang.String value)

指定报表过滤条件。注意：只有在下一次执行时才有效。

参数:

fieldId - 字段ID

operator - 过滤运算符 =, <, >

value - 条件值

setCustomCondition

public boolean setCustomCondition(CustomFilterDataBean filterData)

设置自定义过滤条件。注意：只有在下一次执行时才有效。

参数:

filterData - 过滤条件对象

返回:

true 设置成功，false设置失败

getParamStandbyValue

public java.util.List getParamStandbyValue(java.lang.String paramId)

获得某个参数的候选值列表

参数:

paramId - 参数Id

返回:

候选值列表，其元素类型为NameValuePair

cloneQuery

public java.lang.String cloneQuery(java.lang.String reportId,
                                   java.lang.String parentNodeId,
                                   java.lang.String name,
                                   java.lang.String alias,
                                   java.lang.String desc)

把报表查询结果复制在另一张新的报表中,注意：只有执行本类中的open()方法后的报表才能成功复制。

参数:

reportId - 原报表ID

parentNodeId - 放至目录ID

name - 报表名

alias - 报表别名

desc - 报表描述

返回:

新的报表

dump

public void dump(java.lang.String reportId)

读取报表数据

参数:

reportId - 报表ID

updateQuery

public void updateQuery()

修改报表

getClientConfig

public java.lang.String getClientConfig()

返回:

客户端配置

setClientConfig

public void setClientConfig(java.lang.String clientConfig)

参数:

clientConfig - 客户端配置

getExecutingState

public RunningInfo getExecutingState()

获取执行状态

返回:

执行状态