cn.orionsec.kit.office.excel.writer.exporting

Class ExcelExport<T>

java.lang.Object

cn.orionsec.kit.office.excel.writer.BaseExcelWriteable

cn.orionsec.kit.office.excel.writer.exporting.ExcelExport<T>

All Implemented Interfaces:

SafeCloseable, Closeable, AutoCloseable

public class ExcelExport<T>
extends BaseExcelWriteable

excel 导出器

Since:

2020/5/28 11:15

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields inherited from class cn.orionsec.kit.office.excel.writer.BaseExcelWriteable

workbook

Constructor Summary

Constructors

Constructor and Description
ExcelExport(Class<T> targetClass)
ExcelExport(Class<T> targetClass, org.apache.poi.ss.usermodel.Sheet sheet)
ExcelExport(Class<T> targetClass, org.apache.poi.ss.usermodel.Workbook workbook)
ExcelExport(Class<T> targetClass, org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet)

Method Summary

Modifier and Type	Method and Description
ExcelExport<T>	addRow(T row) 添加数据
ExcelExport<T>	addRows(Collection<T> rows) 添加数据
org.apache.poi.ss.usermodel.CellStyle	cloneCellStyle(int column) 复制列样式 用于样式修改
static <T> ExcelExport<T>	create(Class<T> targetClass) 创建导出实例并初始化
static <T> ExcelExport<T>	create(Class<T> targetClass, org.apache.poi.ss.usermodel.Sheet sheet)
static <T> ExcelExport<T>	create(Class<T> targetClass, org.apache.poi.ss.usermodel.Workbook workbook)
static <T> ExcelExport<T>	create(Class<T> targetClass, org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet)
org.apache.poi.ss.usermodel.CellStyle	createCellStyle() 获取一个单元格样式 用于样式修改
org.apache.poi.ss.usermodel.Font	createFont() 获取一个字体 用于样式修改
org.apache.poi.ss.usermodel.DataFormat	createFormat() 获取一个格式 用于样式修改
int	getColumnMaxIndex() 获取最大列索引
int	getLines() 获取总行数
int	getRowIndex()
int	getRows()
org.apache.poi.ss.usermodel.Sheet	getSheet()
SheetConfig<T>	getSheetConfig()
ExcelExport<T>	headers(String... headers) 设置表头
ExcelExport<T>	init() 初始化
ExcelExport<T>	merge(org.apache.poi.ss.util.CellRangeAddress region, boolean mergeBorder) 合并单元格
ExcelExport<T>	merge(int row, int firstCol, int lastCol)
ExcelExport<T>	merge(int row, int firstCol, int lastCol, boolean mergeBorder)
ExcelExport<T>	merge(int firstRow, int lastRow, int firstCol, int lastCol)
ExcelExport<T>	merge(int firstRow, int lastRow, int firstCol, int lastCol, boolean mergeBorder) 合并单元格
ExcelExport<T>	protect(String password) 保护表格
ExcelExport<T>	sheet(String sheetName) 设置sheet的名称
ExcelExport<T>	skip() 跳过一多
ExcelExport<T>	skip(int i) 跳过行多
ExcelExport<T>	skipNullRows(boolean skipNullRows) 跳过空行
ExcelExport<T>	skipTitle() 跳过title
ExcelExport<T>	title(String title) 设置title的名称
protected BaseExcelWriteable	write(OutputStream out, String password, boolean close)

Methods inherited from class cn.orionsec.kit.office.excel.writer.BaseExcelWriteable

close, getWorkbook, write, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelExport

public ExcelExport(Class<T> targetClass)

ExcelExport

public ExcelExport(Class<T> targetClass,
                   org.apache.poi.ss.usermodel.Workbook workbook)

ExcelExport

public ExcelExport(Class<T> targetClass,
                   org.apache.poi.ss.usermodel.Sheet sheet)

ExcelExport

public ExcelExport(Class<T> targetClass,
                   org.apache.poi.ss.usermodel.Workbook workbook,
                   org.apache.poi.ss.usermodel.Sheet sheet)

Method Detail

create

public static <T> ExcelExport<T> create(Class<T> targetClass)

创建导出实例并初始化

Type Parameters:

T - T

Parameters:

targetClass - targetClass

Returns:

exporter

create

public static <T> ExcelExport<T> create(Class<T> targetClass,
                                        org.apache.poi.ss.usermodel.Workbook workbook)

create

public static <T> ExcelExport<T> create(Class<T> targetClass,
                                        org.apache.poi.ss.usermodel.Sheet sheet)

create

public static <T> ExcelExport<T> create(Class<T> targetClass,
                                        org.apache.poi.ss.usermodel.Workbook workbook,
                                        org.apache.poi.ss.usermodel.Sheet sheet)

init

public ExcelExport<T> init()

初始化

Returns:

this

skip

public ExcelExport<T> skip()

跳过一多

Returns:

this

skip

public ExcelExport<T> skip(int i)

跳过行多

Parameters:

i - 行

Returns:

this

skipNullRows

public ExcelExport<T> skipNullRows(boolean skipNullRows)

跳过空行

Parameters:

skipNullRows - true跳过

Returns:

this

skipTitle

public ExcelExport<T> skipTitle()

跳过title

Returns:

this

sheet

public ExcelExport<T> sheet(String sheetName)

设置sheet的名称

Parameters:

sheetName - sheetName

Returns:

this

title

public ExcelExport<T> title(String title)

设置title的名称

Parameters:

title - title

Returns:

this

protect

public ExcelExport<T> protect(String password)

保护表格

Parameters:

password - password

Returns:

this

merge

public ExcelExport<T> merge(int row,
                            int firstCol,
                            int lastCol)

merge

public ExcelExport<T> merge(int row,
                            int firstCol,
                            int lastCol,
                            boolean mergeBorder)

merge

public ExcelExport<T> merge(int firstRow,
                            int lastRow,
                            int firstCol,
                            int lastCol)

merge

public ExcelExport<T> merge(int firstRow,
                            int lastRow,
                            int firstCol,
                            int lastCol,
                            boolean mergeBorder)

合并单元格

Parameters:

firstRow - 合并开始行索引

lastRow - 合并结束行索引

firstCol - 合并开始列索引

lastCol - 合并结束列索引

mergeBorder - 是否合并边框

Returns:

this

merge

public ExcelExport<T> merge(org.apache.poi.ss.util.CellRangeAddress region,
                            boolean mergeBorder)

合并单元格

Parameters:

region - region

mergeBorder - 是否合并边框

Returns:

this

headers

public ExcelExport<T> headers(String... headers)

设置表头

Parameters:

headers - 头

Returns:

this

addRow

public ExcelExport<T> addRow(T row)

添加数据

Parameters:

row - row

Returns:

this

addRows

public ExcelExport<T> addRows(Collection<T> rows)

添加数据

Parameters:

rows - rows

Returns:

this

write

protected BaseExcelWriteable write(OutputStream out,
                                   String password,
                                   boolean close)

Overrides:

write in class BaseExcelWriteable

createCellStyle

public org.apache.poi.ss.usermodel.CellStyle createCellStyle()

获取一个单元格样式 用于样式修改

Returns:

单元格样式

cloneCellStyle

public org.apache.poi.ss.usermodel.CellStyle cloneCellStyle(int column)

复制列样式 用于样式修改

Parameters:

column - column

Returns:

单元格样式

createFont

public org.apache.poi.ss.usermodel.Font createFont()

获取一个字体 用于样式修改

Returns:

字体

createFormat

public org.apache.poi.ss.usermodel.DataFormat createFormat()

获取一个格式 用于样式修改

Returns:

格式

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

getSheetConfig

public SheetConfig<T> getSheetConfig()

getLines

public int getLines()

获取总行数

Returns:

总行数

getColumnMaxIndex

public int getColumnMaxIndex()

获取最大列索引

Returns:

最大列索引

getRowIndex

public int getRowIndex()

Returns:

当前行数

getRows

public int getRows()

Returns:

写入的数据行数