gu.sql2java.excel

类 SheetGenerator<B>

java.lang.Object

gu.sql2java.excel.BaseExcelWriter

gu.sql2java.excel.SheetGenerator<B>

类型参数:

B - 数据记录对象类型(Map,Java Bean)

直接已知子类:

BaseBeanExcelGenerator, JsonExcelGenerator, MapExcelGenerator

public class SheetGenerator<B>
extends BaseExcelWriter

基于apache POI实现数据记录导出为Excel的一页(工作薄)

从以下版本开始:

3.13.0

作者:

guyadong

构造器概要

构造器

限定符	构造器和说明
protected	SheetGenerator()
	SheetGenerator(java.lang.Class<B> beanClass, java.lang.Iterable<java.lang.String> includeColumns) 构造方法
protected	SheetGenerator(java.lang.Iterable<B> rows) 构造方法
	SheetGenerator(java.lang.Iterable<B> rows, java.lang.Class<B> beanClass, java.lang.Iterable<java.lang.String> includeColumns)
	SheetGenerator(java.lang.Iterable<B> rows, java.lang.Class<B> beanClass, java.lang.String... includeColumns)
protected	SheetGenerator(java.lang.Iterable<B> iterable, java.lang.Iterable<java.lang.String> includeColumns) 构造方法
protected	SheetGenerator(java.lang.Iterable<B> iterable, java.lang.String... includeColumns) 构造方法
	SheetGenerator(java.lang.Object rows, java.lang.Class<B> beanClass, java.lang.Iterable<java.lang.String> includeColumns)

方法概要

限定符和类型	方法和说明
SheetConfig	getSheetConfig() 返回Excel表输出配置(SheetConfig)实例,可以通过此实例修改输出配置
protected org.apache.poi.ss.usermodel.Workbook	getWorkbook() 返回当前的Workbook实例
SheetGenerator<B>	setRowLimitForAutoColumnSize(int rowLimitForAutoColumnSize)
SheetGenerator<B>	setSheetConfig(SheetConfig sheetConfig)
protected void	write() 将输入的数据记录生成输出到Excel的 Workbook
protected void	write(org.apache.commons.csv.CSVPrinter csvPrinter)
protected void	write(java.io.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

构造器详细资料

SheetGenerator

protected SheetGenerator(java.lang.Iterable<B> rows)

构造方法

参数:

rows - 数据记录对象列表

SheetGenerator

protected SheetGenerator()

SheetGenerator

public SheetGenerator(java.lang.Iterable<B> rows,
                      java.lang.Class<B> beanClass,
                      java.lang.Iterable<java.lang.String> includeColumns)

参数:

rows - 数据记录对象列表

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

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

SheetGenerator

public SheetGenerator(java.lang.Iterable<B> rows,
                      java.lang.Class<B> beanClass,
                      java.lang.String... includeColumns)

参数:

rows - 数据记录对象列表

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

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

SheetGenerator

public SheetGenerator(java.lang.Class<B> beanClass,
                      java.lang.Iterable<java.lang.String> includeColumns)

构造方法

参数:

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

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

SheetGenerator

public SheetGenerator(java.lang.Object rows,
                      java.lang.Class<B> beanClass,
                      java.lang.Iterable<java.lang.String> includeColumns)

参数:

rows - 数据记录对象列表

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

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

SheetGenerator

protected SheetGenerator(java.lang.Iterable<B> iterable,
                         java.lang.Iterable<java.lang.String> includeColumns)

构造方法

参数:

iterable - 数据记录对象列表

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

SheetGenerator

protected SheetGenerator(java.lang.Iterable<B> iterable,
                         java.lang.String... includeColumns)

构造方法

另请参阅:

SheetGenerator(Iterable, Iterable)

方法详细资料

getSheetConfig

public SheetConfig getSheetConfig()

返回Excel表输出配置(SheetConfig)实例,可以通过此实例修改输出配置

setSheetConfig

public SheetGenerator<B> setSheetConfig(SheetConfig sheetConfig)

setRowLimitForAutoColumnSize

public SheetGenerator<B> setRowLimitForAutoColumnSize(int rowLimitForAutoColumnSize)

write

protected void write()
              throws java.io.IOException

从类复制的说明: BaseExcelWriter

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

指定者:

write 在类中 BaseExcelWriter

抛出:

java.io.IOException

write

protected void write(org.apache.commons.csv.CSVPrinter csvPrinter)
              throws java.io.IOException

抛出:

java.io.IOException

write

protected void write(java.io.OutputStream outputStream)
              throws java.io.IOException

从类复制的说明: BaseExcelWriter

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

指定者:

write 在类中 BaseExcelWriter

抛出:

java.io.IOException

getWorkbook

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

从类复制的说明: BaseExcelWriter

返回当前的Workbook实例

指定者:

getWorkbook 在类中 BaseExcelWriter