cn.hutool.poi.excel

Class ExcelBase<T extends ExcelBase<T>>

java.lang.Object

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

Type Parameters:

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

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

ExcelReader, ExcelWriter

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

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

Since:

4.1.4

Author:

looly

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isClosed 是否被关闭
protected org.apache.poi.ss.usermodel.Sheet	sheet Excel中对应的Sheet
protected org.apache.poi.ss.usermodel.Workbook	workbook 工作簿

Constructor Summary

Constructors

Constructor and Description
ExcelBase(org.apache.poi.ss.usermodel.Sheet sheet) 构造

Method Summary

Modifier and Type	Method and Description
void	close() 关闭工作簿 如果用户设定了目标文件，先写出目标文件后给关闭工作簿
org.apache.poi.ss.usermodel.CellStyle	createCellStyle() 创建单元格样式
org.apache.poi.ss.usermodel.CellStyle	createCellStyle(int x, int y) 为指定单元格创建样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.CellStyle	createCellStyle(String locationRef) 为指定单元格创建样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.CellStyle	createColumnStyle(int x) 创建某一列的样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.CellStyle	createRowStyle(int y) 创建某一行的样式，返回样式后可以设置样式内容
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
org.apache.poi.ss.usermodel.Cell	getCell(String locationRef) 获取指定坐标单元格，单元格不存在时返回null
org.apache.poi.ss.usermodel.Cell	getCell(String locationRef, boolean isCreateIfNotExist) 获取指定坐标单元格，如果isCreateIfNotExist为false，则在单元格不存在时返回null
int	getColumnCount() 获取第一行总列数，计算方法为：
int	getColumnCount(int rowNum) 获取总列数，计算方法为：
org.apache.poi.ss.usermodel.Cell	getOrCreateCell(int x, int y) 获取或创建指定坐标单元格
org.apache.poi.ss.usermodel.Cell	getOrCreateCell(String locationRef) 获取或创建指定坐标单元格
org.apache.poi.ss.usermodel.CellStyle	getOrCreateCellStyle(int x, int y) 为指定单元格获取或者创建样式，返回样式后可以设置样式内容
org.apache.poi.ss.usermodel.CellStyle	getOrCreateCellStyle(String locationRef) 为指定单元格获取或者创建样式，返回样式后可以设置样式内容
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() 获取有记录的行数，计算方法为：
int	getRowCount() 获取总行数，计算方法为：
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
boolean	isXlsx() 判断是否为xlsx格式的Excel表（Excel07格式）
T	setSheet(int sheetIndex) 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之（命名为默认） 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet
T	setSheet(org.apache.poi.ss.usermodel.Sheet sheet) 设置自定义Sheet
T	setSheet(String sheetName) 自定义需要读取或写出的Sheet，如果给定的sheet不存在，创建之。 在读取中，此方法用于切换读取的sheet，在写出时，此方法用于新建或者切换sheet。

Methods inherited from class java.lang.Object

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

Field Detail

isClosed

protected boolean isClosed

是否被关闭

workbook

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

工作簿

sheet

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

Excel中对应的Sheet

Constructor Detail

ExcelBase

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

构造

Parameters:

sheet - Excel中的sheet

Method Detail

getWorkbook

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

获取Workbook

Returns:

Workbook

getSheetCount

public int getSheetCount()

返回工作簿表格数

Returns:

工作簿表格数

Since:

4.0.10

getSheets

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

获取此工作簿所有Sheet表

Returns:

sheet表列表

Since:

4.0.3

getSheetNames

public List<String> getSheetNames()

获取表名列表

Returns:

表名列表

Since:

4.0.3

getSheet

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

获取当前Sheet

Returns:

Sheet

setSheet

public T setSheet(String sheetName)

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

Parameters:

sheetName - sheet名

Returns:

this

Since:

4.0.10

setSheet

public T setSheet(int sheetIndex)

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

Parameters:

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

Returns:

this

Since:

4.0.10

setSheet

public T setSheet(org.apache.poi.ss.usermodel.Sheet sheet)

设置自定义Sheet

Parameters:

sheet - 自定义sheet，可以通过WorkbookUtil.getOrCreateSheet(Workbook, String) 创建

Returns:

this

Since:

5.2.1

getCell

public org.apache.poi.ss.usermodel.Cell getCell(String locationRef)

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

Parameters:

locationRef - 单元格地址标识符，例如A11，B5

Returns:

Cell

Since:

5.1.4

getCell

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

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

Parameters:

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

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

Returns:

Cell

Since:

4.0.5

getOrCreateCell

public org.apache.poi.ss.usermodel.Cell getOrCreateCell(String locationRef)

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

Parameters:

locationRef - 单元格地址标识符，例如A11，B5

Returns:

Cell

Since:

5.1.4

getOrCreateCell

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

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

Parameters:

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

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

Returns:

Cell

Since:

4.0.6

getCell

public org.apache.poi.ss.usermodel.Cell getCell(String locationRef,
                                                boolean isCreateIfNotExist)

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

Parameters:

locationRef - 单元格地址标识符，例如A11，B5

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

Returns:

Cell

Since:

5.1.4

getCell

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

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

Parameters:

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

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

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

Returns:

Cell

Since:

4.0.6

getOrCreateRow

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

获取或者创建行

Parameters:

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

Returns:

Row

Since:

4.1.4

getOrCreateCellStyle

public org.apache.poi.ss.usermodel.CellStyle getOrCreateCellStyle(String locationRef)

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

Parameters:

locationRef - 单元格地址标识符，例如A11，B5

Returns:

CellStyle

Since:

5.1.4

getOrCreateCellStyle

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

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

Parameters:

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

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

Returns:

CellStyle

Since:

4.1.4

createCellStyle

public org.apache.poi.ss.usermodel.CellStyle createCellStyle(String locationRef)

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

Parameters:

locationRef - 单元格地址标识符，例如A11，B5

Returns:

CellStyle

Since:

5.1.4

createCellStyle

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

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

Parameters:

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

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

Returns:

CellStyle

Since:

4.6.3

createCellStyle

public org.apache.poi.ss.usermodel.CellStyle createCellStyle()

创建单元格样式

Returns:

CellStyle

Since:

5.4.0

See Also:

Workbook.createCellStyle()

getOrCreateRowStyle

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

获取或创建某一行的样式，返回样式后可以设置样式内容
需要注意，此方法返回行样式，设置背景色在单元格设置值后会被覆盖，需要单独设置其单元格的样式。

Parameters:

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

Returns:

CellStyle

Since:

4.1.4

createRowStyle

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

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

Parameters:

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

Returns:

CellStyle

Since:

4.6.3

getOrCreateColumnStyle

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

获取或创建某一列的样式，返回样式后可以设置样式内容
需要注意，此方法返回行样式，设置背景色在单元格设置值后会被覆盖，需要单独设置其单元格的样式。

Parameters:

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

Returns:

CellStyle

Since:

4.1.4

createColumnStyle

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

创建某一列的样式，返回样式后可以设置样式内容

Parameters:

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

Returns:

CellStyle

Since:

4.6.3

getRowCount

public int getRowCount()

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

 最后一行序号 + 1
 

Returns:

行数

Since:

4.5.4

getPhysicalRowCount

public int getPhysicalRowCount()

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

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

Returns:

行数

Since:

4.5.4

getColumnCount

public int getColumnCount()

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

 最后一列序号 + 1
 

Returns:

列数

getColumnCount

public int getColumnCount(int rowNum)

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

 最后一列序号 + 1
 

Parameters:

rowNum - 行号

Returns:

列数，-1表示获取失败

isXlsx

public boolean isXlsx()

判断是否为xlsx格式的Excel表（Excel07格式）

Returns:

是否为xlsx格式的Excel表（Excel07格式）

Since:

4.6.2

close

public void close()

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable