net.sohelp.boot.engine.web.report

类 DBReportProvider

java.lang.Object

net.sohelp.boot.engine.web.report.DBReportProvider

所有已实现的接口:

com.bstek.ureport.provider.report.ReportProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class DBReportProvider
extends Object
implements com.bstek.ureport.provider.report.ReportProvider, org.springframework.context.ApplicationContextAware

自定义报表数据源，用于从数据库加载报表文件

从以下版本开始:

2024/7/31 10:50

作者:

AaronFung

构造器概要

构造器

构造器和说明
DBReportProvider()

方法概要

限定符和类型	方法和说明
void	deleteReport(String file) 删除指定的报表文件 该方法会解析传入的文件路径字符串，验证其格式是否符合要求（必须包含两级目录和文件名， 格式为：xxx/yyy!
boolean	disabled() 判断当前报告提供器是否被禁用
String	getName() 获取报表系统的名称。
String	getPrefix()
List<com.bstek.ureport.provider.report.ReportFile>	getReportFiles() 获取报表文件列表
InputStream	loadReport(String file) 加载报表文件并返回输入流
void	saveReport(String file, String content) 保存报表内容到数据库
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext) 设置应用上下文，并初始化文件存储目录。
void	setDisabled(boolean disabled) 设置报表是否禁用状态
void	setFileStoreDir(String fileStoreDir) 设置文件存储目录

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

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

构造器详细资料

DBReportProvider

public DBReportProvider()

方法详细资料

loadReport

public InputStream loadReport(String file)

加载报表文件并返回输入流

指定者:

loadReport 在接口中 com.bstek.ureport.provider.report.ReportProvider

参数:

file - 报表文件路径，格式为"/目录名/报表名!报表类型"

返回:

包含报表XML内容的输入流

抛出:

com.bstek.ureport.exception.ReportException - 当文件格式不正确或报表不存在时抛出异常

deleteReport

public void deleteReport(String file)

删除指定的报表文件

该方法会解析传入的文件路径字符串，验证其格式是否符合要求（必须包含两级目录和文件名， 格式为：xxx/yyy!zzz），然后调用uReportService删除对应的报表。

指定者:

deleteReport 在接口中 com.bstek.ureport.provider.report.ReportProvider

参数:

file - 要删除的报表文件路径，格式应为：一级目录/二级目录!文件名!扩展名

抛出:

com.bstek.ureport.exception.ReportException - 当文件格式不正确或数据库操作出错时抛出

RuntimeException - 当业务异常发生时抛出

getReportFiles

public List<com.bstek.ureport.provider.report.ReportFile> getReportFiles()

获取报表文件列表

指定者:

getReportFiles 在接口中 com.bstek.ureport.provider.report.ReportProvider

返回:

返回一个空的报表文件列表

getName

public String getName()

获取报表系统的名称。

指定者:

getName 在接口中 com.bstek.ureport.provider.report.ReportProvider

返回:

返回报表系统的名称字符串"报表系统"。

saveReport

public void saveReport(String file,
                       String content)

保存报表内容到数据库

指定者:

saveReport 在接口中 com.bstek.ureport.provider.report.ReportProvider

参数:

file - 文件路径，格式应为"目录/类型/名称!扩展名"（例如：report/type/name!ext）

content - 要保存的报表内容

抛出:

com.bstek.ureport.exception.ReportException - 当文件格式不正确或保存过程中出现错误时抛出 1. 文件路径格式不正确时抛出 2. 数据库操作异常时抛出包含SQL错误信息的异常 3. 业务异常时抛出原始业务异常

disabled

public boolean disabled()

判断当前报告提供器是否被禁用

指定者:

disabled 在接口中 com.bstek.ureport.provider.report.ReportProvider

返回:

如果禁用则返回true，否则返回false

setDisabled

public void setDisabled(boolean disabled)

设置报表是否禁用状态

参数:

disabled - true表示禁用报表，false表示启用报表

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

设置应用上下文，并初始化文件存储目录。 当前实现中仅检查文件存储目录是否存在，注释掉的代码部分展示了 如何在Web应用上下文中基于ServletContext动态设置文件存储路径。

指定者:

setApplicationContext 在接口中 org.springframework.context.ApplicationContextAware

参数:

applicationContext - 应用上下文对象，用于获取应用环境信息

抛出:

org.springframework.beans.BeansException - 当处理应用上下文时发生异常

setFileStoreDir

public void setFileStoreDir(String fileStoreDir)

设置文件存储目录

参数:

fileStoreDir - 文件存储目录路径

getPrefix

public String getPrefix()

指定者:

getPrefix 在接口中 com.bstek.ureport.provider.report.ReportProvider

返回:

返回报表文件名前缀