XMLWorkbookWriter (Excel Write/Read Framework 0.5.26 API)

java.lang.Object
- org.ttzero.excel.entity.e7.XMLWorkbookWriter

所有已实现的接口:: Closeable, AutoCloseable, IWorkbookWriter, Storable

@TopNS(prefix={"","r"},
       value="workbook",
       uri={"http://schemas.openxmlformats.org/spreadsheetml/2006/main","http://schemas.openxmlformats.org/officeDocument/2006/relationships"})
public class XMLWorkbookWriter
extends Object
implements IWorkbookWriter

作者:: guanquan.wang at 2019-04-22 15:47

字段概要

字段
限定符和类型	字段和说明
`protected org.slf4j.Logger`	`LOGGER` LOGGER
`protected RelManager`	`relManager`
`protected Path`	`tmpPath` 临时文件路径
`protected Workbook`	`workbook`

构造器概要

构造器
构造器和说明

XMLWorkbookWriter()

XMLWorkbookWriter(Workbook workbook)

构造器
构造器和说明
`XMLWorkbookWriter()`
`XMLWorkbookWriter(Workbook workbook)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()`
`protected Path`	`createTemp()`
`RelManager`	`getRelManager()`
`String`	`getSuffix()` The Workbook suffix
`Workbook`	`getWorkbook()`
`IWorksheetWriter`	`getWorksheetWriter(Sheet sheet)` 获取工作表输出协议
`protected void`	`moveToPath(Path source, Path target)`
`void`	`setWorkbook(Workbook workbook)` Setting workbook
`protected void`	`writeApp(Path root)`
`Path`	`writeBefore()` 导入前的准备工作
`protected void`	`writeCore(Path root)`
`protected void`	`writeCustomProperties(Path root)` 写自定义属性
`protected void`	`writeGlobalAttribute(Path root)`
`void`	`writeTo(OutputStream os)` 将工作薄写到指定流
`void`	`writeTo(Path path)` Write the workbook file to ${path}
`protected void`	`writeWorkbook(Path root)` 将工作簿写入到指定路径
`protected void`	`writeWorksheets(Path root)`

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

从接口继承的方法 org.ttzero.excel.entity.IWorkbookWriter
moveToPath, pom, writeTo

- 字段详细资料
  - LOGGER
```
protected final org.slf4j.Logger LOGGER
```
    LOGGER
  - workbook
```
protected Workbook workbook
```
  - relManager
```
protected final RelManager relManager
```
  - tmpPath
```
protected Path tmpPath
```
    临时文件路径
- 构造器详细资料
  - XMLWorkbookWriter
```
public XMLWorkbookWriter()
```
  - XMLWorkbookWriter
```
public XMLWorkbookWriter(Workbook workbook)
```
- 方法详细资料
  - getWorkbook
```
public Workbook getWorkbook()
```
  - getRelManager
```
public RelManager getRelManager()
```
  - setWorkbook
```
public void setWorkbook(Workbook workbook)
```
    Setting workbook
    
    指定者:
    
    setWorkbook 在接口中 IWorkbookWriter
    
    参数:
    
    workbook - the global workbook context
  - getSuffix
```
public String getSuffix()
```
    The Workbook suffix
    
    指定者:
    
    getSuffix 在接口中 IWorkbookWriter
    
    返回:
    
    xlsx if excel07, xls if excel03
  - writeTo
```
public void writeTo(Path path)
             throws IOException
```
    Write the workbook file to ${path}
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    path - the storage path
    
    抛出:
    
    IOException - 写失败异常
  - writeTo
```
public void writeTo(OutputStream os)
             throws IOException
```
    从接口复制的说明: IWorkbookWriter
    
    将工作薄写到指定流
    
    指定者:
    
    writeTo 在接口中 IWorkbookWriter
    
    参数:
    
    os - 输出流
    
    抛出:
    
    IOException - if I/O error occur
  - writeGlobalAttribute
```
protected void writeGlobalAttribute(Path root)
                             throws IOException
```
    抛出:
    
    IOException
  - writeApp
```
protected void writeApp(Path root)
                 throws IOException
```
    抛出:
    
    IOException
  - writeCore
```
protected void writeCore(Path root)
                  throws IOException
```
    抛出:
    
    IOException
  - writeCustomProperties
```
protected void writeCustomProperties(Path root)
                              throws IOException
```
    写自定义属性
    
    参数:
    
    root - root路径
    
    抛出:
    
    IOException - If I/O error occur.
  - writeWorkbook
```
protected void writeWorkbook(Path root)
                      throws IOException
```
    将工作簿写入到指定路径
    
    参数:
    
    root - 根目录路径
    
    抛出:
    
    IOException - 如果写入过程中发生I/O错误
  - writeWorksheets
```
protected void writeWorksheets(Path root)
                        throws IOException
```
    抛出:
    
    IOException
  - writeBefore
```
public Path writeBefore()
                 throws IOException
```
    从接口复制的说明: IWorkbookWriter
    
    导入前的准备工作
    
    指定者:
    
    writeBefore 在接口中 IWorkbookWriter
    
    返回:
    
    临时文件路径
    
    抛出:
    
    IOException - if I/O error occur
  - createTemp
```
protected Path createTemp()
                   throws IOException,
                          ExcelWriteException
```
    抛出:
    
    IOException
    
    ExcelWriteException
  - moveToPath
```
protected void moveToPath(Path source,
                          Path target)
                   throws IOException
```
    抛出:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException
  - getWorksheetWriter
```
public IWorksheetWriter getWorksheetWriter(Sheet sheet)
```
    从接口复制的说明: IWorkbookWriter
    
    获取工作表输出协议
    
    指定者:
    
    getWorksheetWriter 在接口中 IWorkbookWriter
    
    参数:
    
    sheet - 工作表
    
    返回:
    
    工作表输出协议

类 XMLWorkbookWriter

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.ttzero.excel.entity.IWorkbookWriter

字段详细资料

LOGGER

workbook

relManager

tmpPath

构造器详细资料

XMLWorkbookWriter

XMLWorkbookWriter

方法详细资料

getWorkbook

getRelManager

setWorkbook

getSuffix

writeTo

writeTo

writeGlobalAttribute

writeApp

writeCore

writeCustomProperties

writeWorkbook

writeWorksheets

writeBefore

createTemp

moveToPath

close

getWorksheetWriter