程序包 gu.sql2java.excel

类 ExcelGenerator

java.lang.Object

gu.sql2java.excel.BaseExcelWriter

gu.sql2java.excel.ExcelGenerator

public class ExcelGenerator
extends BaseExcelWriter

基于apache POI实现数据记录导出为Excel,支持多Sheet导出

作者:

guyadong

构造器概要

构造器

构造器	说明
ExcelGenerator()	默认构造方法
ExcelGenerator(Class<B> beanClass, Iterable<String> includeColumns)	构造方法
ExcelGenerator(Iterable<B> rows, Class<B> beanClass)	构造方法
ExcelGenerator(Iterable<B> rows, Class<B> beanClass, Iterable<String> includeColumns)
ExcelGenerator(Iterable<B> iterable, Class<B> beanClass, String... includeCoumns)	构造方法
ExcelGenerator(Object rows, Class<B> beanClass, Iterable<String> includeColumns)

方法概要

修饰符和类型	方法	说明
ExcelGenerator	addSheetGenerator(SheetGenerator<?> sheetGenerator)	在尾部增加一个工作薄生成器
ExcelGenerator	addSheetGenerator(Integer index, SheetGenerator<?> sheetGenerator)	在指定索引位置增加一个工作薄生成器
SheetConfig	getSheetConfig()	返回第一个SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 实例不存在则返回null
SheetConfig	getSheetConfig(int index)	返回索引指定SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 索引越界则返回null
List<SheetGenerator<?>>	getSheetGenerators()	返回当前所有的SheetGenerator实例列表
org.apache.poi.ss.usermodel.Workbook	getWorkbook()	返回当前的Workbook实例
ExcelGenerator	setRowLimitForAutoColumnSize(int rowLimitForAutoColumnSize)
ExcelGenerator	setSheetConfig(int index, SheetConfig sheetConfig)	设置索引指定SheetGenerator 的输出配置(SheetConfig)实例,索引越界则忽略
ExcelGenerator	setSheetConfig(SheetConfig sheetConfig)	设置第一个SheetGenerator 的输出配置(SheetConfig)实例, 实例不存在则忽略
protected void	write()	将输入的数据记录生成输出到Excel的 Workbook
protected void	write(OutputStream outputStream)	将输入的数据记录生成输出到OutputStream

从类继承的方法 gu.sql2java.excel.BaseExcelWriter

generate, generate, generate, generate, generate, generate

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

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

构造器详细资料

ExcelGenerator

public ExcelGenerator()

默认构造方法

ExcelGenerator

public ExcelGenerator(Iterable<B> rows,
 Class<B> beanClass)

构造方法

参数:

rows - 数据记录对象列表

beanClass - 数据记录对象的类型

ExcelGenerator

public ExcelGenerator(Iterable<B> rows,
 Class<B> beanClass,
 Iterable<String> includeColumns)

参数:

rows - 数据记录对象列表

beanClass - 数据记录类型(Map,Java Bean)

includeColumns - 输出字段白名单,只输出在名单内的字段，为null或空输出所有字段, Map类型记录无法预知类型的字段完整信息,所以对于Map类型的记录,如果不指定此字段， 则要对Iterable中所有的Map记录遍历，才能获取完整的字段信息，效率较低 所以建议对于Map类型记录要定义此参数

ExcelGenerator

public ExcelGenerator(Iterable<B> iterable,
 Class<B> beanClass,
 String... includeCoumns)

构造方法

另请参阅:

• ExcelGenerator(Iterable, Class,Iterable)

ExcelGenerator

public ExcelGenerator(Class<B> beanClass,
 Iterable<String> includeColumns)

构造方法

参数:

beanClass - 数据记录类型(Map,Java Bean)

includeColumns - 输出字段白名单,只输出在名单内的字段，为null或空输出所有字段, Map类型记录无法预知类型的字段完整信息,所以对于Map类型的记录,如果不指定此字段， 则要对Iterable中所有的Map记录遍历，才能获取完整的字段信息，效率较低 所以建议对于Map类型记录要定义此参数

ExcelGenerator

public ExcelGenerator(Object rows,
 Class<B> beanClass,
 Iterable<String> includeColumns)

参数:

rows - 数据记录对象列表

beanClass - 数据记录类型(Map,Java Bean)

includeColumns - 输出字段白名单,只输出在名单内的字段，为null或空输出所有字段, Map类型记录无法预知类型的字段完整信息,所以对于Map类型的记录,如果不指定此字段， 则要对Iterable中所有的Map记录遍历，才能获取完整的字段信息，效率较低 所以建议对于Map类型记录要定义此参数

方法详细资料

addSheetGenerator

public ExcelGenerator addSheetGenerator(Integer index,
 SheetGenerator<?> sheetGenerator)

在指定索引位置增加一个工作薄生成器

参数:

index - 为null则在尾部增加

sheetGenerator - 为null忽略

返回:

当前对象

从以下版本开始:

3.13.0

addSheetGenerator

public ExcelGenerator addSheetGenerator(SheetGenerator<?> sheetGenerator)

在尾部增加一个工作薄生成器

参数:

sheetGenerator -

返回:

当前对象

从以下版本开始:

3.13.0

getSheetConfig

public SheetConfig getSheetConfig(int index)

返回索引指定SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 索引越界则返回null

从以下版本开始:

3.13.0

setSheetConfig

public ExcelGenerator setSheetConfig(int index,
 SheetConfig sheetConfig)

设置索引指定SheetGenerator 的输出配置(SheetConfig)实例,索引越界则忽略

参数:

index -

sheetConfig -

返回:

当前对象

从以下版本开始:

3.13.0

setRowLimitForAutoColumnSize

public ExcelGenerator setRowLimitForAutoColumnSize(int rowLimitForAutoColumnSize)

getSheetConfig

public SheetConfig getSheetConfig()

返回第一个SheetGenerator 的输出配置(SheetConfig)实例,可以通过此实例修改输出配置, 实例不存在则返回null

另请参阅:

• getSheetConfig(int)

setSheetConfig

public ExcelGenerator setSheetConfig(SheetConfig sheetConfig)

设置第一个SheetGenerator 的输出配置(SheetConfig)实例, 实例不存在则忽略

参数:

sheetConfig -

返回:

当前对象

另请参阅:

• setSheetConfig(int, SheetConfig)

write

protected void write()
              throws IOException

从类复制的说明: BaseExcelWriter

将输入的数据记录生成输出到Excel的 Workbook

指定者:

write 在类中 BaseExcelWriter

抛出:

IOException

write

protected void write(OutputStream outputStream)
              throws IOException

从类复制的说明: BaseExcelWriter

将输入的数据记录生成输出到OutputStream

指定者:

write 在类中 BaseExcelWriter

抛出:

IOException

getWorkbook

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

从类复制的说明: BaseExcelWriter

返回当前的Workbook实例

指定者:

getWorkbook 在类中 BaseExcelWriter

getSheetGenerators

public List<SheetGenerator<?>> getSheetGenerators()

返回当前所有的SheetGenerator实例列表