cn.orionsec.kit.office.excel.reader

Class ExcelMapReader<K,V>

java.lang.Object

cn.orionsec.kit.office.excel.reader.BaseExcelReader<K,MutableMap<K,V>>

cn.orionsec.kit.office.excel.reader.ExcelMapReader<K,V>

All Implemented Interfaces:

SafeCloseable, Closeable, AutoCloseable, Iterable<MutableMap<K,V>>

public class ExcelMapReader<K,V>
extends BaseExcelReader<K,MutableMap<K,V>>

excel map 读取器

支持高级数据类型

Excels.getCellValue(Cell, ExcelReadType, CellOption)

Since:

2021/1/5 11:52

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields inherited from class cn.orionsec.kit.office.excel.reader.BaseExcelReader

consumer, currentIndex, end, init, iterator, lines, options, pictureParser, rowIndex, rowNum, rows, sheet, store, streaming, trim, workbook

Constructor Summary

Constructors

Constructor and Description
ExcelMapReader(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet)
ExcelMapReader(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, Consumer<MutableMap<K,V>> consumer)
ExcelMapReader(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, List<MutableMap<K,V>> store)

Method Summary

Modifier and Type	Method and Description
protected void	addOption(K key, ImportFieldOption option, V defaultValue) 添加配置
static <K,V> ExcelMapReader<K,V>	create(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet)
static <K,V> ExcelMapReader<K,V>	create(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, Consumer<MutableMap<K,V>> consumer)
static <K,V> ExcelMapReader<K,V>	create(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, List<MutableMap<K,V>> store)
ExcelMapReader<K,V>	defaultValue(K key, V value) 设置默认值
ExcelMapReader<K,V>	linked() 使用 linkedMap
ExcelMapReader<K,V>	nullPutKey(boolean nullPutKey) 如果为null是否插入key
ExcelMapReader<K,V>	option(int column, K key, ExcelReadType type)
ExcelMapReader<K,V>	option(int column, K key, ExcelReadType type, V defaultValue) 添加配置
ExcelMapReader<K,V>	option(K key, ImportFieldOption option)
ExcelMapReader<K,V>	option(K key, ImportFieldOption option, V defaultValue)
protected MutableMap<K,V>	parserRow(org.apache.poi.ss.usermodel.Row row) 解析行

Methods inherited from class cn.orionsec.kit.office.excel.reader.BaseExcelReader

addOption, checkHasPicture, checkInit, checkStreamingSupportType, clear, close, getLines, getPicture, getRowNum, getRows, getSheet, getWorkbook, init, iterator, nextRow, read, read, readRow, recalculationFormula, skip, skip, trim

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ExcelMapReader

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

ExcelMapReader

public ExcelMapReader(org.apache.poi.ss.usermodel.Workbook workbook,
                      org.apache.poi.ss.usermodel.Sheet sheet,
                      List<MutableMap<K,V>> store)

ExcelMapReader

public ExcelMapReader(org.apache.poi.ss.usermodel.Workbook workbook,
                      org.apache.poi.ss.usermodel.Sheet sheet,
                      Consumer<MutableMap<K,V>> consumer)

Method Detail

create

public static <K,V> ExcelMapReader<K,V> create(org.apache.poi.ss.usermodel.Workbook workbook,
                                               org.apache.poi.ss.usermodel.Sheet sheet)

create

public static <K,V> ExcelMapReader<K,V> create(org.apache.poi.ss.usermodel.Workbook workbook,
                                               org.apache.poi.ss.usermodel.Sheet sheet,
                                               List<MutableMap<K,V>> store)

create

public static <K,V> ExcelMapReader<K,V> create(org.apache.poi.ss.usermodel.Workbook workbook,
                                               org.apache.poi.ss.usermodel.Sheet sheet,
                                               Consumer<MutableMap<K,V>> consumer)

option

public ExcelMapReader<K,V> option(K key,
                                  ImportFieldOption option)

option

public ExcelMapReader<K,V> option(K key,
                                  ImportFieldOption option,
                                  V defaultValue)

option

public ExcelMapReader<K,V> option(int column,
                                  K key,
                                  ExcelReadType type)

option

public ExcelMapReader<K,V> option(int column,
                                  K key,
                                  ExcelReadType type,
                                  V defaultValue)

添加配置

Parameters:

column - 列

key - key

type - 类型

defaultValue - 默认值

Returns:

this

addOption

protected void addOption(K key,
                         ImportFieldOption option,
                         V defaultValue)

添加配置

Parameters:

key - key

option - 配置

defaultValue - 默认值

defaultValue

public ExcelMapReader<K,V> defaultValue(K key,
                                        V value)

设置默认值

Parameters:

key - key

value - 默认值

Returns:

this

linked

public ExcelMapReader<K,V> linked()

使用 linkedMap

Returns:

this

nullPutKey

public ExcelMapReader<K,V> nullPutKey(boolean nullPutKey)

如果为null是否插入key

Parameters:

nullPutKey - ignore

Returns:

this

parserRow

protected MutableMap<K,V> parserRow(org.apache.poi.ss.usermodel.Row row)

Description copied from class: BaseExcelReader

解析行

Specified by:

parserRow in class BaseExcelReader<K,MutableMap<K,V>>

Parameters:

row - row

Returns:

row