BaseExcelReader (orion-kit 2.0.2 API)

java.lang.Object
- cn.orionsec.kit.office.excel.reader.BaseExcelReader<K,T>

All Implemented Interfaces:

SafeCloseable, Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

ExcelArrayReader, ExcelBeanReader, ExcelLambdaReader, ExcelMapReader
```
public abstract class BaseExcelReader<K,T>
extends Object
implements SafeCloseable, Iterable<T>
```
excel 读取器基类

Since:

2021/1/4 17:09

Version:

1.0.0

Author:

Jiahang Li

Field Summary

Fields
Modifier and Type	Field and Description
`protected Consumer<T>`	`consumer` 读取的消费器
`protected int`	`currentIndex` 迭代器索引
`protected boolean`	`end` 是否已经读取完毕
`protected boolean`	`init` 是否已经初始化
`protected Iterator<org.apache.poi.ss.usermodel.Row>`	`iterator` 行迭代器
`protected int`	`lines` 总行数
`protected Map<K,ImportFieldOption>`	`options` 配置信息 key: key value: 配置
`protected PictureParser`	`pictureParser` 图片解析器
`protected int`	`rowIndex` 行索引
`protected int`	`rowNum` 读取的行
`protected List<T>`	`rows` 读取的记录
`protected org.apache.poi.ss.usermodel.Sheet`	`sheet`
`protected boolean`	`store` 是否存储数据
`protected boolean`	`streaming` 是否为流式读取
`protected boolean`	`trim` 是否清除空格
`protected org.apache.poi.ss.usermodel.Workbook`	`workbook`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseExcelReader(org.apache.poi.ss.usermodel.Workbook workbook, org.apache.poi.ss.usermodel.Sheet sheet, List<T> rows, Consumer<T> consumer)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addOption(K k, ImportFieldOption option)` 添加配置
`protected boolean`	`checkHasPicture()` 检查是否包含图片
`protected void`	`checkInit()` 检查是否初始化
`protected void`	`checkStreamingSupportType(ExcelReadType type)` 检查是否为streaming支持的类型
`BaseExcelReader<K,T>`	`clear()` 清空读取的行
`void`	`close()` 安全关闭
`int`	`getLines()`
`protected byte[]`	`getPicture(int col, org.apache.poi.ss.usermodel.Row row)` 获取图片
`int`	`getRowNum()`
`List<T>`	`getRows()`
`org.apache.poi.ss.usermodel.Sheet`	`getSheet()`
`org.apache.poi.ss.usermodel.Workbook`	`getWorkbook()`
`BaseExcelReader<K,T>`	`init()` 初始化默认实现
`ExcelReaderIterator<T>`	`iterator()` excel 迭代器不会存储也不会消费
`protected T`	`nextRow()` 读取一行
`protected abstract T`	`parserRow(org.apache.poi.ss.usermodel.Row row)` 解析行
`BaseExcelReader<K,T>`	`read()` 读取所有行
`BaseExcelReader<K,T>`	`read(int i)` 读取多行
`protected void`	`readRow()` 读取一行
`BaseExcelReader<K,T>`	`recalculationFormula()` 重新计算所有公式
`BaseExcelReader<K,T>`	`skip()` 跳过一行
`BaseExcelReader<K,T>`	`skip(int i)` 跳过多行
`BaseExcelReader<K,T>`	`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

Field Detail

workbook

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

sheet

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

iterator

protected Iterator<org.apache.poi.ss.usermodel.Row> iterator

行迭代器

currentIndex
```
protected int currentIndex
```
迭代器索引

rowIndex
```
protected int rowIndex
```
行索引

rowNum
```
protected int rowNum
```
读取的行

lines
```
protected int lines
```
总行数

end
```
protected boolean end
```
是否已经读取完毕

trim
```
protected boolean trim
```
是否清除空格

See Also:

String

streaming
```
protected boolean streaming
```
是否为流式读取

rows
```
protected List<T> rows
```
读取的记录

consumer
```
protected Consumer<T> consumer
```
读取的消费器

store
```
protected boolean store
```
是否存储数据

options

protected Map<K,ImportFieldOption> options

配置信息 key: key value: 配置

pictureParser
```
protected PictureParser pictureParser
```
图片解析器

init
```
protected boolean init
```
是否已经初始化

Constructor Detail

BaseExcelReader

protected BaseExcelReader(org.apache.poi.ss.usermodel.Workbook workbook,
                          org.apache.poi.ss.usermodel.Sheet sheet,
                          List<T> rows,
                          Consumer<T> consumer)

Method Detail
- iterator
```
public ExcelReaderIterator<T> iterator()
```
  excel 迭代器不会存储也不会消费
  
  Specified by:
  
  iterator in interface Iterable<T>
  
  Returns:
  
  迭代器
- init
```
public BaseExcelReader<K,T> init()
```
  初始化默认实现
  
  Returns:
  
  this
- skip
```
public BaseExcelReader<K,T> skip()
```
  跳过一行
  
  Returns:
  
  this
- skip
```
public BaseExcelReader<K,T> skip(int i)
```
  跳过多行
  
  Parameters:
  
  i - 行
  
  Returns:
  
  this
- trim
```
public BaseExcelReader<K,T> trim()
```
  是否清除空格
  
  Returns:
  
  this
- recalculationFormula
```
public BaseExcelReader<K,T> recalculationFormula()
```
  重新计算所有公式
  
  Returns:
  
  this
- read
```
public BaseExcelReader<K,T> read()
```
  读取所有行
  
  Returns:
  
  this
- read
```
public BaseExcelReader<K,T> read(int i)
```
  读取多行
  
  Parameters:
  
  i - 行
  
  Returns:
  
  this
- clear
```
public BaseExcelReader<K,T> clear()
```
  清空读取的行
  
  Returns:
  
  this
- readRow
```
protected void readRow()
```
  读取一行
- nextRow
```
protected T nextRow()
```
  读取一行
  
  Returns:
  
  row
- parserRow
```
protected abstract T parserRow(org.apache.poi.ss.usermodel.Row row)
```
  解析行
  
  Parameters:
  
  row - row
  
  Returns:
  
  row
- checkInit
```
protected void checkInit()
```
  检查是否初始化
- checkHasPicture
```
protected boolean checkHasPicture()
```
  检查是否包含图片
  
  Returns:
  
  true包含
- checkStreamingSupportType
```
protected void checkStreamingSupportType(ExcelReadType type)
```
  检查是否为streaming支持的类型
  
  Parameters:
  
  type - type
- addOption
```
protected void addOption(K k,
                         ImportFieldOption option)
```
  添加配置
  
  Parameters:
  
  k - k
  
  option - 配置
- getPicture
```
protected byte[] getPicture(int col,
                            org.apache.poi.ss.usermodel.Row row)
```
  获取图片
  
  Parameters:
  
  col - 列
  
  row - 行
  
  Returns:
  
  图片
- close
```
public void close()
```
  Description copied from interface: SafeCloseable
  
  安全关闭
  
  Specified by:
  
  close in interface SafeCloseable
  
  Specified by:
  
  close in interface Closeable
  
  Specified by:
  
  close in interface AutoCloseable
- getWorkbook
```
public org.apache.poi.ss.usermodel.Workbook getWorkbook()
```
- getSheet
```
public org.apache.poi.ss.usermodel.Sheet getSheet()
```
- getRows
```
public List<T> getRows()
```
- getRowNum
```
public int getRowNum()
```
  Returns:
  
  读取的行数
- getLines
```
public int getLines()
```
  Returns:
  
  总行数

Class BaseExcelReader<K,T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

workbook

sheet

iterator

currentIndex

rowIndex

rowNum

lines

end

trim

streaming

rows

consumer

store

options

pictureParser

init

Constructor Detail

BaseExcelReader

Method Detail

iterator

init

skip

skip

trim

recalculationFormula

read

read

clear

readRow

nextRow

parserRow

checkInit

checkHasPicture

checkStreamingSupportType

addOption

getPicture

close

getWorkbook

getSheet

getRows

getRowNum

getLines