cn.hutool.poi.excel

类 ExcelBase<T extends ExcelBase<T>>

java.lang.Object

cn.hutool.poi.excel.ExcelBase<T>

类型参数:

T - 子类类型，用于返回this

所有已实现的接口:

Closeable, AutoCloseable

直接已知子类:

ExcelReader, ExcelWriter

public class ExcelBase<T extends ExcelBase<T>>
extends Object
implements Closeable

Excel基础类，用于抽象ExcelWriter和ExcelReader中共用部分的对象和方法

从以下版本开始:

4.1.4

作者:

looly

字段概要

字段

限定符和类型	字段和说明
protected boolean	isClosed 是否被关闭
protected org.apache.poi.ss.usermodel.Sheet	sheet Excel中对应的Sheet
protected org.apache.poi.ss.usermodel.Workbook	workbook 工作簿

构造器概要

构造器

构造器和说明
ExcelBase(org.apache.poi.ss.usermodel.Sheet sheet) 构造

方法概要

方法

限定符和类型	方法和说明
void	close() 关闭工作簿 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
org.apache.poi.ss.usermodel.Cell	getCell(int x, int y) 获取指定坐标单元格，单元格不存在时返回null
org.apache.poi.ss.usermodel.Cell	getCell(int x, int y, boolean isCreateIfNotExist) 获取指定坐标单元格，如果isCreateIfNotExist为false，则在单元格不存在时返回null
int	getColumnCount() 获取第一行总列数，计算方法为： 最后一列序号 + 1
int	getColumnCount(int rowNum) 获取总列数，计算方法为： 最后一列序号 + 1
org.apache.poi.ss.usermodel.Cell	getOrCreateCell(int x, int y) 获取或创建指定坐标单元格
org.apache.poi.ss.usermodel.CellStyle	getOrCreateCellStyle(int x, int y) 为指定单元格获取或者创建样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.CellStyle	getOrCreateColumnStyle(int x) 获取或创建某一行的样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.Row	getOrCreateRow(int y) 获取或者创建行
org.apache.poi.ss.usermodel.CellStyle	getOrCreateRowStyle(int y) 获取或创建某一行的样式，返回样式后可以设置样式内容
int	getPhysicalRowCount() 获取有记录的行数，计算方法为： 最后一行序号 - 第一行序号 + 1
int	getRowCount() 获取总行数，计算方法为： 最后一行序号 + 1
org.apache.poi.ss.usermodel.Sheet	getSheet() 获取当前Sheet
int	getSheetCount() 返回工作簿表格数
List<String>	getSheetNames() 获取表名列表
List<org.apache.poi.ss.usermodel.Sheet>	getSheets() 获取此工作簿所有Sheet表
org.apache.poi.ss.usermodel.Workbook	getWorkbook() 获取Workbook
T	setSheet(int sheetIndex) 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认） 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
T	setSheet(String sheetName) 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。

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

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

字段详细资料

isClosed

protected boolean isClosed

是否被关闭

workbook

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

工作簿

sheet

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

Excel中对应的Sheet

构造器详细资料

ExcelBase

public ExcelBase(org.apache.poi.ss.usermodel.Sheet sheet)

构造

参数:

sheet - Excel中的sheet

方法详细资料

getWorkbook

public org.apache.poi.ss.usermodel.Workbook getWorkbook()

获取Workbook

返回:

Workbook

getSheetCount

public int getSheetCount()

返回工作簿表格数

返回:

工作簿表格数

从以下版本开始:

4.0.10

getSheets

public List<org.apache.poi.ss.usermodel.Sheet> getSheets()

获取此工作簿所有Sheet表

返回:

sheet表列表

从以下版本开始:

4.0.3

getSheetNames

public List<String> getSheetNames()

获取表名列表

返回:

表名列表

从以下版本开始:

4.0.3

getSheet

public org.apache.poi.ss.usermodel.Sheet getSheet()

获取当前Sheet

返回:

Sheet

setSheet

public T setSheet(String sheetName)

自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。
在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet。

参数:

sheetName - sheet名

返回:

this

从以下版本开始:

4.0.10

setSheet

public T setSheet(int sheetIndex)

自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认）
在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet

参数:

sheetIndex - sheet序号，从0开始计数

返回:

this

从以下版本开始:

4.0.10

getCell

public org.apache.poi.ss.usermodel.Cell getCell(int x,
                                       int y)

获取指定坐标单元格，单元格不存在时返回null

参数:

x - X坐标，从0计数，既列号

y - Y坐标，从0计数，既行号

返回:

Cell

从以下版本开始:

4.0.5

getOrCreateCell

public org.apache.poi.ss.usermodel.Cell getOrCreateCell(int x,
                                               int y)

获取或创建指定坐标单元格

参数:

x - X坐标，从0计数，既列号

y - Y坐标，从0计数，既行号

返回:

Cell

从以下版本开始:

4.0.6

getCell

public org.apache.poi.ss.usermodel.Cell getCell(int x,
                                       int y,
                                       boolean isCreateIfNotExist)

获取指定坐标单元格，如果isCreateIfNotExist为false，则在单元格不存在时返回null

参数:

x - X坐标，从0计数，既列号

y - Y坐标，从0计数，既行号

isCreateIfNotExist - 单元格不存在时是否创建

返回:

Cell

从以下版本开始:

4.0.6

getOrCreateRow

public org.apache.poi.ss.usermodel.Row getOrCreateRow(int y)

获取或者创建行

参数:

y - Y坐标，从0计数，既行号

返回:

Row

从以下版本开始:

4.1.4

getOrCreateCellStyle

public org.apache.poi.ss.usermodel.CellStyle getOrCreateCellStyle(int x,
                                                         int y)

为指定单元格获取或者创建样式，返回样式后可以设置样式内容

参数:

x - X坐标，从0计数，既列号

y - Y坐标，从0计数，既行号

返回:

CellStyle

从以下版本开始:

4.1.4

getOrCreateRowStyle

public org.apache.poi.ss.usermodel.CellStyle getOrCreateRowStyle(int y)

获取或创建某一行的样式，返回样式后可以设置样式内容

参数:

y - Y坐标，从0计数，既行号

返回:

CellStyle

从以下版本开始:

4.1.4

getOrCreateColumnStyle

public org.apache.poi.ss.usermodel.CellStyle getOrCreateColumnStyle(int x)

获取或创建某一行的样式，返回样式后可以设置样式内容

参数:

x - X坐标，从0计数，既列号

返回:

CellStyle

从以下版本开始:

4.1.4

getRowCount

public int getRowCount()

获取总行数，计算方法为：

 最后一行序号 + 1
 

返回:

行数

从以下版本开始:

4.5.4

getPhysicalRowCount

public int getPhysicalRowCount()

获取有记录的行数，计算方法为：

 最后一行序号 - 第一行序号 + 1
 

返回:

行数

从以下版本开始:

4.5.4

getColumnCount

public int getColumnCount()

获取第一行总列数，计算方法为：

 最后一列序号 + 1
 

返回:

列数

getColumnCount

public int getColumnCount(int rowNum)

获取总列数，计算方法为：

 最后一列序号 + 1
 

参数:

rowNum - 行号

返回:

列数

close

public void close()

关闭工作簿
如果用户设定了目标文件，先写出目标文件后给关闭工作簿

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable