org.dromara.hutool.poi.excel.writer

Class ExcelWriteConfig

java.lang.Object

org.dromara.hutool.poi.excel.ExcelConfig

org.dromara.hutool.poi.excel.writer.ExcelWriteConfig

public class ExcelWriteConfig
extends ExcelConfig

Excel写出配置

Since:

6.0.0

Author:

Looly

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator<String>	aliasComparator 标题顺序比较器
protected boolean	insertRow 是否强制插入行 如果为true，则写入行以下的已存在行下移，false则利用填充已有行，不存在再创建行
protected boolean	onlyAlias 是否只保留别名对应的字段

Fields inherited from class org.dromara.hutool.poi.excel.ExcelConfig

cellEditor, headerAlias

Constructor Summary

Constructors

Constructor and Description
ExcelWriteConfig()

Method Summary

Modifier and Type	Method and Description
ExcelWriteConfig	addHeaderAlias(String header, String alias) 增加标题别名
Table<?,?,?>	aliasTable(Map<?,?> rowMap) 为指定的key列表添加标题别名，如果没有定义key的别名，在onlyAlias为false时使用原key key为别名，value为字段值
Comparator<String>	getCachedAliasComparator() 获取单例的别名比较器，比较器的顺序为别名加入的顺序
ExcelWriteConfig	removeHeaderAlias(String header) 去除标题别名
ExcelWriteConfig	setHeaderAlias(Map<String,String> headerAlias) 设置标题行的别名Map
ExcelWriteConfig	setInsertRow(boolean insertRow) 设置是否插入行，如果为true，则写入行以下的已存在行下移，false则利用填充已有行，不存在时创建行
ExcelWriteConfig	setOnlyAlias(boolean isOnlyAlias) 设置是否只保留别名中的字段值，如果为true，则不设置alias的字段将不被输出，false表示原样输出 Bean中设置@Alias时，setOnlyAlias是无效的，这个参数只和addHeaderAlias配合使用，原因是注解是Bean内部的操作，而addHeaderAlias是Writer的操作，不互通。

Methods inherited from class org.dromara.hutool.poi.excel.ExcelConfig

aliasHeader, aliasHeader, clearHeaderAlias, getCellEditor, getHeaderAlias, setCellEditor

Methods inherited from class java.lang.Object

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

Field Detail

onlyAlias

protected boolean onlyAlias

是否只保留别名对应的字段

insertRow

protected boolean insertRow

是否强制插入行
如果为true，则写入行以下的已存在行下移，false则利用填充已有行，不存在再创建行

aliasComparator

protected Comparator<String> aliasComparator

标题顺序比较器

Constructor Detail

ExcelWriteConfig

public ExcelWriteConfig()

Method Detail

setHeaderAlias

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

Description copied from class: ExcelConfig

设置标题行的别名Map

Overrides:

setHeaderAlias in class ExcelConfig

Parameters:

headerAlias - 别名Map

Returns:

this

addHeaderAlias

public ExcelWriteConfig addHeaderAlias(String header,
                                       String alias)

Description copied from class: ExcelConfig

增加标题别名

Overrides:

addHeaderAlias in class ExcelConfig

Parameters:

header - 标题

alias - 别名

Returns:

this

removeHeaderAlias

public ExcelWriteConfig removeHeaderAlias(String header)

Description copied from class: ExcelConfig

去除标题别名

Overrides:

removeHeaderAlias in class ExcelConfig

Parameters:

header - 标题

Returns:

this

setOnlyAlias

public ExcelWriteConfig setOnlyAlias(boolean isOnlyAlias)

设置是否只保留别名中的字段值，如果为true，则不设置alias的字段将不被输出，false表示原样输出 Bean中设置@Alias时，setOnlyAlias是无效的，这个参数只和addHeaderAlias配合使用，原因是注解是Bean内部的操作，而addHeaderAlias是Writer的操作，不互通。

Parameters:

isOnlyAlias - 是否只保留别名中的字段值

Returns:

this

setInsertRow

public ExcelWriteConfig setInsertRow(boolean insertRow)

设置是否插入行，如果为true，则写入行以下的已存在行下移，false则利用填充已有行，不存在时创建行

Parameters:

insertRow - 是否插入行

Returns:

this

getCachedAliasComparator

public Comparator<String> getCachedAliasComparator()

获取单例的别名比较器，比较器的顺序为别名加入的顺序

Returns:

Comparator

aliasTable

public Table<?,?,?> aliasTable(Map<?,?> rowMap)

为指定的key列表添加标题别名，如果没有定义key的别名，在onlyAlias为false时使用原key
key为别名，value为字段值

Parameters:

rowMap - 一行数据

Returns:

别名列表