| 程序包 | 说明 |
|---|---|
| org.ttzero.excel.entity | |
| org.ttzero.excel.reader |
| 限定符和类型 | 方法和说明 |
|---|---|
protected TemplateSheet.CommitRowSetIterator |
TemplateSheet.prepare(Sheet originalSheet)
预处理样式和占位符
|
| 限定符和类型 | 接口和说明 |
|---|---|
interface |
CalcSheet
支持解析公式的工作表,可以通过
asCalcSheet()将普通工作表转为CalcSheet |
interface |
FullSheet
全属性工作表,与普通工作表不同除了值以外
FullSheet将会额外读取行高和列宽以及单元格公式,
全属性工作表虽然继承MergeSheet但并不会主动在合并单元格复制值,如果需要复制值需要明确调用FullSheet.copyOnMerged()方法 |
interface |
MergeSheet
支持复制合并单元格的工作表,可以通过
asMergeSheet()将普通工作表转为MergeSheet
通常合并单元格的值保存在左上角第一个单元格中其余单元格的值为null,如果要读取这类合并单元的值就需要特殊处理,
如果将工作表转为MergeSheet就可以直接获取合并范围内的所有单元格的值,每个值均为首个单元格的值。 |
| 限定符和类型 | 类和说明 |
|---|---|
class |
XMLSheet
The open-xml format Worksheet
|
| 限定符和类型 | 字段和说明 |
|---|---|
Sheet |
Drawings.Picture.sheet
图片所在的工作表
Sheet |
protected Sheet[] |
ExcelReader.sheets
保存所有工作表,读取工作表之前必须调用
load()方法加载初始信息 |
| 限定符和类型 | 方法和说明 |
|---|---|
default Sheet |
Sheet.addHeaderColumnReadOption(int option)
添加表头读取属性
|
Sheet[] |
ExcelReader.all()
获取全部工作表,通过此方法获取的工作表在读取前需要先调用
load方法 |
Sheet |
Sheet.asSheet()
将工作表转为普通工作表
Sheet,它只专注获取值 |
Sheet |
Sheet.bind(Class<?> clazz)
绑定数据类型,后续可以通过
Row.get()方法直接将行数据转为指定的对象 |
default Sheet |
Sheet.bind(Class<?> clazz,
int fromRowNum)
绑定数据类型并指定表头行号,后续可以通过
Row.get()方法直接将行数据转为指定的对象 |
default Sheet |
Sheet.bind(Class<?> clazz,
int fromRowNum,
int toRowNum)
绑定数据类型并指定表头行号,后续可以通过
Row.get()方法直接将行数据转为指定的对象 |
Sheet |
Sheet.bind(Class<?> clazz,
Row row)
绑定数据类型并指定表头,后续可以通过
Row.get()方法直接将行数据转为指定的对象 |
Sheet |
XMLSheet.bind(Class<?> clazz,
Row row) |
default Sheet |
Sheet.forceImport()
强制匹配,即使没有
ExcelColumn注解的字段也会强制匹配
将行数据转换为Java对象时默认情况下只匹配带有ExcelColumn注释的字段。 |
Sheet |
Drawings.Picture.getSheet() |
default Sheet |
Sheet.header(int fromRowNum)
设置工作表的表头行号(从1开始)与Excel看到的行号一致
|
Sheet |
Sheet.header(int fromRowNum,
int toRowNum)
设置工作表的表头行号
注意: 指定标题行号后,行指针将移动到标题范围的下一行.
|
Sheet |
XMLSheet.header(int fromRowNum,
int toRowNum)
Specify the header rows endpoint
Note: After specifying the header row number, the row-pointer will move to the
next row of the header range.
|
default Sheet |
Sheet.headerColumnIgnoreCase()
设置忽略大小写匹配表头字段
|
default Sheet |
Sheet.headerColumnToCamelCase()
设置驼峰风格匹配表头字段
|
Sheet |
Sheet.load()
加载工作表,读取工作表之前必须先使用此方法加载,使用Reader的场景已默认加载无需手动加载
|
default Sheet |
Sheet.reset()
重置游标以重头开始读,可以起到重复读的用处,不过此方法不是必要的,也可以直接通过reader获取对应工作表也可以
|
Sheet |
Sheet.setHeaderColumnReadOption(int option)
设置表头读取属性,将行数据转对象时由于Excel中的值与Java对象中定义的不同会使双方不匹配,设置读取属性可丰富读取能力,
多个属性可叠加
HeaderRow.FORCE_IMPORT: 强制导入,即使没有(ExcelColumn注解
HeaderRow.IGNORE_CASE: 忽略大小写匹配
HeaderRow.CAMEL_CASE: 驼峰风格匹配
reader.sheet(0).setHeaderColumnReadOption(HeaderRow.FORCE_IMPORT | HeaderRow.IGNORE_CASE)
|
Sheet |
XMLSheet.setHeaderColumnReadOption(int option)
Setting header columns preprocessing properties
|
Sheet |
ExcelReader.sheet(int index)
获取指定位置的工作表,此方法默认
load工作表所以外部无需再次调用load方法 |
Sheet |
ExcelReader.sheet(String sheetName)
获取指定名称的工作表,此方法默认
load工作表所以外部无需再次调用load方法 |
protected Sheet |
ExcelReader.sheetFactory()
通过OPTION创建相应工作表
|
| 限定符和类型 | 方法和说明 |
|---|---|
Stream<Sheet> |
ExcelReader.sheets()
返回一个工作表的流,它将按顺序解析当前excel包含所有工作表(含隐藏工作表),
此方法默认
load工作表所以外部无需再次调用load方法 |
| 限定符和类型 | 方法和说明 |
|---|---|
default List<Drawings.Picture> |
Drawings.listPictures(Sheet sheet)
列出指定工作表包含的图片
|
protected List<Drawings.Picture> |
XMLDrawings.quickFindCellImages(Sheet sheet,
Map<String,Path> cellImageMapper)
快整查询内嵌图片在工作表中的位置
|
Copyright © 2024. All rights reserved.