org.dromara.hutool.poi.excel

Class ExcelConfig

java.lang.Object

org.dromara.hutool.poi.excel.ExcelConfig

Direct Known Subclasses:

ExcelReadConfig, ExcelWriteConfig

public class ExcelConfig
extends Object

Excel读取和写出通用配置

Since:

6.0.0

Author:

Looly

Field Summary

Fields

Modifier and Type	Field and Description
protected CellEditor	cellEditor 单元格值处理接口
protected Map<String,String>	headerAlias 标题行别名

Constructor Summary

Constructors

Constructor and Description
ExcelConfig()

Method Summary

Modifier and Type	Method and Description
ExcelConfig	addHeaderAlias(String header, String alias) 增加标题别名
List<Object>	aliasHeader(List<Object> headerList) 转换标题别名，如果没有别名则使用原标题，当标题为空时，列号对应的字母便是header
Object	aliasHeader(Object headerObj, int index) 转换标题别名，如果没有别名则使用原标题，当标题为空时，列号对应的字母便是header
ExcelConfig	clearHeaderAlias() 清空标题别名，key为Map中的key，value为别名
CellEditor	getCellEditor() 获取单元格值处理器
Map<String,String>	getHeaderAlias() 获得标题行的别名Map
ExcelConfig	removeHeaderAlias(String header) 去除标题别名
ExcelConfig	setCellEditor(CellEditor cellEditor) 设置单元格值处理逻辑 当Excel中的值并不能满足我们的读取要求时，通过传入一个编辑接口，可以对单元格值自定义，例如对数字和日期类型值转换为字符串等
ExcelConfig	setHeaderAlias(Map<String,String> headerAlias) 设置标题行的别名Map

Methods inherited from class java.lang.Object

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

Field Detail

headerAlias

protected Map<String,String> headerAlias

标题行别名

cellEditor

protected CellEditor cellEditor

单元格值处理接口

Constructor Detail

ExcelConfig

public ExcelConfig()

Method Detail

getHeaderAlias

public Map<String,String> getHeaderAlias()

获得标题行的别名Map

Returns:

别名Map

setHeaderAlias

public ExcelConfig setHeaderAlias(Map<String,String> headerAlias)

设置标题行的别名Map

Parameters:

headerAlias - 别名Map

Returns:

this

addHeaderAlias

public ExcelConfig addHeaderAlias(String header,
                                  String alias)

增加标题别名

Parameters:

header - 标题

alias - 别名

Returns:

this

removeHeaderAlias

public ExcelConfig removeHeaderAlias(String header)

去除标题别名

Parameters:

header - 标题

Returns:

this

clearHeaderAlias

public ExcelConfig clearHeaderAlias()

清空标题别名，key为Map中的key，value为别名

Returns:

this

aliasHeader

public List<Object> aliasHeader(List<Object> headerList)

转换标题别名，如果没有别名则使用原标题，当标题为空时，列号对应的字母便是header

Parameters:

headerList - 原标题列表

Returns:

转换别名列表

aliasHeader

public Object aliasHeader(Object headerObj,
                          int index)

转换标题别名，如果没有别名则使用原标题，当标题为空时，列号对应的字母便是header

Parameters:

headerObj - 原标题

index - 标题所在列号，当标题为空时，列号对应的字母便是header

Returns:

转换别名列表

getCellEditor

public CellEditor getCellEditor()

获取单元格值处理器

Returns:

单元格值处理器

setCellEditor

public ExcelConfig setCellEditor(CellEditor cellEditor)

设置单元格值处理逻辑
当Excel中的值并不能满足我们的读取要求时，通过传入一个编辑接口，可以对单元格值自定义，例如对数字和日期类型值转换为字符串等

Parameters:

cellEditor - 单元格值处理接口

Returns:

this