smartbi.sdk.service.simplereport
类 _ClientReportService

java.lang.Object
  继承者 smartbi.sdk.service.simplereport._ClientReportService
直接已知子类:
ClientCombinedReportService

public class _ClientReportService
extends java.lang.Object

内部对象。封装的远端的ClientReportService


字段摘要
protected  ClientConnector connector
           
 
构造方法摘要
_ClientReportService(ClientConnector connector)
          构造函数
 
方法摘要
 java.lang.String cloneQuery(java.lang.String clientId, java.lang.String parentNodeId, java.lang.String name, java.lang.String alias, java.lang.String desc)
           
 void dump(java.lang.String clientId, java.lang.String reportId)
           
 int executeQuery(java.lang.String clientId)
          执行报表
 java.util.List getFieldDistinctValues(java.lang.String clientId, java.lang.String fieldId)
          获取报表中某字段的所有可能值
 java.lang.String getFunctionValue(java.lang.String clientId, java.lang.String func)
          取得一个表达式的值
 java.util.List getParamStandbyValue(java.lang.String clientId, java.lang.String paramId)
          获得某个参数的候选值列表
 ReportData getRawReportData(java.lang.String clientId, int pageNum)
          获得原始报表数据
 ReportData getReportData(java.lang.String clientId, int pageNum)
          获得报表数据
 ClientReportView openQuery(java.lang.String queryId)
          打开一个报表
 ClientReportView openQueryWithoutInit(java.lang.String queryId)
          打开一个报表
 boolean overwriteQuery(java.lang.String clientId, java.lang.String replacedReportId, java.lang.String desc)
           
 void removeFromSession(java.lang.String clientId)
          将报表信息从服务端的会话状态中清除。
 boolean setAutoCondition(java.lang.String clientId, java.lang.String fieldId, java.lang.String operator, java.lang.String value)
          设置过滤条件
 void setClientConfig(java.lang.String clientId, java.lang.String clientConfig)
           
 boolean setCustomCondition(java.lang.String clientId, CustomFilterDataBean filterData)
          设置自定义过滤条件
 boolean setFieldAggregate(java.lang.String clientId, java.lang.String fieldId, java.lang.String aggregate)
          设置字段聚合方式
 boolean setOrderByType(java.lang.String clientId, java.lang.String fieldId, java.lang.String orderType)
          设置报表的排序字段
 boolean setParamValue(java.lang.String clientId, java.lang.String paramId, java.lang.String paramValue, java.lang.String paramDisplayValue)
          设置参数值。
 boolean setParamValueByName(java.lang.String clientId, java.lang.String paramId, java.lang.String paramValue, java.lang.String paramDisplayValue)
          设置参数值。
 void setRowsPerPage(java.lang.String clientId, int rowsPerPage)
          设置每页的行数
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

字段详细信息

connector

protected ClientConnector connector
构造方法详细信息

_ClientReportService

public _ClientReportService(ClientConnector connector)
构造函数

参数:
connector - 应用连接器
方法详细信息

openQuery

public ClientReportView openQuery(java.lang.String queryId)
打开一个报表

参数:
queryId - 报表ID
返回:
返回打开的报表视图

openQueryWithoutInit

public ClientReportView openQueryWithoutInit(java.lang.String queryId)
打开一个报表

参数:
queryId - 报表ID
返回:
返回打开的报表视图

getFunctionValue

public java.lang.String getFunctionValue(java.lang.String clientId,
                                         java.lang.String func)
取得一个表达式的值

参数:
clientId - 客户ID
func - 表达式
返回:

setRowsPerPage

public void setRowsPerPage(java.lang.String clientId,
                           int rowsPerPage)
设置每页的行数

参数:
clientId - 客户ID
rowsPerPage - 每页行数

executeQuery

public int executeQuery(java.lang.String clientId)
执行报表

参数:
clientId - 客户ID
返回:
报表的总行数

getReportData

public ReportData getReportData(java.lang.String clientId,
                                int pageNum)
获得报表数据

参数:
clientId - 客户ID
pageNum - 报表页码,指定获取报表的第几页,从0算起
返回:
报表数据

removeFromSession

public void removeFromSession(java.lang.String clientId)
将报表信息从服务端的会话状态中清除。

参数:
clientId - 客户ID

setParamValue

public boolean setParamValue(java.lang.String clientId,
                             java.lang.String paramId,
                             java.lang.String paramValue,
                             java.lang.String paramDisplayValue)
设置参数值。

参数:
clientId - 客户ID
paramId - 参数ID
paramValue - 参数值
paramDisplayValue - 参数显示值
返回:
是否设置成功

setParamValueByName

public boolean setParamValueByName(java.lang.String clientId,
                                   java.lang.String paramId,
                                   java.lang.String paramValue,
                                   java.lang.String paramDisplayValue)
设置参数值。

参数:
clientId - 客户ID
paramId - 参数ID
paramValue - 参数值
paramDisplayValue - 参数显示值
返回:
是否设置成功

setOrderByType

public boolean setOrderByType(java.lang.String clientId,
                              java.lang.String fieldId,
                              java.lang.String orderType)
设置报表的排序字段

参数:
clientId - 客户ID
fieldId - 字段ID
orderType - 排序方式, ASC, DESC, NONE
返回:
是否设置成功

setFieldAggregate

public boolean setFieldAggregate(java.lang.String clientId,
                                 java.lang.String fieldId,
                                 java.lang.String aggregate)
设置字段聚合方式

参数:
clientId - 客户ID
fieldId - 字段ID
aggregate - 聚合方式 SUM, MIN, MAX, COUNT, DISTINCT_COUNT, AVG, NULL
返回:
是否设置成功

getFieldDistinctValues

public java.util.List getFieldDistinctValues(java.lang.String clientId,
                                             java.lang.String fieldId)
获取报表中某字段的所有可能值

参数:
clientId - 客户ID
fieldId - 字段ID
返回:
值列表

setAutoCondition

public boolean setAutoCondition(java.lang.String clientId,
                                java.lang.String fieldId,
                                java.lang.String operator,
                                java.lang.String value)
设置过滤条件

参数:
clientId - 客户ID
fieldId - 字段ID
operator - 操作符 =, >, <
value - 条件值
返回:
是否设置成功

setCustomCondition

public boolean setCustomCondition(java.lang.String clientId,
                                  CustomFilterDataBean filterData)
设置自定义过滤条件

参数:
clientId - 报表客户端ID
filterData - 过滤条件对象
返回:
是否设置成

getRawReportData

public ReportData getRawReportData(java.lang.String clientId,
                                   int pageNum)
获得原始报表数据

参数:
clientId - 客户ID
pageNum - 页码
返回:
原始报表数据

getParamStandbyValue

public java.util.List getParamStandbyValue(java.lang.String clientId,
                                           java.lang.String paramId)
获得某个参数的候选值列表

参数:
clientId - 客户Id
paramId - 参数Id
返回:
候选值列表,其元素类型为NameValuePair

cloneQuery

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

dump

public void dump(java.lang.String clientId,
                 java.lang.String reportId)

overwriteQuery

public boolean overwriteQuery(java.lang.String clientId,
                              java.lang.String replacedReportId,
                              java.lang.String desc)

setClientConfig

public void setClientConfig(java.lang.String clientId,
                            java.lang.String clientConfig)