cn.orionsec.kit.office.excel.writer

Class BaseExcelWriter<K,V>

java.lang.Object

cn.orionsec.kit.office.excel.writer.BaseExcelWriter<K,V>

Direct Known Subclasses:

ExcelArrayWriter, ExcelBeanWriter, ExcelLambdaWriter, ExcelMapWriter

public abstract class BaseExcelWriter<K,V>
extends Object

excel sheet 写入器 基类

不支持复杂类型 (图片 超链接 注释)

Since:

2020/4/6 23:33

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnMaxIndex 最大列索引
protected Map<Integer,org.apache.poi.ss.usermodel.CellStyle>	columnStyles 数据样式
protected Map<Integer,Function<V,Selector<V,org.apache.poi.ss.usermodel.CellStyle>>>	columnStyleSelector 数据样式选择器 有选择到的将会覆盖原有样式
protected boolean	columnUseDefaultStyle 列是否使用默认样式 全局 skip() 会使用默认样式
protected int	headerHeight 表头行高
protected Map<Integer,org.apache.poi.ss.usermodel.CellStyle>	headerStyles 表头样式
protected boolean	headerUseRowStyle 是否使用头部样式
protected Map<K,WriteFieldOption>	options 配置项
protected int	rowHeight 行高
protected int	rowIndex 当前行索引
protected org.apache.poi.ss.usermodel.Sheet	sheet
protected boolean	skipNullRows 是否跳过null
protected int	titleHeight 标题行高
protected org.apache.poi.ss.usermodel.CellStyle	titleStyle 标题样式
protected boolean	trim 是否清除空格
protected org.apache.poi.ss.usermodel.Workbook	workbook

Constructor Summary

Constructors

Constructor and Description
BaseExcelWriter(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet)

Method Summary

Modifier and Type	Method and Description
protected void	addOption(K k, WriteFieldOption option, Object defaultValue) 添加列配置
BaseExcelWriter<K,V>	addRow(V row) 添加行
BaseExcelWriter<K,V>	addRows(Collection<V> list) 添加行
BaseExcelWriter<K,V>	columnUseDefaultStyle() 列是否使用默认样式 需要在设置样式之前调用
org.apache.poi.ss.usermodel.CellStyle	createCellStyle() 获取一个单元格样式 用于样式修改
org.apache.poi.ss.usermodel.Font	createFont() 获取一个字体 用于样式修改
org.apache.poi.ss.usermodel.DataFormat	createFormat() 获取一个格式 用于样式修改
BaseExcelWriter<K,V>	defaultValue(K k, Object value) 设置默认值
BaseExcelWriter<K,V>	displayFormulas() 不执行公式 会修改列宽单位
BaseExcelWriter<K,V>	displayGridLines() 不显示网格线
BaseExcelWriter<K,V>	displayRowColHeadings() 不显示行数和列数
BaseExcelWriter<K,V>	filter() 筛选列
BaseExcelWriter<K,V>	filter(int rowIndex) 筛选列
BaseExcelWriter<K,V>	filter(int rowIndex, int lastColumn) 筛选列
BaseExcelWriter<K,V>	footer(FooterOption option) 设置页脚
BaseExcelWriter<K,V>	freeze() 固定行
BaseExcelWriter<K,V>	freeze(int row) 固定行
int	getColumnMaxIndex() 获取最大列索引
int	getLines() 获取总行数
int	getRowIndex()
org.apache.poi.ss.usermodel.Sheet	getSheet()
protected abstract Object	getValue(V row, K key) 获取值
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
BaseExcelWriter<K,V>	header(HeaderOption option) 设置页眉
BaseExcelWriter<K,V>	headerHeight(int height) 设置表头默认行高
BaseExcelWriter<K,V>	headers(String... headers) 添加表头
BaseExcelWriter<K,V>	headerStyle(int column, org.apache.poi.ss.usermodel.CellStyle style) 设置头 style
BaseExcelWriter<K,V>	headerUseRowStyle() 表头是否使用行样式
BaseExcelWriter<K,V>	height(int height) 设置默认行高
BaseExcelWriter<K,V>	hidden() 设置隐藏表格
BaseExcelWriter<K,V>	hidden(int column) 设置隐藏列
BaseExcelWriter<K,V>	merge(org.apache.poi.ss.util.CellRangeAddress region, boolean mergeBorder) 合并单元格
BaseExcelWriter<K,V>	merge(int row, int firstCol, int lastCol)
BaseExcelWriter<K,V>	merge(int row, int firstCol, int lastCol, boolean mergeBorder)
BaseExcelWriter<K,V>	merge(int firstRow, int lastRow, int firstCol, int lastCol)
BaseExcelWriter<K,V>	merge(int firstRow, int lastRow, int firstCol, int lastCol, boolean mergeBorder) 合并单元格
BaseExcelWriter<K,V>	option(int column, K k)
BaseExcelWriter<K,V>	option(int column, K k, ExcelFieldType type)
BaseExcelWriter<K,V>	option(int column, K k, ExcelFieldType type, Object defaultValue)
BaseExcelWriter<K,V>	option(int column, K k, ExcelFieldType type, String format)
BaseExcelWriter<K,V>	option(int column, K k, ExcelFieldType type, String format, Object defaultValue) 添加列配置
BaseExcelWriter<K,V>	option(int column, K k, Object defaultValue)
BaseExcelWriter<K,V>	option(K k, WriteFieldOption option)
BaseExcelWriter<K,V>	option(K k, WriteFieldOption option, Object defaultValue) 添加列配置
BaseExcelWriter<K,V>	print(PrintOption option) 设置打印属性
BaseExcelWriter<K,V>	protect(String password) 保护表格
BaseExcelWriter<K,V>	rowHeight(int height) 设数据行高
BaseExcelWriter<K,V>	selected() 设置选中
BaseExcelWriter<K,V>	skip() 跳过一行
BaseExcelWriter<K,V>	skip(int i) 跳过多行
BaseExcelWriter<K,V>	skipNullRows(boolean skip) 跳过空行
BaseExcelWriter<K,V>	style(int column, org.apache.poi.ss.usermodel.CellStyle style) 设置列 style
BaseExcelWriter<K,V>	style(int column, Function<V,Selector<V,org.apache.poi.ss.usermodel.CellStyle>> selector) 设置列样式选择器
BaseExcelWriter<K,V>	title(String title) 添加标题
BaseExcelWriter<K,V>	title(String title, int row) 添加标题
BaseExcelWriter<K,V>	title(String title, int row, int lastColumnIndex) 添加标题
BaseExcelWriter<K,V>	titleHeight(int height) 设置标题行高
BaseExcelWriter<K,V>	titleStyle(org.apache.poi.ss.usermodel.CellStyle style) 设置标题 style
BaseExcelWriter<K,V>	trim() 跳过首尾空格
BaseExcelWriter<K,V>	width(int width) 设置默认行宽
BaseExcelWriter<K,V>	width(int column, int width) 设置行宽

Methods inherited from class java.lang.Object

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

Field Detail

workbook

protected org.apache.poi.ss.usermodel.Workbook workbook

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

rowIndex

protected int rowIndex

当前行索引

columnMaxIndex

protected int columnMaxIndex

最大列索引

skipNullRows

protected boolean skipNullRows

是否跳过null

trim

protected boolean trim

是否清除空格

See Also:

String

columnUseDefaultStyle

protected boolean columnUseDefaultStyle

列是否使用默认样式 全局 skip() 会使用默认样式

headerUseRowStyle

protected boolean headerUseRowStyle

是否使用头部样式

titleHeight

protected int titleHeight

标题行高

headerHeight

protected int headerHeight

表头行高

rowHeight

protected int rowHeight

行高

options

protected Map<K,WriteFieldOption> options

配置项

titleStyle

protected org.apache.poi.ss.usermodel.CellStyle titleStyle

标题样式

headerStyles

protected Map<Integer,org.apache.poi.ss.usermodel.CellStyle> headerStyles

表头样式

columnStyles

protected Map<Integer,org.apache.poi.ss.usermodel.CellStyle> columnStyles

数据样式

columnStyleSelector

protected Map<Integer,Function<V,Selector<V,org.apache.poi.ss.usermodel.CellStyle>>> columnStyleSelector

数据样式选择器

有选择到的将会覆盖原有样式

Constructor Detail

BaseExcelWriter

public BaseExcelWriter(org.apache.poi.ss.usermodel.Workbook workbook,
                       org.apache.poi.ss.usermodel.Sheet sheet)

Method Detail

title

public BaseExcelWriter<K,V> title(String title)

添加标题

Parameters:

title - title

Returns:

this

title

public BaseExcelWriter<K,V> title(String title,
                                  int row)

添加标题

Parameters:

title - title

row - 使用行数

Returns:

this

title

public BaseExcelWriter<K,V> title(String title,
                                  int row,
                                  int lastColumnIndex)

添加标题

Parameters:

title - title

row - 使用行数

lastColumnIndex - 列数索引

Returns:

this

headers

public BaseExcelWriter<K,V> headers(String... headers)

添加表头

Parameters:

headers - 表头

Returns:

this

skip

public BaseExcelWriter<K,V> skip()

跳过一行

Returns:

this

skip

public BaseExcelWriter<K,V> skip(int i)

跳过多行

Parameters:

i - 行

Returns:

this

skipNullRows

public BaseExcelWriter<K,V> skipNullRows(boolean skip)

跳过空行

Parameters:

skip - 跳过空行

Returns:

this

trim

public BaseExcelWriter<K,V> trim()

跳过首尾空格

Returns:

this

width

public BaseExcelWriter<K,V> width(int column,
                                  int width)

设置行宽

Parameters:

column - 列索引

width - 行宽

Returns:

this

width

public BaseExcelWriter<K,V> width(int width)

设置默认行宽

Parameters:

width - 行宽

Returns:

this

height

public BaseExcelWriter<K,V> height(int height)

设置默认行高

Parameters:

height - 行高

Returns:

this

rowHeight

public BaseExcelWriter<K,V> rowHeight(int height)

设数据行高

Parameters:

height - 行高

Returns:

this

titleHeight

public BaseExcelWriter<K,V> titleHeight(int height)

设置标题行高

Parameters:

height - 行高

Returns:

this

headerHeight

public BaseExcelWriter<K,V> headerHeight(int height)

设置表头默认行高

Parameters:

height - 行高

Returns:

this

columnUseDefaultStyle

public BaseExcelWriter<K,V> columnUseDefaultStyle()

列是否使用默认样式 需要在设置样式之前调用

Returns:

this

headerUseRowStyle

public BaseExcelWriter<K,V> headerUseRowStyle()

表头是否使用行样式

Returns:

this

style

public BaseExcelWriter<K,V> style(int column,
                                  org.apache.poi.ss.usermodel.CellStyle style)

设置列 style

Parameters:

column - 列

style - style

Returns:

this

style

public BaseExcelWriter<K,V> style(int column,
                                  Function<V,Selector<V,org.apache.poi.ss.usermodel.CellStyle>> selector)

设置列样式选择器

Parameters:

column - column

selector - selector

Returns:

this

headerStyle

public BaseExcelWriter<K,V> headerStyle(int column,
                                        org.apache.poi.ss.usermodel.CellStyle style)

设置头 style

Parameters:

column - 列

style - style

Returns:

this

titleStyle

public BaseExcelWriter<K,V> titleStyle(org.apache.poi.ss.usermodel.CellStyle style)

设置标题 style

Parameters:

style - style

Returns:

this

selected

public BaseExcelWriter<K,V> selected()

设置选中

Returns:

this

hidden

public BaseExcelWriter<K,V> hidden()

设置隐藏表格

Returns:

this

hidden

public BaseExcelWriter<K,V> hidden(int column)

设置隐藏列

Parameters:

column - 列

Returns:

this

filter

public BaseExcelWriter<K,V> filter()

筛选列

Returns:

this

filter

public BaseExcelWriter<K,V> filter(int rowIndex)

筛选列

Parameters:

rowIndex - rowIndex

Returns:

this

filter

public BaseExcelWriter<K,V> filter(int rowIndex,
                                   int lastColumn)

筛选列

Parameters:

rowIndex - rowIndex

lastColumn - lastColumn

Returns:

this

freeze

public BaseExcelWriter<K,V> freeze()

固定行

Returns:

this

freeze

public BaseExcelWriter<K,V> freeze(int row)

固定行

Parameters:

row - row

Returns:

this

option

public BaseExcelWriter<K,V> option(int column,
                                   K k)

option

public BaseExcelWriter<K,V> option(int column,
                                   K k,
                                   Object defaultValue)

option

public BaseExcelWriter<K,V> option(int column,
                                   K k,
                                   ExcelFieldType type)

option

public BaseExcelWriter<K,V> option(int column,
                                   K k,
                                   ExcelFieldType type,
                                   Object defaultValue)

option

public BaseExcelWriter<K,V> option(int column,
                                   K k,
                                   ExcelFieldType type,
                                   String format)

option

public BaseExcelWriter<K,V> option(int column,
                                   K k,
                                   ExcelFieldType type,
                                   String format,
                                   Object defaultValue)

添加列配置

Parameters:

k - k

column - column

type - type

format - format

defaultValue - defaultValue

Returns:

this

option

public BaseExcelWriter<K,V> option(K k,
                                   WriteFieldOption option)

option

public BaseExcelWriter<K,V> option(K k,
                                   WriteFieldOption option,
                                   Object defaultValue)

添加列配置

Parameters:

k - k

option - option

defaultValue - defaultValue

Returns:

this

addOption

protected void addOption(K k,
                         WriteFieldOption option,
                         Object defaultValue)

添加列配置

Parameters:

k - k

option - option

defaultValue

public BaseExcelWriter<K,V> defaultValue(K k,
                                         Object value)

设置默认值

Parameters:

k - K

value - 默认值

Returns:

this

merge

public BaseExcelWriter<K,V> merge(int row,
                                  int firstCol,
                                  int lastCol)

merge

public BaseExcelWriter<K,V> merge(int row,
                                  int firstCol,
                                  int lastCol,
                                  boolean mergeBorder)

merge

public BaseExcelWriter<K,V> merge(int firstRow,
                                  int lastRow,
                                  int firstCol,
                                  int lastCol)

merge

public BaseExcelWriter<K,V> merge(int firstRow,
                                  int lastRow,
                                  int firstCol,
                                  int lastCol,
                                  boolean mergeBorder)

合并单元格

Parameters:

firstRow - 合并开始行索引

lastRow - 合并结束行索引

firstCol - 合并开始列索引

lastCol - 合并结束列索引

mergeBorder - 是否合并边框

Returns:

this

merge

public BaseExcelWriter<K,V> merge(org.apache.poi.ss.util.CellRangeAddress region,
                                  boolean mergeBorder)

合并单元格

Parameters:

region - region

mergeBorder - 是否合并边框

Returns:

this

addRows

public BaseExcelWriter<K,V> addRows(Collection<V> list)

添加行

Parameters:

list - 行

Returns:

this

addRow

public BaseExcelWriter<K,V> addRow(V row)

添加行

Parameters:

row - 行

Returns:

this

header

public BaseExcelWriter<K,V> header(HeaderOption option)

设置页眉

Parameters:

option - option

Returns:

this

footer

public BaseExcelWriter<K,V> footer(FooterOption option)

设置页脚

Parameters:

option - option

Returns:

this

print

public BaseExcelWriter<K,V> print(PrintOption option)

设置打印属性

Parameters:

option - option

Returns:

this

protect

public BaseExcelWriter<K,V> protect(String password)

保护表格

Parameters:

password - password

Returns:

this

displayGridLines

public BaseExcelWriter<K,V> displayGridLines()

不显示网格线

Returns:

this

displayRowColHeadings

public BaseExcelWriter<K,V> displayRowColHeadings()

不显示行数和列数

Returns:

this

displayFormulas

public BaseExcelWriter<K,V> displayFormulas()

不执行公式 会修改列宽单位

Returns:

this

getValue

protected abstract Object getValue(V row,
                                   K key)

获取值

Parameters:

row - row

key - keyIndex

Returns:

value

createCellStyle

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

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

Returns:

单元格样式

createFont

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

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

Returns:

字体

createFormat

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

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

Returns:

格式

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

getSheet

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

getLines

public int getLines()

获取总行数

Returns:

总行数

getColumnMaxIndex

public int getColumnMaxIndex()

获取最大列索引

Returns:

最大列索引

getRowIndex

public int getRowIndex()

Returns:

写入的数据行数