接口 com.fr.main.TemplateWorkBook
的使用

使用TemplateWorkBook的程序包

程序包	说明
com.fr.decision.extension.report
com.fr.fs.schedule.job
com.fr.fs.web
com.fr.io	这个包中定义了报表输入输出的接口和类.包括 基本的输入(Importer)接口和 输出(Exporter)接口; 抽象实现它们的(AbstractImporter)类和 (AbstractExporter类以及继承这两个类的各种输入和输出类如 Excel输入(ExcelImporter类, PDF输出(PDFExporter类等等.
com.fr.io.exporter
com.fr.io.exporter.factory
com.fr.io.exporter.wrapper
com.fr.io.importer
com.fr.main	报表工作簿（WordBook）的接口和实现类
com.fr.main.impl
com.fr.main.workbook
com.fr.page.cal.sheet
com.fr.report.cell.cellattr.core
com.fr.report.core.sheet
com.fr.report.fun	定义一些接口和抽象类
com.fr.report.poly	这个包定义了各种聚合块
com.fr.report.report	报表
com.fr.report.stable.fun
com.fr.report.worksheet	sheet 页相关
com.fr.report.write	这个包中定义了支持报表注释和报表数据校验的接口和类, 在填报系统中常常用到这个包.
com.fr.schedule
com.fr.schedule.extension.report
com.fr.schedule.extension.report.job.execute
com.fr.stable	定义了一些 Actor
com.fr.view.cal.sheet
com.fr.web.cache
com.fr.web.core
com.fr.web.core.service	引擎的后台代码
com.fr.web.reportlet
com.fr.write.cal.sheet
com.fr.write.web.excel

com.fr.decision.extension.report中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.decision.extension.report中的方法

限定符和类型	方法和说明
TemplateWorkBook	DecisionReportlet.createReport(ReportletRequest req) 生成Report

com.fr.fs.schedule.job中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.fs.schedule.job中的方法

限定符和类型	方法和说明
protected TemplateWorkBook	ViewReportletJob.getTemplateWorkBook(java.lang.String reportPath, java.util.Map parameterMap) 获取TemplateWorkBook

参数类型为TemplateWorkBook的com.fr.fs.schedule.job中的方法

限定符和类型	方法和说明
protected PageWorkBook	ViewReportletJob.fastUserNameFilter(java.util.Map parameterMap, TemplateWorkBook wbTpl, boolean sendAttach) 快速分发
protected void	ViewReportletJob.modifyBookBeforeExecute(TemplateWorkBook wbTpl)

com.fr.fs.web中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.fs.web中的方法

限定符和类型	方法和说明
TemplateWorkBook	FSReportlet.createReport(ReportletRequest req) 生成Report

com.fr.io中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.io中的方法

限定符和类型	方法和说明
static TemplateWorkBook	TemplateWorkBookIO.readTemplateWorkBook(java.lang.String tplPath) 从tplPath路径读出一个ReportTemplate 从当前目录读取一张cpt模板： Env env = FRContext.getCommonOperator(); WorkBook = TemplateWorkBookIO.readTemplateWorkBook(env,"\\doc\\Primary\\Parameter\\Parameter.cpt");
static TemplateWorkBook	TemplateWorkBookIO.readTemplateWorkBook(java.lang.String tplPath, java.lang.String prefix)

参数类型为TemplateWorkBook的com.fr.io中的方法

限定符和类型	方法和说明
static boolean	TemplateWorkBookIO.writeTemplateWorkBook(TemplateWorkBook tpl, java.lang.String tplPath) 保存某个报表到指定的工作目录

com.fr.io.exporter中TemplateWorkBook的使用

返回变量类型为TemplateWorkBook的类型的com.fr.io.exporter中的方法

限定符和类型	方法和说明
abstract ExporterWrapper<TemplateWorkBook>	DesignReportExportType.getExporterWrapper(TemplateWorkBook book)

参数类型为TemplateWorkBook的com.fr.io.exporter中的方法

限定符和类型	方法和说明
abstract ExporterWrapper<TemplateWorkBook>	DesignReportExportType.getExporterWrapper(TemplateWorkBook book)

com.fr.io.exporter.factory中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.io.exporter.factory中的方法

限定符和类型	方法和说明
TemplateWorkBook	DesignReportExporter.readTemplate(java.lang.String path)

返回变量类型为TemplateWorkBook的类型的com.fr.io.exporter.factory中的方法

限定符和类型	方法和说明
ExporterWrapper<TemplateWorkBook>	DesignReportExporter.getExporter(DesignExportType type, TemplateWorkBook tpl)

参数类型为TemplateWorkBook的com.fr.io.exporter.factory中的方法

限定符和类型	方法和说明
void	DesignReportExporter.beforeExport(DesignExportType type, java.lang.String path, java.util.Map<java.lang.String,java.lang.Object> para, TemplateWorkBook templateWorkBook)
ExporterWrapper<TemplateWorkBook>	DesignReportExporter.getExporter(DesignExportType type, TemplateWorkBook tpl)

com.fr.io.exporter.wrapper中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.io.exporter.wrapper中的方法

限定符和类型	方法和说明
void	ResultBookExporterWrapper.export(java.io.OutputStream outputStream, TemplateWorkBook templateWorkBook, java.util.Map<java.lang.String,java.lang.Object> para)
void	PageSetExporterWrapper.export(java.io.OutputStream outputStream, TemplateWorkBook templateWorkBook, java.util.Map<java.lang.String,java.lang.Object> para)

com.fr.io.importer中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.io.importer中的方法

限定符和类型	方法和说明
void	ExcelReportImporter.importExcel2Book(ReportSessionIDInfor reportSessionIDInfor, FineBook source, TemplateWorkBook template, java.util.Map<java.lang.String,java.lang.Object> map4Execute, boolean checkWidget)
void	ExcelReportCleanImporter.importExcel2Book(ReportSessionIDInfor reportSessionIDInfor, FineBook source, TemplateWorkBook template, java.util.Map<java.lang.String,java.lang.Object> map4Execute, boolean checkWidget)
void	ExcelReportImporter.importExcel2Book(WriteWorkBook book, FineBook source, TemplateWorkBook template, java.util.Map<java.lang.String,java.lang.Object> map4Execute) step 1：找到可能会有不定行扩展的扩展块，最多一个 how ：直接找是数据列的格子。
void	ExcelReportImporter.importExcel2Book(WriteWorkBook book, FineBook source, TemplateWorkBook template, java.util.Map<java.lang.String,java.lang.Object> map4Execute, boolean checkWidget) 把引入的excel生成的模板整合到原始的填报页面中 Excel导入的例子： TableDataSource source = TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "1.cpt"); TemplateWorkBook template = new WorkBook(); //excel文件数据生成的模板 ResultWorkBook book = ((WorkBook) source).execute(new HashMap(), new WriteActor()); ExcelReportImporter.importExcel2Book((WriteWorkBook)book, source, template, new HashMap());

com.fr.main中TemplateWorkBook的使用

实现TemplateWorkBook的com.fr.main中的类

限定符和类型	类和说明
class	AbstractTemplateWorkBook

返回TemplateWorkBook的com.fr.main中的方法

限定符和类型	方法和说明
TemplateWorkBook	SynchronizedReportSettings.getWbTpl()

参数类型为TemplateWorkBook的com.fr.main中的方法

限定符和类型	方法和说明
static void	SynchronizedReportSettings.putSynchronizedReportSettings(TemplateWorkBook tpl, ReportSettings reportSettings)
void	SynchronizedReportSettings.setWbTpl(TemplateWorkBook wbTpl)

com.fr.main.impl中TemplateWorkBook的使用

实现TemplateWorkBook的com.fr.main.impl中的类

限定符和类型	类和说明
class	AbstractWorkBookX 扩展模板格式抽象类，实现一些模板接口的方法
class	LinkWorkBookTemplate 链接模板文件
class	WebClassTemplateWorkBook
class	WorkBook Work main contains a series of work sheet.
class	WorkBookAdapter WorkBook 适配器
class	WorkBookTemplateDelegate
class	WorkBookX 扩展模板格式。

参数类型为TemplateWorkBook的com.fr.main.impl中的构造器

构造器和说明
WebClassTemplateWorkBook(java.lang.String classPath, TemplateWorkBook tpl)

com.fr.main.workbook中TemplateWorkBook的使用

实现TemplateWorkBook的com.fr.main.workbook中的类

限定符和类型	类和说明
class	ImmutableAnalyWorkBook 负责解析分析类型的文件
class	ImmutablePageWorkBook 负责解析分页类型的文件
class	ImmutableWorkBook

com.fr.page.cal.sheet中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.page.cal.sheet中的构造器

构造器和说明
PageWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap)

com.fr.report.cell.cellattr.core中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.report.cell.cellattr.core中的方法

限定符和类型	方法和说明
TemplateWorkBook	SubReport.getPackee()

参数类型为TemplateWorkBook的com.fr.report.cell.cellattr.core中的方法

限定符和类型	方法和说明
void	SubReport.setPackee(TemplateWorkBook packee)

参数类型为TemplateWorkBook的com.fr.report.cell.cellattr.core中的构造器

构造器和说明
SubReport(TemplateWorkBook packee)

com.fr.report.core.sheet中TemplateWorkBook的使用

声明为TemplateWorkBook的com.fr.report.core.sheet中的字段

限定符和类型	字段和说明
protected TemplateWorkBook	AbstractWorkBookExecutor.workBook

参数类型为TemplateWorkBook的com.fr.report.core.sheet中的构造器

构造器和说明
AbstractWorkBookExecutor(TemplateWorkBook workBook, java.util.Map<java.lang.String,java.lang.Object> parameterMap)
SheetSequenceExecutor(TemplateWorkBook workbook, java.util.Map<java.lang.String,java.lang.Object> parameterMap) 初始化一个SheetSequenceExecuter

com.fr.report.fun中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.report.fun中的方法

限定符和类型	方法和说明
TemplateWorkBook	ExcelImportProcessor.generateWorkBookByStream(java.io.InputStream in, java.lang.String fileName, java.util.Map<java.lang.String,java.lang.Object> parameterMap) 导入

参数类型为TemplateWorkBook的com.fr.report.fun中的方法

限定符和类型	方法和说明
void	ScheduleTemplateModifyProvider.modifyScheduleTemplate(TemplateWorkBook workBook) 修改定时任务报表, 例如增删sheet, 移除不需要的格子 或者某些预览需要的参数默认值, 定时任务用其他的参数等等.

com.fr.report.poly中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.report.poly中的方法

限定符和类型	方法和说明
TemplateWorkBook	PolyWorkSheet.getTemplateWorkBook()

参数类型为TemplateWorkBook的com.fr.report.poly中的方法

限定符和类型	方法和说明
void	PolyWorkSheet.setTemplateWorkBook(TemplateWorkBook templateWorkBook)

com.fr.report.report中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.report.report中的方法

限定符和类型	方法和说明
TemplateWorkBook	TemplateReport.getTemplateWorkBook() 获取TemplateWorkBook

参数类型为TemplateWorkBook的com.fr.report.report中的方法

限定符和类型	方法和说明
void	TemplateReport.setTemplateWorkBook(TemplateWorkBook templateWorkBook)

com.fr.report.stable.fun中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.report.stable.fun中的方法

限定符和类型	方法和说明
ReportCache	Actor.createReportCache(TemplateWorkBook tpl, ReportEntry reportEntry, java.util.Map parameterMap, boolean useCache) 生成模板的缓存对象
WorkBookExecutor	Actor.createWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap) 生成报表薄跨sheet计算器
ResultWorkBook	Actor.executeWorkBook(TemplateWorkBook workBook, java.util.Map parameterMap) 执行报表簿
ResultWorkBook	Actor.executeWorkBook(TemplateWorkBook workBook, java.util.Map parameterMap, int sheetIndex) 执行报表簿
ResultWorkBook	Actor.getResultBookFromCacheIfNeed(TemplateWorkBook tpl, java.lang.String tplPath, ReportCache reportCache, java.util.Map<java.lang.String,java.lang.Object> parameterMap, int sheetIndex) 从缓存中读取结果报表（如果有缓存）
long	Actor.updateCacheTime(TemplateWorkBook tpl) 更新缓存中的时间

com.fr.report.worksheet中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.report.worksheet中的方法

限定符和类型	方法和说明
TemplateWorkBook	WorkSheet.getTemplateWorkBook()
TemplateWorkBook	FormElementCase.getTemplateWorkBook()

参数类型为TemplateWorkBook的com.fr.report.worksheet中的方法

限定符和类型	方法和说明
void	WorkSheet.setTemplateWorkBook(TemplateWorkBook templateWorkBook)
void	FormElementCase.setTemplateWorkBook(TemplateWorkBook templateWorkBook)

com.fr.report.write中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.report.write中的方法

限定符和类型	方法和说明
static void	SubmitHelper.submit(WriteWorkBook resultBook, TemplateWorkBook templateBook, java.util.Map extraInfo) carl:表单提交 加载报表1.cpt计算并提交所有sheet： FRContext.setCurrentEnv(new LocalEnv("c:/Program Files/FineReport_7.1/WebReport/WEB-INF")); ModuleContext.startModule(EngineModule.class.getName()); WorkBook workbook = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "1.cpt"); Map paraMap = ReportWebUtils.dealWithReportParameters(workbook, new HashMap()); ReportUtils.submit((WriteWorkBook) resultWorkBook, workbook, paraMap);
static void	SubmitHelper.submit(WriteWorkBook resultBook, TemplateWorkBook templateBook, java.util.Map extraInfo, int reportIndex, boolean isAllSheet) 单个sheet提交的时候调用这个,isAllSheet应该是false 加载报表1.cpt计算并提交第一个sheet： FRContext.setCurrentEnv(new LocalEnv("c:/Program Files/FineReport_7.1/WebReport/WEB-INF")); ModuleContext.startModule(EngineModule.class.getName()); WorkBook workbook = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "1.cpt"); Map paraMap = ReportWebUtils.dealWithReportParameters(workbook, new HashMap()); ReportUtils.submit((WriteWorkBook) resultWorkBook, workbook, paraMap, 0, false);
static void	SubmitHelper.submit(WriteWorkBook resultBook, TemplateWorkBook templateBook, java.util.Map extraInfo, int reportIndex, boolean isAllSheet, java.util.Map allSheetConnMap) 单sheet提交和多sheet提交都会走这里

com.fr.schedule中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.schedule中的方法

限定符和类型	方法和说明
TemplateWorkBook	ScheduleSearch.search(TemplateWorkBook workBookDefine, java.util.Map map4Execute, Actor showType)

参数类型为TemplateWorkBook的com.fr.schedule中的方法

限定符和类型	方法和说明
TemplateWorkBook	ScheduleSearch.search(TemplateWorkBook workBookDefine, java.util.Map map4Execute, Actor showType)

com.fr.schedule.extension.report中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.schedule.extension.report中的方法

限定符和类型	方法和说明
TemplateWorkBook	ImmutableReportlet.createReport(ReportletRequest req) 创建报表

com.fr.schedule.extension.report.job.execute中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.schedule.extension.report.job.execute中的方法

限定符和类型	方法和说明
WriteWorkBook	ExecuteWritePlusJob.getWriteWorkBook(TemplateWorkBook wbTpl, java.util.Map<java.lang.String,java.lang.Object> parameterMap)
WriteWorkBook	ExecuteWriteJob.getWriteWorkBook(TemplateWorkBook wbTpl, java.util.Map<java.lang.String,java.lang.Object> parameterMap)

com.fr.stable中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.stable中的方法

限定符和类型	方法和说明
ReportCache	PageActor.createReportCache(TemplateWorkBook tpl, ReportEntry reportEntry, java.util.Map parameterMap, boolean useCache) 生成模板的缓存对象
ReportCache	AbstractActor.createReportCache(TemplateWorkBook tpl, ReportEntry reportEntry, java.util.Map parameterMap, boolean useCache) 生成模板的缓存对象
WorkBookExecutor	PageActor.createWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap) 生成报表薄跨sheet计算器
WorkBookExecutor	ViewActor.createWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap) 生成报表薄跨sheet计算器
WorkBookExecutor	WriteActor.createWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap) 生成报表薄跨sheet计算器
ResultWorkBook	AbstractActor.executeWorkBook(TemplateWorkBook workBook, java.util.Map parameterMap)
ResultWorkBook	AbstractActor.executeWorkBook(TemplateWorkBook workBook, java.util.Map parameterMap, int sheetIndex) 执行报表簿
ResultWorkBook	PageActor.getResultBookFromCacheIfNeed(TemplateWorkBook tpl, java.lang.String tplPath, ReportCache reportCache, java.util.Map<java.lang.String,java.lang.Object> parameterMap, int sheetIndex) 从缓存中读取结果报表（如果有缓存）
ResultWorkBook	AbstractActor.getResultBookFromCacheIfNeed(TemplateWorkBook tpl, java.lang.String tplPath, ReportCache reportCache, java.util.Map<java.lang.String,java.lang.Object> parameterMap, int sheetIndex)
long	AbstractActor.updateCacheTime(TemplateWorkBook tpl) 更新缓存中的时间

com.fr.view.cal.sheet中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.view.cal.sheet中的构造器

构造器和说明
AnalyWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap)
EditWorkBookExecutor(TemplateWorkBook workBook, java.util.Map parameterMap)

com.fr.web.cache中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.web.cache中的方法

限定符和类型	方法和说明
TemplateWorkBook	ReportEntry.getWorkBookTemplate()

参数类型为TemplateWorkBook的com.fr.web.cache中的方法

限定符和类型	方法和说明
ResultWorkBook	ReportCache.getResultWorkBook(TemplateWorkBook workBookDefine) 从模板中生成结果报表对象并缓存起来

com.fr.web.core中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.web.core中的方法

限定符和类型	方法和说明
abstract TemplateWorkBook	Reportlet.createReport(ReportletRequest req) 生成报表
TemplateWorkBook	ReportSessionIDInfor.getWorkBookDefine() 获取book
TemplateWorkBook	ReportSession.getWorkBookDefine()
TemplateWorkBook	TemplateWorkBookSearch.search(TemplateWorkBook workBookDefine, java.util.Map map4Execute, Actor showType)

参数类型为TemplateWorkBook的com.fr.web.core中的方法

限定符和类型	方法和说明
static java.util.Map	ReportWebUtils.dealWithReportParameters(TemplateWorkBook tpl, java.util.Map map4Execute) 处理模板参数
TemplateWorkBook	TemplateWorkBookSearch.search(TemplateWorkBook workBookDefine, java.util.Map map4Execute, Actor showType)

参数类型为TemplateWorkBook的com.fr.web.core中的构造器

构造器和说明
ReportSessionIDInfor(java.util.Map paraMap, TemplateWorkBook workBookTemplate, java.lang.String bookPath, Actor policy)

com.fr.web.core.service中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.web.core.service中的方法

限定符和类型	方法和说明
static boolean	WriteSubmitReportAction.isSetSubmit(TemplateWorkBook templateBook, java.lang.String reportIndex) 没有设置填报属性要区分出来

com.fr.web.reportlet中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.web.reportlet中的方法

限定符和类型	方法和说明
TemplateWorkBook	WebClassReportlet.createReport(ReportletRequest req)
TemplateWorkBook	TemplateReportlet.createReport(ReportletRequest req) 从req中创建报表
TemplateWorkBook	GroupTemplateReportlet.createReport(ReportletRequest req) carl：把所有的report都生成，然后合成一个大的workbook TODO 缺陷，不同的报表设置也不同，但是合在一起后，势必就一样了。
TemplateWorkBook	EmbeddedTplReportlet.createReport(ReportletRequest req) 从Request中创建模板

类型变量类型为TemplateWorkBook的com.fr.web.reportlet中的方法参数

限定符和类型	方法和说明
static void	GroupTemplateReportlet.createReportsFromReportlets(java.lang.String reportletsInfo, java.util.List<java.lang.String> reportPathList, java.util.List<TemplateWorkBook> reportTemplateList, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> paraMapList, ReportletRequest req) 根据reportlets参数构建多个模板

com.fr.write.cal.sheet中TemplateWorkBook的使用

参数类型为TemplateWorkBook的com.fr.write.cal.sheet中的构造器

构造器和说明
WriteWorkBookExecutor(TemplateWorkBook workBook, java.util.Map<java.lang.String,java.lang.Object> parameterMap)

com.fr.write.web.excel中TemplateWorkBook的使用

返回TemplateWorkBook的com.fr.write.web.excel中的方法

限定符和类型	方法和说明
static TemplateWorkBook	WebExcelUtils.customizedDealWithUploadExcel(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Map<java.lang.String,java.lang.Object> paraMap) 把上传的excel转成模板(自定义)
static TemplateWorkBook	WebExcelUtils.dealWithUploadExcel(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) 把上传的excel转成模板
static TemplateWorkBook	WebExcelUtils.dealWithUploadExcel(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.util.Map<java.lang.String,java.lang.Object> paraMap) 把上传的excel转成模板
TemplateWorkBook	ExcelImportPlusProcessor.generateWorkBookByStream(java.io.InputStream inputStream, java.lang.String s, java.util.Map<java.lang.String,java.lang.Object> map)
TemplateWorkBook	DefaultExcelImporterProcessor.generateWorkBookByStream(java.io.InputStream is, java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> paraMap)
TemplateWorkBook	CustomizeExcelImportProcessor.generateWorkBookByStream(java.io.InputStream inputStream, java.lang.String s, java.util.Map<java.lang.String,java.lang.Object> map)