com.fr.main.workbook

类 ImmutableWorkBook

java.lang.Object

com.fr.main.AbstractImportJsCssProvider

com.fr.main.workbook.ImmutableWorkBook

所有已实现的接口:

AttrMark, ParameterHolder, TableDataSource, FineBook, TemplateWorkBook, FitProvider, ScheduleTemplateWorkBookProvider, FCloneable, XMLable, XMLReadable, XMLWriter, ImportJsCssProvider, java.io.Serializable, java.lang.Cloneable

直接已知子类:

ImmutableAnalyWorkBook, ImmutablePageWorkBook

public abstract class ImmutableWorkBook
extends AbstractImportJsCssProvider
implements TemplateWorkBook

从以下版本开始:

8.0

作者:

richie

另请参阅:

序列化表格

字段概要

从接口继承的字段 com.fr.data.TableDataSource

KEY

从接口继承的字段 com.fr.stable.xml.XMLable

XML_TAG

从接口继承的字段 com.fr.web.ImportJsCssProvider

XML_TAG

构造器概要

构造器

构造器和说明
ImmutableWorkBook()

方法概要

方法

限定符和类型	方法和说明
void	addReport(java.lang.String reportName, TemplateReport report) 添加报表
void	addReport(TemplateReport report) 添加报表
void	apply4Parameters(java.util.Map parameterMap) 处理参数值
void	clearAllTableData() 清除所有的数据集
java.lang.Object	clone()
PageWorkBook	execute(java.util.Map parameterMap, Actor actor) 预览计算 因为是从本地文件读取的, 所以默认会缓存一份下来, 用于获取一些workbook的属性.
ResultWorkBook	execute(java.util.Map parameterMap, Actor actor, int sheetIndex) 根据给定的参数集和预览方式执行后获取结果报表簿
protected abstract java.lang.String	getPath()
ReportExportAttr	getReportExportAttr() Gets report export attributes.
ReportFitAttr	getReportFitAttr()
int	getReportIndex(TemplateReport report) 获取给定report的index
ElementCaseMobileAttr	getReportMobileAttr()
ReportParameterAttr	getReportParameterAttr() 获取参数属性
TableData	getTableData(java.lang.String name) 返回该对象中指定名字的数据集
java.util.Iterator	getTableDataNameIterator() 返回该对象所包含的所有数据集名的一个迭代
TemplateReport	getTemplateReport(int index) 获取指定位置的TemplateReport
void	putTableData(java.lang.String name, TableData innerTableData) 放入数据集
void	readXML(XMLableReader reader) 读取子节点，应该会被XMLableReader.readXMLObject()调用多次
void	removeReport(int index) 删除指定的报表
void	removeReport(java.lang.String reportName) 删除指定的报表
void	removeReports() 删除所有报表
void	removeTableData(java.lang.String name) 删除数据集
boolean	renameTableData(java.lang.String oldName, java.lang.String newName) 重命名TableData
void	setReport(int index, java.lang.String reportName, TemplateReport report) 设置指定位置的带Name的Report
void	setReport(int index, TemplateReport report) 设置指定位置的Report
void	setReportExportAttr(ReportExportAttr reportExportAttr) Sets report export attributes.
void	setReportFitAttr(ReportFitAttr fitAttr)
void	setReportName(int index, java.lang.String reportName) 设置指定index的Report的Name
void	setReportParameterAttr(ReportParameterAttr reportParameterAttr) 设置参数属性
void	setReportWebAttr(ReportWebAttr reportWebAttr) Sets report web attributes.
void	writeXML(XMLPrintWriter writer) Write XML.

从类继承的方法 com.fr.main.AbstractImportJsCssProvider

addAttrMark, getAllMarkName, getAttrMark, getCSSImport, getJSImport, setReportMobileAttr

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

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

从接口继承的方法 com.fr.main.TemplateWorkBook

getTemplateElementCaseReport

从接口继承的方法 com.fr.main.FineBook

getElementCaseReport, getReport, getReportCount, getReportName, getReportWebAttr, isElementCaseBook, isElementCaseBook, setReportMobileAttr

从接口继承的方法 com.fr.base.io.AttrMark

addAttrMark, getAllMarkName, getAttrMark

从接口继承的方法 com.fr.web.ImportJsCssProvider

getCSSImport, getJSImport

从接口继承的方法 com.fr.base.ParameterHolder

getParameters

构造器详细资料

ImmutableWorkBook

public ImmutableWorkBook()

方法详细资料

putTableData

public void putTableData(java.lang.String name,
                TableData innerTableData)

放入数据集

指定者:

putTableData 在接口中 TableDataSource

参数:

name - 名称

innerTableData - 数据集

removeReport

public void removeReport(java.lang.String reportName)

删除指定的报表

指定者:

removeReport 在接口中 FineBook

参数:

reportName - 报表名

removeReport

public void removeReport(int index)

删除指定的报表

指定者:

removeReport 在接口中 FineBook

参数:

index - 指定的序列

removeReports

public void removeReports()

删除所有报表

指定者:

removeReports 在接口中 FineBook

removeTableData

public void removeTableData(java.lang.String name)

删除数据集

指定者:

removeTableData 在接口中 TableDataSource

参数:

name - 指定的名称

renameTableData

public boolean renameTableData(java.lang.String oldName,
                      java.lang.String newName)

重命名TableData

指定者:

renameTableData 在接口中 TableDataSource

参数:

oldName - 旧的名字

newName - 新的名字

返回:

是否成功

setReport

public void setReport(int index,
             TemplateReport report)

从接口复制的说明: TemplateWorkBook

设置指定位置的Report

指定者:

setReport 在接口中 TemplateWorkBook

参数:

index - 指定的index

report - 设置过去的report

setReport

public void setReport(int index,
             java.lang.String reportName,
             TemplateReport report)

从接口复制的说明: TemplateWorkBook

设置指定位置的带Name的Report

指定者:

setReport 在接口中 TemplateWorkBook

参数:

index - 指定位置

reportName - 新增的Report的Name

report - 新增的report

setReportName

public void setReportName(int index,
                 java.lang.String reportName)

从接口复制的说明: FineBook

设置指定index的Report的Name

指定者:

setReportName 在接口中 FineBook

参数:

index - 指定的index

reportName - 指定的Name

setReportWebAttr

public void setReportWebAttr(ReportWebAttr reportWebAttr)

从接口复制的说明: FineBook

Sets report web attributes.

指定者:

setReportWebAttr 在接口中 FineBook

getReportParameterAttr

public ReportParameterAttr getReportParameterAttr()

从接口复制的说明: TemplateWorkBook

获取参数属性

指定者:

getReportParameterAttr 在接口中 TemplateWorkBook

setReportParameterAttr

public void setReportParameterAttr(ReportParameterAttr reportParameterAttr)

从接口复制的说明: TemplateWorkBook

设置参数属性

指定者:

setReportParameterAttr 在接口中 TemplateWorkBook

addReport

public void addReport(TemplateReport report)

添加报表

指定者:

addReport 在接口中 TemplateWorkBook

参数:

report - 添加的报表

addReport

public void addReport(java.lang.String reportName,
             TemplateReport report)

添加报表

指定者:

addReport 在接口中 TemplateWorkBook

参数:

reportName - 报表名

report - 添加的报表

clearAllTableData

public void clearAllTableData()

清除所有的数据集

指定者:

clearAllTableData 在接口中 TableDataSource

getTableData

public TableData getTableData(java.lang.String name)

从接口复制的说明: TableDataSource

返回该对象中指定名字的数据集

指定者:

getTableData 在接口中 TableDataSource

参数:

name - 数据集的名字

返回:

数据集

getTableDataNameIterator

public java.util.Iterator getTableDataNameIterator()

从接口复制的说明: TableDataSource

返回该对象所包含的所有数据集名的一个迭代

指定者:

getTableDataNameIterator 在接口中 TableDataSource

getTemplateReport

public TemplateReport getTemplateReport(int index)

从接口复制的说明: TemplateWorkBook

获取指定位置的TemplateReport

指定者:

getTemplateReport 在接口中 TemplateWorkBook

参数:

index - 指定的索引

readXML

public void readXML(XMLableReader reader)

从接口复制的说明: XMLReadable

读取子节点，应该会被XMLableReader.readXMLObject()调用多次

指定者:

readXML 在接口中 XMLReadable

参数:

reader - XML读取对象

另请参阅:

XMLableReader

writeXML

public void writeXML(XMLPrintWriter writer)

从接口复制的说明: XMLWriter

Write XML.
The method will be invoked when save data to XML file.
May override the method to save your own data. 从性能上面考虑，大家用writer.print(), 而不是writer.println()

指定者:

writeXML 在接口中 XMLWriter

参数:

writer - XML写入对象

getReportFitAttr

public ReportFitAttr getReportFitAttr()

指定者:

getReportFitAttr 在接口中 FitProvider

setReportFitAttr

public void setReportFitAttr(ReportFitAttr fitAttr)

指定者:

setReportFitAttr 在接口中 FitProvider

getReportExportAttr

public ReportExportAttr getReportExportAttr()

从接口复制的说明: FineBook

Gets report export attributes.

指定者:

getReportExportAttr 在接口中 FineBook

setReportExportAttr

public void setReportExportAttr(ReportExportAttr reportExportAttr)

从接口复制的说明: FineBook

Sets report export attributes.

指定者:

setReportExportAttr 在接口中 FineBook

getReportIndex

public int getReportIndex(TemplateReport report)

从接口复制的说明: TemplateWorkBook

获取给定report的index

指定者:

getReportIndex 在接口中 TemplateWorkBook

参数:

report - 给定的report

execute

public ResultWorkBook execute(java.util.Map parameterMap,
                     Actor actor,
                     int sheetIndex)

从接口复制的说明: TemplateWorkBook

根据给定的参数集和预览方式执行后获取结果报表簿

指定者:

execute 在接口中 TemplateWorkBook

参数:

parameterMap - 参数集

actor - 预览方式

sheetIndex - 要计算的sheet索引

返回:

结果报表薄

apply4Parameters

public void apply4Parameters(java.util.Map parameterMap)

处理参数值

指定者:

apply4Parameters 在接口中 TemplateWorkBook

参数:

parameterMap - 参数map

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

指定者:

clone 在接口中 FCloneable

覆盖:

clone 在类中 AbstractImportJsCssProvider

返回:

克隆后的对象

抛出:

java.lang.CloneNotSupportedException - 如果克隆失败则抛出此异常

getPath

protected abstract java.lang.String getPath()

execute

public PageWorkBook execute(java.util.Map parameterMap,
                   Actor actor)

预览计算 因为是从本地文件读取的, 所以默认会缓存一份下来, 用于获取一些workbook的属性.

指定者:

execute 在接口中 TemplateWorkBook

参数:

parameterMap - 参数map

actor - 预览方式

返回:

结果报表

getReportMobileAttr

public ElementCaseMobileAttr getReportMobileAttr()

指定者:

getReportMobileAttr 在接口中 FineBook

覆盖:

getReportMobileAttr 在类中 AbstractImportJsCssProvider