ResultSetSheet (Excel Write/Read Framework 0.5.21 API)

java.lang.Object
- org.ttzero.excel.entity.Sheet
- - org.ttzero.excel.entity.ResultSetSheet

所有已实现的接口:

Cloneable, Storable

直接已知子类:

StatementSheet
```
public class ResultSetSheet
extends Sheet
```
ResultSetSheet的数据源为ResultSet一般情况下它用于存储过程， ResultSetSheet可以将存储过程的查询结果直接转为工作表的数据，省掉将查结果转为 Java对象再转为工作表输出协议的数据结构。
如果未指定Columns表头时将从ResultSetMetaData源数据中获取，优先使用别名做为表头，列顺序与query字段一致

这是一个比较小众的工作表，最好只在比较简单的场景下使用，比如一次性导出的场景。因为StatementSheet并不支持数据切片，所以当查询结果较大时可能出现OOM。如果不确认数据量时最好使用ListSheet分片获取数据

作者:

guanquan.wang on 2017/9/27.

另请参阅:

StatementSheet

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`ResultSetSheet.SQLColumn` `ResultSetSheet`独有的列对象，除了`Column`包含的信息外，它还保存当列对应的SQL类型和 `ResultSet`下标，有了下标后续列取值可直接根据`ri`直接取值

字段概要

字段
限定符和类型字段和说明

protected ResultSet rs
数据源ResultSet
- 从类继承的字段 org.ttzero.excel.entity.Sheet
  autoSize, cellValueAndStyle, columns, comments, copyCount, copySheet, extProp, extPropMark, headerReady, headerRowHeight, headStyle, headStyleIndex, hidden, id, LOGGER, name, nonHeader, progressConsumer, relManager, rowBlock, rowHeight, rows, sheetWriter, shouldClose, showGridLines, startRowIndex, waterMark, width, workbook, zebraFill, zebraFillStyle

字段
限定符和类型	字段和说明
`protected ResultSet`	`rs` 数据源ResultSet

构造器概要

构造器
构造器和说明
`ResultSetSheet()` 实例化工作表，未指定工作表名称时默认以`'Sheet'+id`命名
`ResultSetSheet(Column... columns)` 实例化工作表并指定表头信息
`ResultSetSheet(ResultSet rs)` 实例化工作表并指定数据源`ResultSet`
`ResultSetSheet(ResultSet rs, Column... columns)` 实例化工作表并指定数据源`ResultSet`和表头信息
`ResultSetSheet(ResultSet rs, WaterMark waterMark, Column... columns)` 实例化工作表并指定数据源`ResultSet`、水印和表头信息
`ResultSetSheet(String name)` 实例化工作表并指定工作表名称
`ResultSetSheet(String name, Column... columns)` 实例化工作表并指定工作表名称和表头信息
`ResultSetSheet(String name, ResultSet rs)` 实例化工作表并指定工作表名和数据源`ResultSet`
`ResultSetSheet(String name, ResultSet rs, Column... columns)` 实例化工作表并指定工作表名、数据源`ResultSet`和表头信息
`ResultSetSheet(String name, ResultSet rs, WaterMark waterMark, Column... columns)` 实例化工作表并指定工作表名、数据源`ResultSet`、水印和表头信息
`ResultSetSheet(String name, WaterMark waterMark, Column... columns)` 实例化工作表并指定工作表名称，水印和表头信息

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` 关闭数据源并关闭`ResultSet`
`protected Class<?>`	`columnTypeToClass(int type)` 将SQL类型`Types`转换为Java类型
`protected int`	`findByKey(ResultSetMetaData metaData, String key)`
`protected Column[]`	`getHeaderColumns()` 获取表头，未指定表头时从`ResultSetMetaData`源数据中获取，优先使用别名做为表头，列顺序与query字段一致
`StyleProcessor<ResultSet>`	`getStyleProcessor()` 获取当前工作表的行级动态样式处理器，如果未设置则从扩展参数中查找
`protected void`	`resetBlockData()` 重置`RowBlock`行块数据
`ResultSetSheet`	`setResultSet(ResultSet resultSet)` 设置数据源`ResultSet`
`Sheet`	`setStyleProcessor(StyleProcessor<ResultSet> styleProcessor)` 设置行级动态样式处理器，作用于整行优先级高于单元格动态样式处理器

从类继承的方法 org.ttzero.excel.entity.Sheet
addRel, afterSheetAccess, afterSheetDataWriter, autoSize, buildHeadStyle, calculateRealColIndex, cancelZebraLine, checkColumnLimit, clone, createComments, defaultHeadStyle, defaultHeadStyleIndex, defaultZebraLine, findRel, fixedSize, fixedSize, getAndSortHeaderColumns, getAutoSize, getCellValueAndStyle, getColumns, getComments, getCopySheetName, getDefaultWidth, getExtPropAsMap, getExtPropValue, getFileName, getForceExport, getHeaderRowHeight, getHeadStyle, getHeadStyleIndex, getId, getName, getNonHeader, getProgressConsumer, getRelManager, getRowBlockSize, getRowHeight, getRowLimit, getSheetWriter, getStartRowIndex, getWaterMark, getWorkbook, getZebraFill, getZebraFillStyle, hasHeaderColumns, hidden, hideGridLines, ignoreHeader, insert, int2Col, isAutoSize, isHidden, isScrollToVisibleArea, isShowGridLines, markExtProp, mergeHeaderCellsIfEquals, nextBlock, onProgress, paging, putAllExtProp, putExtProp, putExtPropIfAbsent, resetCommonProperties, reverseHeadColumn, search, setCellValueAndStyle, setColumns, setColumns, setHeaderRowHeight, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyle, setHeadStyleIndex, setId, setName, setRowHeight, setSheetWriter, setStartRowIndex, setStartRowIndex, setWaterMark, setWorkbook, setZebraLine, showGridLines, size, sortColumns, toCoordinate, writeTo

从类继承的方法 java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - rs
```
protected ResultSet rs
```
    数据源ResultSet
- 构造器详细资料
  - ResultSetSheet
```
public ResultSetSheet()
```
    实例化工作表，未指定工作表名称时默认以'Sheet'+id命名
  - ResultSetSheet
```
public ResultSetSheet(String name)
```
    实例化工作表并指定工作表名称
    
    参数:
    
    name - 工作表名称
  - ResultSetSheet
```
public ResultSetSheet(Column... columns)
```
    实例化工作表并指定表头信息
    
    参数:
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(String name,
                      Column... columns)
```
    实例化工作表并指定工作表名称和表头信息
    
    参数:
    
    name - 工作表名称
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(String name,
                      WaterMark waterMark,
                      Column... columns)
```
    实例化工作表并指定工作表名称，水印和表头信息
    
    参数:
    
    name - 工作表名称
    
    waterMark - 水印
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(ResultSet rs)
```
    实例化工作表并指定数据源ResultSet
    
    参数:
    
    rs - 数据源ResultSet
  - ResultSetSheet
```
public ResultSetSheet(String name,
                      ResultSet rs)
```
    实例化工作表并指定工作表名和数据源ResultSet
    
    参数:
    
    name - 工作表名
    
    rs - 数据源ResultSet
  - ResultSetSheet
```
public ResultSetSheet(ResultSet rs,
                      Column... columns)
```
    实例化工作表并指定数据源ResultSet和表头信息
    
    参数:
    
    rs - 数据源ResultSet
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(String name,
                      ResultSet rs,
                      Column... columns)
```
    实例化工作表并指定工作表名、数据源ResultSet和表头信息
    
    参数:
    
    name - 工作表名
    
    rs - 数据源ResultSet
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(ResultSet rs,
                      WaterMark waterMark,
                      Column... columns)
```
    实例化工作表并指定数据源ResultSet、水印和表头信息
    
    参数:
    
    rs - 数据源ResultSet
    
    waterMark - 水印
    
    columns - 表头信息
  - ResultSetSheet
```
public ResultSetSheet(String name,
                      ResultSet rs,
                      WaterMark waterMark,
                      Column... columns)
```
    实例化工作表并指定工作表名、数据源ResultSet、水印和表头信息
    
    参数:
    
    name - 工作表名
    
    rs - 数据源ResultSet
    
    waterMark - 水印
    
    columns - 表头信息
- 方法详细资料
  - setResultSet
```
public ResultSetSheet setResultSet(ResultSet resultSet)
```
    设置数据源ResultSet
    
    参数:
    
    resultSet - 数据源ResultSet
    
    返回:
    
    当前工作表
  - setStyleProcessor
```
public Sheet setStyleProcessor(StyleProcessor<ResultSet> styleProcessor)
```
    设置行级动态样式处理器，作用于整行优先级高于单元格动态样式处理器
    
    参数:
    
    styleProcessor - 行级动态样式处理器
    
    返回:
    
    当前工作表
  - getStyleProcessor
```
public StyleProcessor<ResultSet> getStyleProcessor()
```
    获取当前工作表的行级动态样式处理器，如果未设置则从扩展参数中查找
    
    返回:
    
    行级动态样式处理器
  - close
```
public void close()
           throws IOException
```
    关闭数据源并关闭ResultSet
    
    覆盖:
    
    close 在类中 Sheet
    
    抛出:
    
    IOException - if I/O error occur
  - resetBlockData
```
protected void resetBlockData()
```
    重置RowBlock行块数据
    
    指定者:
    
    resetBlockData 在类中 Sheet
  - getHeaderColumns
```
protected Column[] getHeaderColumns()
```
    获取表头，未指定表头时从ResultSetMetaData源数据中获取，优先使用别名做为表头，列顺序与query字段一致
    
    覆盖:
    
    getHeaderColumns 在类中 Sheet
    
    返回:
    
    表头信息
  - findByKey
```
protected int findByKey(ResultSetMetaData metaData,
                        String key)
                 throws SQLException
```
    抛出:
    
    SQLException
  - columnTypeToClass
```
protected Class<?> columnTypeToClass(int type)
```
    将SQL类型Types转换为Java类型
    
    参数:
    
    type - SQL类型java.sql.Types
    
    返回:
    
    Java类型

类 ResultSetSheet

嵌套类概要

字段概要

从类继承的字段 org.ttzero.excel.entity.Sheet

构造器概要

方法概要

从类继承的方法 org.ttzero.excel.entity.Sheet

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

字段详细资料

rs

构造器详细资料

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

ResultSetSheet

方法详细资料

setResultSet

setStyleProcessor

getStyleProcessor

close

resetBlockData

getHeaderColumns

findByKey

columnTypeToClass