程序包 cn.toutatis.xvoid.axolotl.excel.reader

类 AxolotlExcelReader<T>

java.lang.Object

cn.toutatis.xvoid.axolotl.excel.reader.AxolotlExcelReader<T>

所有已实现的接口:

Iterator<List<T>>

public class AxolotlExcelReader<T>
extends Object
implements Iterator<List<T>>

Excel读取器

作者:

Toutatis_Gc

构造器概要

构造器

构造器	说明
AxolotlExcelReader(File excelFile)	构造文件读取器
AxolotlExcelReader(File excelFile, boolean withDefaultConfig)
AxolotlExcelReader(File excelFile, Class<T> clazz)
AxolotlExcelReader(File excelFile, Class<T> clazz, boolean withDefaultConfig)	[ROOT] 构造文件读取器 初始化读取Excel文件 1.初始化加载文件先判断文件是否正常并且是需要的格式 2.将文件加载到POI工作簿中
AxolotlExcelReader(InputStream ins)	[ROOT] 流支持构造
AxolotlExcelReader(InputStream ins, Class<T> clazz)

方法概要

修饰符和类型	方法	说明
String	getHumanReadablePosition()	获取当前读取位置
int	getPhysicalRowNumber()
int	getPhysicalRowNumber(ReaderConfig<?> readerConfig)
int	getRecordRowNumber()
int	getRecordRowNumber(ReaderConfig<?> readerConfig)
int	getRowNumber(boolean isPhysical)	获取行数
int	getRowNumber(int sheetIndex, boolean isPhysical)	[ROOT] 获取行数
int	getRowNumber(ReaderConfig<?> readerConfig, boolean isPhysical)	获取行数
boolean	hasNext()	是否有下一批数据
List<T>	next()	获取下一批数据
List<T>	readSheetData()
List<T>	readSheetData(int start)
List<T>	readSheetData(int start, int end)	读取起始和结束位置数据
List<T>	readSheetData(int start, int end, int initialRowPositionOffset)
<RT> List<RT>	readSheetData(ReadConfigBuilder<RT> configBuilder)	使用读取配置构建读取配置
<RT> List<RT>	readSheetData(ReaderConfig<RT> readerConfig)	[ROOT] 读取Excel数据
<RT> List<RT>	readSheetData(Class<RT> castClass)
<RT> List<RT>	readSheetData(Class<RT> castClass, int sheetIndex)
<RT> List<RT>	readSheetData(Class<RT> castClass, int sheetIndex, boolean withDefaultConfig, int startIndex, int endIndex, int initialRowPositionOffset)	读取指定sheet的数据
<RT> List<RT>	readSheetData(Class<RT> castClass, String sheetName)
<RT> RT	readSheetDataAsObject(ReaderConfig<RT> readerConfig)	[ROOT] 读取Excel文件数据为一个实体
<RT> List<RT>	readSheetDataOffset(Class<RT> castClass, int initialRowPositionOffset)

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.Iterator

forEachRemaining, remove

构造器详细资料

AxolotlExcelReader

public AxolotlExcelReader(File excelFile)

构造文件读取器

AxolotlExcelReader

public AxolotlExcelReader(File excelFile,
 boolean withDefaultConfig)

AxolotlExcelReader

public AxolotlExcelReader(File excelFile,
 Class<T> clazz)

AxolotlExcelReader

public AxolotlExcelReader(InputStream ins)

[ROOT] 流支持构造

参数:

ins - 文件流

AxolotlExcelReader

public AxolotlExcelReader(InputStream ins,
 Class<T> clazz)

AxolotlExcelReader

public AxolotlExcelReader(File excelFile,
 Class<T> clazz,
 boolean withDefaultConfig)

[ROOT] 构造文件读取器 初始化读取Excel文件 1.初始化加载文件先判断文件是否正常并且是需要的格式 2.将文件加载到POI工作簿中

参数:

excelFile - Excel工作簿文件

withDefaultConfig - 是否使用默认配置

方法详细资料

readSheetDataAsObject

public <RT> RT readSheetDataAsObject(ReaderConfig<RT> readerConfig)

[ROOT] 读取Excel文件数据为一个实体

类型参数:

RT - 读取类型

参数:

readerConfig - 读取配置

返回:

读取的数据

readSheetData

public List<T> readSheetData()

readSheetData

public List<T> readSheetData(int start)

readSheetData

public List<T> readSheetData(int start,
 int end)

读取起始和结束位置数据

readSheetData

public List<T> readSheetData(int start,
 int end,
 int initialRowPositionOffset)

参数:

initialRowPositionOffset - 初始行偏移量

readSheetData

public <RT> List<RT> readSheetData(Class<RT> castClass,
 String sheetName)

参数:

castClass - 读取的Java类型

sheetName - 工作表名称

readSheetData

public <RT> List<RT> readSheetData(Class<RT> castClass,
 int sheetIndex)

参数:

castClass - 读取的Java类型

sheetIndex - 表索引

readSheetDataOffset

public <RT> List<RT> readSheetDataOffset(Class<RT> castClass,
 int initialRowPositionOffset)

参数:

castClass - 读取的Java类型

initialRowPositionOffset - 起始偏移量

readSheetData

public <RT> List<RT> readSheetData(Class<RT> castClass)

参数:

castClass - 读取的Java类型

readSheetData

public <RT> List<RT> readSheetData(Class<RT> castClass,
 int sheetIndex,
 boolean withDefaultConfig,
 int startIndex,
 int endIndex,
 int initialRowPositionOffset)

读取指定sheet的数据

类型参数:

RT - 类型泛型

参数:

castClass - 读取的类型

sheetIndex - sheet索引

withDefaultConfig - 是否使用默认配置

startIndex - 起始行

endIndex - 结束行

initialRowPositionOffset - 起始行偏移量

返回:

读取的数据

readSheetData

public <RT> List<RT> readSheetData(ReadConfigBuilder<RT> configBuilder)

使用读取配置构建读取配置

类型参数:

RT - 读取的类型泛型

参数:

configBuilder - 读取配置构建器

返回:

读取数据

readSheetData

public <RT> List<RT> readSheetData(ReaderConfig<RT> readerConfig)

[ROOT] 读取Excel数据

类型参数:

RT - 读取的类型泛型

参数:

readerConfig - 读取配置

返回:

读取数据

getPhysicalRowNumber

public int getPhysicalRowNumber()

getRecordRowNumber

public int getRecordRowNumber()

getRowNumber

public int getRowNumber(boolean isPhysical)

获取行数

参数:

isPhysical - 是否是物理行数

返回:

行数

getRowNumber

public int getRowNumber(ReaderConfig<?> readerConfig,
 boolean isPhysical)

获取行数

参数:

readerConfig - 读取配置

isPhysical - 是否是物理行数

返回:

行数

getPhysicalRowNumber

public int getPhysicalRowNumber(ReaderConfig<?> readerConfig)

参数:

readerConfig - 读取配置

getRecordRowNumber

public int getRecordRowNumber(ReaderConfig<?> readerConfig)

参数:

readerConfig - 读取配置

getRowNumber

public int getRowNumber(int sheetIndex,
 boolean isPhysical)

[ROOT] 获取行数

参数:

sheetIndex - 表索引

isPhysical - 是否是物理行数

返回:

行数

getHumanReadablePosition

public String getHumanReadablePosition()

获取当前读取位置

hasNext

public boolean hasNext()

是否有下一批数据

指定者:

hasNext 在接口中 Iterator<T>

next

public List<T> next()

获取下一批数据

指定者:

next 在接口中 Iterator<T>