org.ttzero.excel.entity

接口 IWorkbookWriter

所有超级接口:

Storable

所有已知实现类:

CSVWorkbookWriter, XMLWorkbookWriter

public interface IWorkbookWriter
extends Storable

工作薄输出协议，负责协调所有部件输出并组装所有零散的文件

作者:

guanquan.wang at 2019-04-22 16:00

另请参阅:

XMLWorkbookWriter, CSVWorkbookWriter

方法概要

限定符和类型	方法和说明
String	getSuffix() 获取最终的输出格式
IWorksheetWriter	getWorksheetWriter(Sheet sheet) 获取工作表输出协议
static Properties	pom() 获取pom配置相关信息
default Path	reMarkPath(Path src, Path rootPath, String fileName) 移动文件到指定位置，如果已存在相同文件名则会在文件名后追回'（n）‘以区分， n从1开始如果已存在'（n）‘则新文件名为'（n + 1）‘ 例：目标文件夹已存在a.xlsx和b（5）.xlsx两个文件，添加一个名为a.xlsx的文件 则新文件另存为a（1）.xlsx，添加一个名为b.xlsx的文件则新文件另存为b（6）.xlsx
void	setWorkbook(Workbook workbook) 设置工作薄
Path	template() 指定模板导出时获取制作好的文件临时路径
void	writeTo(File file) 将工作薄写到指定位置
void	writeTo(OutputStream os) 将工作薄写到指定流

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

writeTo

方法详细资料

setWorkbook

void setWorkbook(Workbook workbook)

设置工作薄

参数:

workbook - 工作薄

getSuffix

String getSuffix()

获取最终的输出格式

返回:

xlsx: excel07, xls: excel03

writeTo

void writeTo(OutputStream os)
      throws IOException

将工作薄写到指定流

参数:

os - 输出流

抛出:

IOException - if I/O error occur

writeTo

void writeTo(File file)
      throws IOException

将工作薄写到指定位置

参数:

file - 目标文件

抛出:

IOException - if I/O error occur

template

Path template()
       throws IOException

指定模板导出时获取制作好的文件临时路径

返回:

文件临时路径

抛出:

IOException - if I/O error occur

getWorksheetWriter

IWorksheetWriter getWorksheetWriter(Sheet sheet)

获取工作表输出协议

参数:

sheet - 工作表

返回:

工作表输出协议

reMarkPath

default Path reMarkPath(Path src,
                        Path rootPath,
                        String fileName)
                 throws IOException

移动文件到指定位置，如果已存在相同文件名则会在文件名后追回'（n）‘以区分， n从1开始如果已存在'（n）‘则新文件名为'（n + 1）‘

例：目标文件夹已存在a.xlsx和b（5）.xlsx两个文件，添加一个名为a.xlsx的文件 则新文件另存为a（1）.xlsx，添加一个名为b.xlsx的文件则新文件另存为b（6）.xlsx

参数:

src - 源文件

rootPath - 目标文件夹

fileName - 目标文件名

返回:

另存为目标文件绝对路径

抛出:

IOException - if I/O error occur

pom

static Properties pom()

获取pom配置相关信息

返回:

general pom properties