public class WorkBookAdapter extends WorkBook
AbstractFineBook.ReportWriter
STRING_TO_FORMULA, XML_TAG
reportParameterAttr
fitAttr, mobileAttr, reportExportAttr, reportWebAttr
ANA_PREVIEW_TYPE, DEFAULT_PREVIEW_TYPE, WRITE_ENHANCE_PREVIEW_TYPE, WRITE_PREVIEW_TYPE
tableDataList
KEY
构造器和说明 |
---|
WorkBookAdapter()
初始化一个WorkBook
|
WorkBookAdapter(WorkBookX workBookX)
初始化一个WorkBook
|
限定符和类型 | 方法和说明 |
---|---|
void |
addAttrMark(IOFileAttrMark attrMark)
给模板对象添加额外的属性
|
protected void |
addReport(int index,
java.lang.String reportName,
Report report)
添加结果报表
|
void |
addReport(int index,
java.lang.String reportName,
TemplateReport report)
增加报表
|
void |
addReport(int index,
TemplateReport report)
增加报表
可以把多个模板整合在一起进行操作,比如导出,但是模板的主体属性比如数据集、模板参数等不一致的话会有问题:
WorkBook workbook1 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook1.cpt");
WorkBook workbook2 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook2.cpt");
for (int i=0; i |
protected void |
addReport(Report report)
添加结果报表
|
void |
addReport(java.lang.String reportName,
Report report)
添加结果报表
|
void |
addReport(java.lang.String reportName,
TemplateReport report)
增加一个指定名称的Report
|
void |
addReport(TemplateReport report)
增加一个Report
|
void |
apply4Parameters(java.util.Map parameterMap)
alex:处理parameterMap 一.设置的报表参数的默认值的处理 二.ParameterProcessor的处理
|
boolean |
checkWorkBook() |
void |
clearAllTableData()
清除所有的数据集
|
WorkBookAdapter |
clone()
注意:这里不调用super.clone(),否则会造成clone时部分原对象模块的值被篡改为空,
由于在workBookX clone之前,WorkBook超类会clone所有的数据包括一些空字段
(因为在WorkBookAdapter中,超类很多字段是空的),当 clone 方法中使用get
方法来获取值的,则不会出问题,但是当直接使用字段进行 clone,原对象的值会被
重置为空值。
|
protected void |
copyDataSourceAttr(AbstractTableDataSource toBook)
copy attr from this to param
|
boolean |
equals(java.lang.Object o) |
ResultWorkBook |
execute(java.util.Map parameterMap,
Actor actor)
根据给定的参数集和预览方式执行后获取结果报表簿
|
ResultWorkBook |
execute(java.util.Map parameterMap,
Actor actor,
int sheetIndex)
根据给定的参数集和预览方式执行后获取结果报表簿
|
boolean |
export(java.io.OutputStream out)
将该对象写入指定的输出流中输出
|
<T extends IOFileAttrMark> |
getAttrMark(java.lang.String tagName)
根据标签获取模板对象的属性对象
|
java.lang.String[] |
getCSSImport()
获取引用的css
|
java.lang.String |
getDesignerVersion()
获取设计器版本,用于判断兼容性
|
ECReport |
getElementCaseReport(int index)
当isElementCaseBook返回true时,即该FineBook中包含的都是ECReport时
调用此方法来获取相应位置上的ECReport
非此情况下调用,将抛出RuntimeException
|
java.lang.String[] |
getJSImport()
获取引用的js
|
Parameter[] |
getParameters()
获取参数
|
int |
getPreviewType()
获取预览方式
|
Report |
getReport(int index)
获取指定索引的report
|
int |
getReportCount()
获取Report的数量
|
ReportExportAttr |
getReportExportAttr()
Gets report export attributes.
|
ReportFitAttr |
getReportFitAttr() |
int |
getReportIndex(TemplateReport report)
获取给定report的index
|
ElementCaseMobileAttr |
getReportMobileAttr() |
java.lang.String |
getReportName(int index)
Gets sheet name at given position.
|
ReportParameterAttr |
getReportParameterAttr()
获取参数属性
|
ReportWebAttr |
getReportWebAttr()
Gets report web attributes.
|
TableData |
getTableData(java.lang.String name)
返回该对象中指定名字的数据集
|
java.util.Iterator<java.lang.String> |
getTableDataNameIterator()
返回该对象所包含的所有数据集名的一个迭代
|
WorkSheet |
getTemplateElementCaseReport(int index)
当isElementCaseBook返回true时,即该FineBook中包含的都是ECReport时
调用此方法来获取相应位置上的TemplateECReport
使用同getECReport(int)
非此情况下调用,将抛出RuntimeException
|
java.lang.String |
getTemplateID()
获取模板唯一ID(UUID)
|
TemplateReport |
getTemplateReport(int index)
获取指定位置的TemplateReport
|
WorkBookX |
getWorkBookX() |
java.lang.String |
getXMLDesignerVersion()
已过时。
命名问题,请使用getDesignerVersion代替
|
XMLVersion |
getXmlVersion()
获取 XML 版本
|
boolean |
isElementCaseBook()
是否是普通的单ElementCase的报表类型(区别于聚合报表)
|
boolean |
isElementCaseBook(int index)
指定index的Block是否是普通的单ElementCase的报表类型(区别于聚合报表)
|
void |
mainContentWriteXML(XMLPrintWriter writer)
主要的写xml的方法
|
java.lang.String |
openTag()
打开Tag
|
void |
putTableData(java.lang.String name,
TableData innerTableData)
放置指定的数据集到对象中
|
void |
readStream(java.io.InputStream in)
用输入流构建WorkBook
|
void |
readStream(java.io.InputStream in,
boolean string2Formula)
用输入流构建WorkBook
|
void |
readXML(XMLableReader reader)
读取子节点,应该会被XMLableReader.readXMLObject()调用多次
|
void |
removeReport(int index)
Removes report at given position.
|
void |
removeReport(java.lang.String reportName)
Removes report with the given name.
|
void |
removeReports()
Removes all report.
|
void |
removeTableData(java.lang.String name)
移除指定名字的数据集
|
boolean |
renameTableData(java.lang.String oldName,
java.lang.String newName)
重命名数据集
|
void |
setDesignerVersion(java.lang.String designerVersion)
设置设计器版本
|
void |
setPreviewType(int previewType)
设置预览方式
|
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 |
setReportMobileAttr(ElementCaseMobileAttr attr)
设置报表的移动端属性
|
void |
setReportName(int index,
java.lang.String reportName)
Sets sheet name at given position.
|
void |
setReportParameterAttr(ReportParameterAttr reportParameterAttr)
设置参数属性
|
void |
setReportWebAttr(ReportWebAttr reportWebAttr)
Sets report web attributes.
|
void |
setTemplateID(java.lang.String templateID)
设置模板的唯一UUID(UUID)
|
protected void |
setWorkBook(Report report,
FineBook book) |
java.lang.String |
suffix()
后缀
|
void |
writeXML(XMLPrintWriter writer)
Write XML.
|
protected void |
writeXML(XMLPrintWriter writer,
AbstractFineBook.ReportWriter reportWriter) |
getAllEditedRoleSet
getReportIndex, mainContent, setReport, setReport
getAllMarkName, isHigherThanCurrent, readDesign, readExtra, setXmlVersion, writeDesign, writeExtra
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAllMarkName
public WorkBookAdapter()
public WorkBookAdapter(WorkBookX workBookX)
public WorkBookX getWorkBookX()
public ResultWorkBook execute(java.util.Map parameterMap, Actor actor)
execute
在接口中 TemplateWorkBook
execute
在类中 WorkBook
parameterMap
- 参数集actor
- 预览方式public ResultWorkBook execute(java.util.Map parameterMap, Actor actor, int sheetIndex)
execute
在接口中 TemplateWorkBook
execute
在类中 WorkBook
parameterMap
- 参数集actor
- 预览方式sheetIndex
- 指定的sheetpublic Parameter[] getParameters()
getParameters
在接口中 ParameterHolder
getParameters
在类中 WorkBook
public void apply4Parameters(java.util.Map parameterMap)
apply4Parameters
在接口中 TemplateWorkBook
apply4Parameters
在类中 WorkBook
parameterMap
- 参数WorkBookHelper.apply4Parameters(Map, ReportParameterAttr)
public boolean renameTableData(java.lang.String oldName, java.lang.String newName)
renameTableData
在接口中 TableDataSource
renameTableData
在类中 WorkBook
oldName
- 数据集老的名字newName
- 数据集新的名字public void mainContentWriteXML(XMLPrintWriter writer)
mainContentWriteXML
在类中 WorkBook
writer
- 写xmlpublic void readStream(java.io.InputStream in) throws java.lang.Exception
readStream
在类中 WorkBook
in
- 输入流java.lang.Exception
public void readStream(java.io.InputStream in, boolean string2Formula) throws java.lang.Exception
readStream
在类中 WorkBook
in
- 输入流string2Formula
- 是否把字符串转化成公式java.lang.Exception
public void addReport(TemplateReport report)
TemplateWorkBook
addReport
在接口中 TemplateWorkBook
addReport
在类中 AbstractTemplateWorkBook
report
- 增加的Reportpublic void addReport(java.lang.String reportName, TemplateReport report)
TemplateWorkBook
addReport
在接口中 TemplateWorkBook
addReport
在类中 AbstractTemplateWorkBook
reportName
- 指定的名称report
- 增加的Reportpublic void addReport(int index, TemplateReport report)
WorkBook
WorkBook workbook1 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook1.cpt");
WorkBook workbook2 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook2.cpt");
for (int i=0; i
非此情况下调用,将抛出RuntimeException
addReport
public void addReport(int index,
java.lang.String reportName,
TemplateReport report)
WorkBook
setReport
public void setReport(int index,
TemplateReport report)
TemplateWorkBook
setReport
在接口中 TemplateWorkBook
setReport
在类中 AbstractTemplateWorkBook
index
- 指定的indexreport
- 设置过去的report
setReport
public void setReport(int index,
java.lang.String reportName,
TemplateReport report)
TemplateWorkBook
setReport
在接口中 TemplateWorkBook
setReport
在类中 AbstractTemplateWorkBook
index
- 指定位置reportName
- 新增的Report的Namereport
- 新增的report
getReportIndex
public int getReportIndex(TemplateReport report)
TemplateWorkBook
getReportIndex
在接口中 TemplateWorkBook
getReportIndex
在类中 AbstractTemplateWorkBook
report
- 给定的report
getTemplateReport
public TemplateReport getTemplateReport(int index)
TemplateWorkBook
getTemplateReport
在接口中 TemplateWorkBook
getTemplateReport
在类中 AbstractTemplateWorkBook
index
- 指定的索引
getTemplateElementCaseReport
public WorkSheet getTemplateElementCaseReport(int index)
TemplateWorkBook
setWorkBook
protected void setWorkBook(Report report,
FineBook book)
setWorkBook
在类中 AbstractTemplateWorkBook
getReportParameterAttr
public ReportParameterAttr getReportParameterAttr()
TemplateWorkBook
getReportParameterAttr
在接口中 TemplateWorkBook
getReportParameterAttr
在类中 AbstractTemplateWorkBook
setReportParameterAttr
public void setReportParameterAttr(ReportParameterAttr reportParameterAttr)
TemplateWorkBook
setReportParameterAttr
在接口中 TemplateWorkBook
setReportParameterAttr
在类中 AbstractTemplateWorkBook
clone
public WorkBookAdapter clone()
clone
在接口中 FCloneable
clone
在类中 AbstractTemplateWorkBook
writeXML
public void writeXML(XMLPrintWriter writer)
XMLWriter
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
writeXML
在类中 AbstractTemplateWorkBook
writer
- XML写入对象
readXML
public void readXML(XMLableReader reader)
XMLReadable
readXML
在接口中 XMLReadable
readXML
在类中 AbstractTemplateWorkBook
reader
- XML读取对象XMLableReader
addReport
protected void addReport(Report report)
addReport
在类中 AbstractFineBook
report
- 结果报表
addReport
public void addReport(java.lang.String reportName,
Report report)
addReport
在类中 AbstractFineBook
reportName
- 报表名report
- 结果报表
addReport
protected void addReport(int index,
java.lang.String reportName,
Report report)
addReport
在类中 AbstractFineBook
index
- 当前序列reportName
- 报表名report
- 结果报表
isElementCaseBook
public boolean isElementCaseBook()
isElementCaseBook
在接口中 FineBook
isElementCaseBook
在类中 AbstractFineBook
isElementCaseBook
public boolean isElementCaseBook(int index)
isElementCaseBook
在接口中 FineBook
isElementCaseBook
在类中 AbstractFineBook
index
- 指定的序列
getElementCaseReport
public ECReport getElementCaseReport(int index)
FineBook
getElementCaseReport
在接口中 FineBook
getElementCaseReport
在类中 AbstractFineBook
getReportName
public java.lang.String getReportName(int index)
AbstractFineBook
getReportName
在接口中 FineBook
getReportName
在类中 AbstractFineBook
index
- the given position.
setReportName
public void setReportName(int index,
java.lang.String reportName)
AbstractFineBook
setReportName
在接口中 FineBook
setReportName
在类中 AbstractFineBook
index
- the given position.reportName
- the name of Report.
getReport
public Report getReport(int index)
getReport
在接口中 FineBook
getReport
在类中 AbstractFineBook
index
-
removeReport
public void removeReport(java.lang.String reportName)
removeReport
在接口中 FineBook
removeReport
在类中 AbstractFineBook
reportName
- 名称 the report name which will be removed.
removeReports
public void removeReports()
removeReports
在接口中 FineBook
removeReports
在类中 AbstractFineBook
removeReport
public void removeReport(int index)
removeReport
在接口中 FineBook
removeReport
在类中 AbstractFineBook
index
- the given position. 序号
getReportCount
public int getReportCount()
getReportCount
在接口中 FineBook
getReportCount
在类中 AbstractFineBook
getReportWebAttr
public ReportWebAttr getReportWebAttr()
FineBook
getReportWebAttr
在接口中 FineBook
getReportWebAttr
在类中 AbstractFineBook
setReportWebAttr
public void setReportWebAttr(ReportWebAttr reportWebAttr)
FineBook
setReportWebAttr
在接口中 FineBook
setReportWebAttr
在类中 AbstractTemplateWorkBook
getReportFitAttr
public ReportFitAttr getReportFitAttr()
getReportFitAttr
在接口中 FitProvider
getReportFitAttr
在类中 AbstractTemplateWorkBook
setReportFitAttr
public void setReportFitAttr(ReportFitAttr fitAttr)
setReportFitAttr
在接口中 FitProvider
setReportFitAttr
在类中 AbstractTemplateWorkBook
getReportMobileAttr
public ElementCaseMobileAttr getReportMobileAttr()
getReportMobileAttr
在接口中 FineBook
getReportMobileAttr
在类中 AbstractFineBook
setReportMobileAttr
public void setReportMobileAttr(ElementCaseMobileAttr attr)
setReportMobileAttr
在接口中 FineBook
setReportMobileAttr
在类中 WorkBook
attr
-
getReportExportAttr
public ReportExportAttr getReportExportAttr()
FineBook
getReportExportAttr
在接口中 FineBook
getReportExportAttr
在类中 AbstractFineBook
setReportExportAttr
public void setReportExportAttr(ReportExportAttr reportExportAttr)
FineBook
setReportExportAttr
在接口中 FineBook
setReportExportAttr
在类中 AbstractFineBook
writeXML
protected void writeXML(XMLPrintWriter writer,
AbstractFineBook.ReportWriter reportWriter)
writeXML
在类中 AbstractFineBook
getJSImport
public java.lang.String[] getJSImport()
ImportJsCssProvider
getJSImport
在接口中 ImportJsCssProvider
getJSImport
在类中 AbstractFineBook
getCSSImport
public java.lang.String[] getCSSImport()
ImportJsCssProvider
getCSSImport
在接口中 ImportJsCssProvider
getCSSImport
在类中 AbstractFineBook
addAttrMark
public void addAttrMark(IOFileAttrMark attrMark)
addAttrMark
在接口中 AttrMark
addAttrMark
在类中 IOFile
attrMark
- 额外的属性对象
getAttrMark
public <T extends IOFileAttrMark> T getAttrMark(java.lang.String tagName)
getAttrMark
在接口中 AttrMark
getAttrMark
在类中 IOFile
T
- 对象类型tagName
- 标签名
checkWorkBook
public boolean checkWorkBook()
export
public boolean export(java.io.OutputStream out)
throws java.lang.Exception
getXMLDesignerVersion
public java.lang.String getXMLDesignerVersion()
getXMLDesignerVersion
在接口中 BaseBook
getXMLDesignerVersion
在类中 IOFile
getDesignerVersion
public java.lang.String getDesignerVersion()
BaseBook
getDesignerVersion
在接口中 BaseBook
getDesignerVersion
在类中 IOFile
setDesignerVersion
public void setDesignerVersion(java.lang.String designerVersion)
BaseBook
setDesignerVersion
在接口中 BaseBook
setDesignerVersion
在类中 IOFile
designerVersion
- 设计器版本
getTemplateID
public java.lang.String getTemplateID()
BaseBook
getTemplateID
在接口中 BaseBook
getTemplateID
在类中 IOFile
setTemplateID
public void setTemplateID(java.lang.String templateID)
BaseBook
setTemplateID
在接口中 BaseBook
setTemplateID
在类中 IOFile
templateID
- 模板唯一ID(UUID)
getPreviewType
public int getPreviewType()
BaseBook
getPreviewType
在接口中 BaseBook
getPreviewType
在类中 IOFile
setPreviewType
public void setPreviewType(int previewType)
BaseBook
setPreviewType
在接口中 BaseBook
setPreviewType
在类中 IOFile
previewType
- 预览方式
getXmlVersion
public XMLVersion getXmlVersion()
BaseBook
getXmlVersion
在接口中 BaseBook
getXmlVersion
在类中 IOFile
getTableDataNameIterator
public java.util.Iterator<java.lang.String> getTableDataNameIterator()
getTableData
public TableData getTableData(java.lang.String name)
getTableData
在接口中 TableDataSource
getTableData
在类中 AbstractTableDataSource
name
- 数据集的名字
putTableData
public void putTableData(java.lang.String name,
TableData innerTableData)
putTableData
在接口中 TableDataSource
putTableData
在类中 AbstractTableDataSource
name
- 数据集的名字innerTableData
- 数据集
removeTableData
public void removeTableData(java.lang.String name)
removeTableData
在接口中 TableDataSource
removeTableData
在类中 AbstractTableDataSource
name
- 要移除的数据集的名字
clearAllTableData
public void clearAllTableData()
clearAllTableData
在接口中 TableDataSource
clearAllTableData
在类中 AbstractTableDataSource
copyDataSourceAttr
protected void copyDataSourceAttr(AbstractTableDataSource toBook)
copyDataSourceAttr
在类中 AbstractTableDataSource
toBook
-