WorkBook

java.lang.Object
- com.fr.data.AbstractTableDataSource
- - com.fr.base.io.IOFile
  - - com.fr.main.AbstractFineBook
    - - com.fr.main.AbstractTemplateWorkBook
      - com.fr.main.impl.WorkBook

所有已实现的接口:

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

直接已知子类:

WorkBookAdapter
```
public class WorkBook
extends AbstractTemplateWorkBook
implements PrivilegeEditedRoleProvider
```
Work main contains a series of work sheet.

另请参阅:
序列化表格

嵌套类概要
- 从类继承的嵌套类/接口 com.fr.main.AbstractFineBook
  AbstractFineBook.ReportWriter

字段概要

字段
限定符和类型字段和说明

static java.lang.String STRING_TO_FORMULA

static java.lang.String XML_TAG
- 从类继承的字段 com.fr.main.AbstractTemplateWorkBook
  reportParameterAttr
- 从类继承的字段 com.fr.main.AbstractFineBook
  fitAttr, mobileAttr, reportExportAttr, reportWebAttr
- 从类继承的字段 com.fr.base.io.IOFile
  ANA_PREVIEW_TYPE, DEFAULT_PREVIEW_TYPE, WRITE_ENHANCE_PREVIEW_TYPE, WRITE_PREVIEW_TYPE
- 从类继承的字段 com.fr.data.AbstractTableDataSource
  tableDataList
- 从接口继承的字段 com.fr.data.TableDataSource
  KEY

字段
限定符和类型	字段和说明
`static java.lang.String`	`STRING_TO_FORMULA`
`static java.lang.String`	`XML_TAG`

构造器概要

构造器
构造器和说明

WorkBook()
初始化一个WorkBook

WorkBook(TemplateReport report)
初始化一个带有report内容的WorkBook

构造器
构造器和说明
`WorkBook()` 初始化一个WorkBook
`WorkBook(TemplateReport report)` 初始化一个带有report内容的WorkBook

方法概要

方法
限定符和类型	方法和说明
`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
`void`	`apply4Parameters(java.util.Map<java.lang.String,java.lang.Object> sourceMap)` 仅适用于无session 状态时的参数计算 `WorkBookHelper.apply4Parameters(Map, ReportParameterAttr)` `WorkBookHelper.apply4Parameters(SessionParaMap, ReportParameterAttr)` 报表模板参数（也称报表参数）和全局参数的计算处理。
`boolean`	`equals(java.lang.Object o)`
`ResultWorkBook`	`execute(java.util.Map<java.lang.String,java.lang.Object> parameterMap, Actor actor)` 根据给定的参数集和预览方式执行后获取结果报表簿模板解析成初始参数p1为1并且分页预览的结果报表： WorkBook w1 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook1.cpt"); Map map = new HashMap(); map.put("p1", 1); ResultWorkBook resultWorkBook = w1.execute(map, ActorFactory.getActor("page")); //或者 w1.execute(map, new PageActor());
`ResultWorkBook`	`execute(java.util.Map<java.lang.String,java.lang.Object> parameterMap, Actor actor, int sheetIndex)` 根据给定的参数集和预览方式执行后获取结果报表簿
`boolean`	`export(java.io.OutputStream outputStream)` 将该对象写入指定的输出流中输出
`java.lang.String[]`	`getAllEditedRoleSet()`
`Parameter[]`	`getParameters()` 获取参数
`void`	`mainContentWriteXML(XMLPrintWriter writer)` 主要的写xml的方法
`java.lang.String`	`openTag()` 打开Tag
`void`	`readStream(java.io.InputStream in)` 用输入流构建WorkBook
`void`	`readStream(java.io.InputStream in, boolean string2Formula)` 用输入流构建WorkBook
`boolean`	`renameTableData(java.lang.String oldName, java.lang.String newName)` 重命名数据集
`void`	`setReportMobileAttr(ElementCaseMobileAttr attr)` 设置报表的移动端属性
`java.lang.String`	`suffix()` 后缀

从类继承的方法 com.fr.main.AbstractTemplateWorkBook
addReport, addReport, clone, getReportFitAttr, getReportIndex, getReportParameterAttr, getTemplateElementCaseReport, getTemplateReport, readXML, setReport, setReport, setReportFitAttr, setReportParameterAttr, setReportWebAttr, setWorkBook, writeXML

从类继承的方法 com.fr.main.AbstractFineBook
addReport, addReport, addReport, getCSSImport, getElementCaseReport, getJSImport, getReport, getReportCount, getReportExportAttr, getReportIndex, getReportMobileAttr, getReportName, getReportWebAttr, isElementCaseBook, isElementCaseBook, mainContent, removeReport, removeReport, removeReports, setReport, setReport, setReportExportAttr, setReportName, writeXML

从类继承的方法 com.fr.base.io.IOFile
addAttrMark, getAllMarkName, getAttrMark, getDesignerVersion, getPreviewType, getTemplateID, getXMLDesignerVersion, getXmlVersion, isHigherThanCurrent, readDesign, readExtra, setDesignerVersion, setPreviewType, setTemplateID, setXmlVersion, writeDesign, writeExtra

从类继承的方法 com.fr.data.AbstractTableDataSource
clearAllTableData, copyDataSourceAttr, getTableData, getTableDataNameIterator, putTableData, removeTableData

从类继承的方法 java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.fr.main.FineBook
getElementCaseReport, getReport, getReportCount, getReportExportAttr, getReportMobileAttr, getReportName, getReportWebAttr, isElementCaseBook, isElementCaseBook, removeReport, removeReport, removeReports, setReportExportAttr, setReportName

从接口继承的方法 com.fr.data.TableDataSource
clearAllTableData, getTableData, getTableDataNameIterator, putTableData, removeTableData

从接口继承的方法 com.fr.base.io.AttrMark
addAttrMark, getAllMarkName, getAttrMark

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

- 字段详细资料
  - XML_TAG
```
public static final java.lang.String XML_TAG
```
    另请参阅:
    常量字段值
  - STRING_TO_FORMULA
```
public static final java.lang.String STRING_TO_FORMULA
```
    另请参阅:
    常量字段值
- 构造器详细资料
  - WorkBook
```
public WorkBook()
```
    初始化一个WorkBook
  - WorkBook
```
public WorkBook(TemplateReport report)
```
    初始化一个带有report内容的WorkBook
    
    参数:
    report - 指定的report
- 方法详细资料
  - addReport
```
public 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
    参数:
    index - 索引
    report - 报表（报表或是聚合报表）
  - addReport
```
public void addReport(int index,
             java.lang.String reportName,
             TemplateReport report)
```
    增加报表
    
    参数:
    index - 索引
    reportName - 报表名
    report - 报表
  - execute
```
public ResultWorkBook execute(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                     Actor actor)
```
    根据给定的参数集和预览方式执行后获取结果报表簿
    模板解析成初始参数p1为1并且分页预览的结果报表：
    WorkBook w1 = (WorkBook) TemplateWorkBookIO.readTemplateWorkBook(FRContext.getCommonOperator(), "WorkBook1.cpt"); Map map = new HashMap(); map.put("p1", 1); ResultWorkBook resultWorkBook = w1.execute(map, ActorFactory.getActor("page")); //或者 w1.execute(map, new PageActor());
    
    指定者:
    
    execute 在接口中 TemplateWorkBook
    
    参数:
    parameterMap - 参数集
    actor - 预览方式
    
    返回:
    结果报表薄
  - execute
```
public ResultWorkBook execute(java.util.Map<java.lang.String,java.lang.Object> parameterMap,
                     Actor actor,
                     int sheetIndex)
```
    根据给定的参数集和预览方式执行后获取结果报表簿
    
    指定者:
    
    execute 在接口中 TemplateWorkBook
    
    覆盖:
    
    execute 在类中 AbstractTemplateWorkBook
    
    参数:
    parameterMap - 参数集
    actor - 预览方式
    sheetIndex - 指定的sheet
    
    返回:
    结果报表薄
  - getParameters
```
public Parameter[] getParameters()
```
    获取参数
    
    指定者:
    
    getParameters 在接口中 ParameterHolder
    
    返回:
    参数
  - apply4Parameters
```
public void apply4Parameters(java.util.Map<java.lang.String,java.lang.Object> sourceMap)
```
    仅适用于无session 状态时的参数计算 WorkBookHelper.apply4Parameters(Map, ReportParameterAttr) WorkBookHelper.apply4Parameters(SessionParaMap, ReportParameterAttr)
    报表模板参数（也称报表参数）和全局参数的计算处理。模板参数：模板参数是指在当前模板下创建的参数，在模板 > 模板参数中定义，只在当前报表中可以使用；全局参数：全局参数是指在当前工程下创建的参数，在服务器 > 全局参数中定义，定义方法与模板参数相同，在工程下的所有报表中都可以使用；如果模板参数（也称报表参数）和全局参数相同，则采用模板参数。
    模板参数和全局参数的使用方式一致，但是两者的作用域不同。全局参数：当前工程应用下的所有模板都可以使用。模板参数：只有当前模板才可以使用。
    
    指定者:
    
    apply4Parameters 在接口中 TemplateWorkBook
    
    参数:
    sourceMap - 参数
    另请参阅:
    帮助文档-参数的种类与区别, WorkBookHelper.apply4Parameters(Map, ReportParameterAttr)
  - getAllEditedRoleSet
```
public java.lang.String[] getAllEditedRoleSet()
```
    指定者:
    
    getAllEditedRoleSet 在接口中 PrivilegeEditedRoleProvider
  - renameTableData
```
public boolean renameTableData(java.lang.String oldName,
                      java.lang.String newName)
```
    重命名数据集
    
    指定者:
    
    renameTableData 在接口中 TableDataSource
    
    覆盖:
    
    renameTableData 在类中 AbstractTableDataSource
    
    参数:
    oldName - 数据集老的名字
    newName - 数据集新的名字
    
    返回:
    命名成功返回true
  - openTag
```
public java.lang.String openTag()
```
    打开Tag
    
    指定者:
    
    openTag 在类中 IOFile
    
    返回:
    xml标签
  - mainContentWriteXML
```
public void mainContentWriteXML(XMLPrintWriter writer)
```
    主要的写xml的方法
    
    指定者:
    
    mainContentWriteXML 在类中 AbstractFineBook
    
    参数:
    writer - 写xml
  - export
```
public boolean export(java.io.OutputStream outputStream)
               throws java.lang.Exception
```
    从类复制的说明: IOFile
    
    将该对象写入指定的输出流中输出
    
    指定者:
    
    export 在接口中 BaseBook
    
    覆盖:
    
    export 在类中 IOFile
    
    参数:
    outputStream - 输出流
    
    返回:
    写入成功则返回true，否则返回false
    
    抛出:
    
    java.lang.Exception - 导出失败异常
  - readStream
```
public void readStream(java.io.InputStream in)
                throws java.lang.Exception
```
    用输入流构建WorkBook
    
    指定者:
    
    readStream 在类中 IOFile
    
    参数:
    in - 输入流
    
    抛出:
    
    java.lang.Exception
  - readStream
```
public void readStream(java.io.InputStream in,
              boolean string2Formula)
                throws java.lang.Exception
```
    用输入流构建WorkBook
    
    参数:
    in - 输入流
    string2Formula - 是否把字符串转化成公式
    
    抛出:
    
    java.lang.Exception
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 AbstractTemplateWorkBook
  - setReportMobileAttr
```
public void setReportMobileAttr(ElementCaseMobileAttr attr)
```
    设置报表的移动端属性
    
    指定者:
    
    setReportMobileAttr 在接口中 FineBook
    
    覆盖:
    
    setReportMobileAttr 在类中 AbstractFineBook
  - suffix
```
public java.lang.String suffix()
```
    后缀
    
    指定者:
    
    suffix 在接口中 BaseBook
    
    覆盖:
    
    suffix 在类中 IOFile
    
    返回:
    后缀的字符串

类 WorkBook

嵌套类概要

从类继承的嵌套类/接口 com.fr.main.AbstractFineBook

字段概要

从类继承的字段 com.fr.main.AbstractTemplateWorkBook

从类继承的字段 com.fr.main.AbstractFineBook

从类继承的字段 com.fr.base.io.IOFile

从类继承的字段 com.fr.data.AbstractTableDataSource

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

构造器概要

方法概要

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

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

从类继承的方法 com.fr.base.io.IOFile

从类继承的方法 com.fr.data.AbstractTableDataSource

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

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

从接口继承的方法 com.fr.data.TableDataSource

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

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

字段详细资料

XML_TAG

STRING_TO_FORMULA

构造器详细资料

WorkBook

WorkBook

方法详细资料

addReport

addReport

execute

execute

getParameters

apply4Parameters

getAllEditedRoleSet

renameTableData

openTag

mainContentWriteXML

export

readStream

readStream

equals

setReportMobileAttr

suffix