cn.bestwu.simpleframework.support.excel

Class ExcelExport

java.lang.Object

cn.bestwu.simpleframework.support.excel.AbstractExcelUtil

cn.bestwu.simpleframework.support.excel.ExcelExport

public class ExcelExport
extends AbstractExcelUtil

导出Excel文件（导出“XLSX”格式，支持大数据量导出 ）

See Also:

SpreadsheetVersion

Constructor Summary

Constructors

Constructor and Description
ExcelExport(java.lang.Class<?> cls) 构造函数
ExcelExport(int rowAccessWindowSize, java.lang.Class<?> cls) 构造函数
ExcelExport(int rowAccessWindowSize, java.lang.String sheetname, java.lang.Class<?> cls, int... groups) 构造函数
ExcelExport(java.lang.String sheetname, java.lang.Class<?> cls, int... groups) 构造函数
ExcelExport(org.apache.poi.ss.usermodel.Workbook workbook, java.lang.Integer sheetIndex, java.lang.Class<?> cls, int... groups)

Method Summary

Modifier and Type	Method and Description
org.apache.poi.ss.usermodel.Cell	addCell() 添加一个单元格
org.apache.poi.ss.usermodel.Cell	addCell(org.apache.poi.ss.usermodel.CellStyle cellStyle) 添加一个单元格
org.apache.poi.ss.usermodel.Cell	addCell(int column) 添加一个单元格
org.apache.poi.ss.usermodel.Cell	addCell(int column, org.apache.poi.ss.usermodel.CellStyle cellStyle) 添加一个单元格
void	addMergedRegion(int firstCol, int lastCol)
void	addMergedRegion(int firstRow, int lastRow, int firstCol, int lastCol)
org.apache.poi.ss.usermodel.Row	addRow() 添加一行
void	addValidationData(int firstRow, int lastRow, int firstCol, int lastCol, java.lang.String[] explicitListValues) 添加数据有效性检查.
void	addValidationData(int firstCol, int lastCol, java.lang.String[] explicitListValues) 添加数据有效性检查.
void	createTitle(java.lang.String title)
void	createTitle(java.lang.String title, org.apache.poi.ss.usermodel.CellStyle titleStyle)
ExcelExport	dispose() 清理临时文件
void	excludeComment()
org.apache.poi.ss.usermodel.CellStyle	getCellStyle(CellStyleType styleType)
org.apache.poi.ss.usermodel.CellStyle	getCellStyle(CellStyleType styleType, org.apache.poi.ss.usermodel.HorizontalAlignment alignment)
org.apache.poi.ss.usermodel.CellStyle	getCellStyle(CellStyleType styleType, org.apache.poi.ss.usermodel.HorizontalAlignment alignment, boolean border)
java.lang.String	getExtension()
short	getFormat(java.lang.String cellFormatString)
org.apache.poi.ss.usermodel.Sheet	getSheet()
org.apache.poi.ss.usermodel.Workbook	getWorkbook()
void	includeComment()
ExcelExport	initialize(java.lang.Class<?> cls, int... groups)
<E> ExcelExport	setDataList(int startColunm, java.util.List<E> list) 添加数据（通过annotation.ExportField添加数据）
<E> ExcelExport	setDataList(java.util.List<E> list) 添加数据（通过annotation.ExportField添加数据）
void	setDefaultCellStyle(org.apache.poi.ss.usermodel.CellStyle defaultCellStyle)
ExcelExport	wrapText(boolean wrapText)
ExcelExport	write(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String fileName) 输出到客户端
ExcelExport	write(java.io.OutputStream os) 输出数据流
ExcelExport	writeFile(java.lang.String fileName) 输出到文件

Methods inherited from class cn.bestwu.simpleframework.support.excel.AbstractExcelUtil

getCellValueConverter, getExcelFieldDescriptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelExport

public ExcelExport(java.lang.Class<?> cls)

构造函数

Parameters:

cls - 实体对象，通过annotation.ExportField获取标题

ExcelExport

public ExcelExport(int rowAccessWindowSize,
                   java.lang.Class<?> cls)

构造函数

Parameters:

rowAccessWindowSize - 行访问窗口大小

cls - 实体对象，通过annotation.ExportField获取标题

ExcelExport

public ExcelExport(java.lang.String sheetname,
                   java.lang.Class<?> cls,
                   int... groups)

构造函数

Parameters:

sheetname - sheetname

cls - 实体对象，通过annotation.ExportField获取标题

groups - 导入分组

ExcelExport

public ExcelExport(org.apache.poi.ss.usermodel.Workbook workbook,
                   java.lang.Integer sheetIndex,
                   java.lang.Class<?> cls,
                   int... groups)

Parameters:

workbook - 工作表

sheetIndex - of the sheet number (0-based physical and logical)

cls - 实体对象，通过annotation.ExportField获取标题

groups - 导入分组

ExcelExport

public ExcelExport(int rowAccessWindowSize,
                   java.lang.String sheetname,
                   java.lang.Class<?> cls,
                   int... groups)

构造函数

Parameters:

rowAccessWindowSize - 行访问窗口大小

sheetname - sheetname

cls - 实体对象，通过annotation.ExportField获取标题

groups - 导入分组

Method Detail

includeComment

public void includeComment()

excludeComment

public void excludeComment()

getWorkbook

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

getSheet

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

wrapText

public ExcelExport wrapText(boolean wrapText)

setDefaultCellStyle

public void setDefaultCellStyle(org.apache.poi.ss.usermodel.CellStyle defaultCellStyle)

initialize

public ExcelExport initialize(java.lang.Class<?> cls,
                              int... groups)

Parameters:

cls - 实体对象，通过annotation.ExportField获取标题

groups - 导入分组

Returns:

this

createTitle

public void createTitle(java.lang.String title)

Parameters:

title - 标题

createTitle

public void createTitle(java.lang.String title,
                        org.apache.poi.ss.usermodel.CellStyle titleStyle)

Parameters:

title - 标题

titleStyle - 标题样式

getCellStyle

public org.apache.poi.ss.usermodel.CellStyle getCellStyle(CellStyleType styleType)

Parameters:

styleType - 样式类型

Returns:

单元格样式

getCellStyle

public org.apache.poi.ss.usermodel.CellStyle getCellStyle(CellStyleType styleType,
                                                          org.apache.poi.ss.usermodel.HorizontalAlignment alignment)

Parameters:

styleType - 样式类型

alignment - 对齐方式

Returns:

单元格样式

getCellStyle

public org.apache.poi.ss.usermodel.CellStyle getCellStyle(CellStyleType styleType,
                                                          org.apache.poi.ss.usermodel.HorizontalAlignment alignment,
                                                          boolean border)

Parameters:

styleType - 样式类型

alignment - 对齐方式

border - 是否有边框

Returns:

单元格样式

addMergedRegion

public void addMergedRegion(int firstCol,
                            int lastCol)

Parameters:

firstCol - 开始列

lastCol - 结束列

addMergedRegion

public void addMergedRegion(int firstRow,
                            int lastRow,
                            int firstCol,
                            int lastCol)

Parameters:

firstRow - 开始行

lastRow - 结束行

firstCol - 开始列

lastCol - 结束列

addValidationData

public void addValidationData(int firstCol,
                              int lastCol,
                              java.lang.String[] explicitListValues)

添加数据有效性检查.

Parameters:

firstCol - 开始列

lastCol - 结束列

explicitListValues - 有效性检查的下拉列表

addValidationData

public void addValidationData(int firstRow,
                              int lastRow,
                              int firstCol,
                              int lastCol,
                              java.lang.String[] explicitListValues)

添加数据有效性检查.

Parameters:

firstRow - 开始行

lastRow - 结束行

firstCol - 开始列

lastCol - 结束列

explicitListValues - 有效性检查的下拉列表

addCell

public org.apache.poi.ss.usermodel.Cell addCell()

添加一个单元格

Returns:

单元格对象

addCell

public org.apache.poi.ss.usermodel.Cell addCell(org.apache.poi.ss.usermodel.CellStyle cellStyle)

添加一个单元格

Parameters:

cellStyle - 样式

Returns:

单元格对象

addCell

public org.apache.poi.ss.usermodel.Cell addCell(int column)

添加一个单元格

Parameters:

column - 列号

Returns:

单元格对象

addCell

public org.apache.poi.ss.usermodel.Cell addCell(int column,
                                                org.apache.poi.ss.usermodel.CellStyle cellStyle)

添加一个单元格

Parameters:

column - 列号

cellStyle - 样式

Returns:

单元格对象

addRow

public org.apache.poi.ss.usermodel.Row addRow()

添加一行

Returns:

行对象

getFormat

public short getFormat(java.lang.String cellFormatString)

setDataList

public <E> ExcelExport setDataList(java.util.List<E> list)

添加数据（通过annotation.ExportField添加数据）

Type Parameters:

E - E

Parameters:

list - list

Returns:

list 数据列表

setDataList

public <E> ExcelExport setDataList(int startColunm,
                                   java.util.List<E> list)

添加数据（通过annotation.ExportField添加数据）

Type Parameters:

E - E

Parameters:

list - list

startColunm - 起始列

Returns:

list 数据列表

write

public ExcelExport write(java.io.OutputStream os)
                  throws java.io.IOException

输出数据流

Parameters:

os - 输出数据流

Returns:

this

Throws:

java.io.IOException - IOException

write

public ExcelExport write(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         java.lang.String fileName)
                  throws java.io.IOException

输出到客户端

Parameters:

request - request

response - response

fileName - 输出文件名

Returns:

this

Throws:

java.io.IOException - IOException

getExtension

@NotNull
public java.lang.String getExtension()

writeFile

public ExcelExport writeFile(java.lang.String fileName)
                      throws java.io.IOException

输出到文件

Parameters:

fileName - 输出文件名

Returns:

this

Throws:

java.io.IOException - IOException

dispose

public ExcelExport dispose()
                    throws java.io.IOException

清理临时文件

Returns:

this

Throws:

java.io.IOException - IOException