net.sohelp.boot.engine.web.report

类 MagicApiDatasource

java.lang.Object

net.sohelp.boot.engine.web.report.MagicApiDatasource

public class MagicApiDatasource
extends Object

MagicApi数据源针对 UReport

从以下版本开始:

2024/8/2 9:48

作者:

AaronFung

构造器概要

构造器

构造器和说明
MagicApiDatasource()
MagicApiDatasource(org.ssssssss.magicapi.core.service.MagicAPIService magicAPIService) 构造函数，用于初始化MagicApiDatasource对象。

方法概要

限定符和类型	方法和说明
List<Map<String,Object>>	getByApi(String dsName, String dataSetName, Map<String,Object> parameters) 通过API获取报表数据
List<Map<String,Object>>	getByFunction(String dsName, String dataSetName, Map<String,Object> parameters) 根据数据集名称和参数从MagicAPI获取数据
List<Map<String,Object>>	getByTest(String dsName, String dataSetName, Map<String,Object> parameters) 根据测试条件从指定数据集获取数据

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

MagicApiDatasource

public MagicApiDatasource()

MagicApiDatasource

public MagicApiDatasource(org.ssssssss.magicapi.core.service.MagicAPIService magicAPIService)

构造函数，用于初始化MagicApiDatasource对象。

参数:

magicAPIService - MagicAPIService实例，用于提供API服务

方法详细资料

getByFunction

public List<Map<String,Object>> getByFunction(String dsName,
                                              String dataSetName,
                                              Map<String,Object> parameters)
                                       throws BusiException

根据数据集名称和参数从MagicAPI获取数据

参数:

dsName - 数据源名称（未在函数中使用，但作为参数保留）

dataSetName - 数据集名称，不能为空且必须以"/"开头或为空字符串（函数内部会处理路径）

parameters - 查询参数Map

返回:

返回包含字段数据的List>结构

抛出:

BusiException - 当数据集名称为空或返回数据格式错误时抛出

getByApi

public List<Map<String,Object>> getByApi(String dsName,
                                         String dataSetName,
                                         Map<String,Object> parameters)
                                  throws BusiException

通过API获取报表数据

参数:

dsName - 数据源名称（未在函数内直接使用，可能用于后续扩展）

dataSetName - 数据集名称，用于构建API路径

parameters - 请求参数，以Map形式传递

返回:

返回包含报表数据的List，每个元素是一个Map

抛出:

BusiException - 当返回数据格式错误时抛出异常（如dataMap为空或缺少field字段）

getByTest

public List<Map<String,Object>> getByTest(String dsName,
                                          String dataSetName,
                                          Map<String,Object> parameters)
                                   throws BusiException

根据测试条件从指定数据集获取数据

参数:

dsName - 数据源名称（未在代码中使用，可能是预留参数）

dataSetName - 数据集名称，用于构建请求路径

parameters - 查询参数，会传递给magicAPI服务

返回:

包含查询结果的列表，列表中的每个元素是一个Map对象

抛出:

BusiException - 当返回数据格式错误时抛出异常（如返回为空、字段不存在等）