BaseExcelReader (sql2java excel helper 5.5.0-patch2 API)

java.lang.Object
- gu.sql2java.excel.BaseExcelReader<R>

类型参数:

R - 输入数据的行数据类型

所有已实现的接口:

IExcelReader

直接已知子类:

CSVReader, SheetReader
```
public class BaseExcelReader<R>
extends java.lang.Object
implements IExcelReader
```
EXCEL(.xls,.xlsx,.csv)读取实现基类

从以下版本开始:

3.29.0

作者:

guyadong

字段概要

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

protected boolean debugOutput

protected java.util.Map<java.lang.Integer,PropertyConfig> fetchColumns

protected SheetConfig sheetConfig

字段
限定符和类型	字段和说明
`protected boolean`	`debugOutput`
`protected java.util.Map<java.lang.Integer,PropertyConfig>`	`fetchColumns`
`protected SheetConfig`	`sheetConfig`

构造器概要

构造器
构造器和说明
`BaseExcelReader()`
`BaseExcelReader(BaseExcelReader builder)`
`BaseExcelReader(java.util.function.Consumer<?> beanConsumer)`
`BaseExcelReader(SheetConfig sheetConfig)`
`BaseExcelReader(SheetConfig sheetConfig, java.util.function.Consumer<?> beanConsumer)`
`BaseExcelReader(SheetConfig sheetConfig, java.util.List<?> rows, java.util.function.Consumer<?> beanConsumer)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`consumeRows()`
`protected java.lang.Object`	`converExp(java.lang.Object s, PropertyConfig p)`
`BaseExcelReader<R>`	`debugOutput(java.lang.Boolean debugOutput)` 设置调试输出标志
`protected java.lang.String`	`getCellAsString(R row, int idx)` 从单元格读取数据转为String，子类必须重写此方法
`<T> java.util.List<T>`	`getRows()` 返回解析的记录列表
`SheetConfig`	`getSheetConfig()`
`protected java.util.List<java.lang.Integer>`	`indexsOfRow(R row)` 返回列的索引范围列表，子类必须重写此方法
`protected boolean`	`isEmptyCell(R row, int idx)` 行由idx指定单元为空返回`true`，否则返回`false`，子类必须重写此方法
`protected boolean`	`moreEmptyCheck(R row)`
`void`	`read(java.io.File file, java.nio.charset.Charset charset)` 从指定的文件导入Excel格式数据
`void`	`read(java.io.InputStream inputStream, java.nio.charset.Charset charset, java.lang.String format)` 从`InputStream`将导入数据记录，子类必须重写此方法
`protected void`	`read(java.util.Iterator<R> itor)` 遍历导入数据保存到`rows`
`void`	`read(org.springframework.web.multipart.MultipartFile uplodFile, java.nio.charset.Charset charset)` 从WEB上传文件导入数据到
`void`	`read(java.lang.String file, java.nio.charset.Charset charset)` 从指定的文件导入Excel格式数据
`<T> void`	`setRows(java.util.List<T> rows)` 设置解析记录保存列表为`null`忽略, 多工作薄导入时，设置第一个工作薄解析配置对象的解析记录保存列表
`void`	`setSheetConfig(SheetConfig sheetConfig)`
`BaseExcelReader<R>`	`subFirst(java.lang.Boolean subFirst)` 打开/关闭嵌套字段优先模式,默认开启
`static java.lang.String`	`suffixOf(java.lang.String input)` 返回输入文件名的后缀(转小写),即最后一个'.'
`BaseExcelReader<R>`	`withRowsConsumer(java.util.function.Consumer<java.util.List> rowsConsumer)` 设置解析成功后解析数据的处理器

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

- 字段详细资料
  - sheetConfig
```
protected SheetConfig sheetConfig
```
  - fetchColumns
```
protected java.util.Map<java.lang.Integer,PropertyConfig> fetchColumns
```
  - debugOutput
```
protected boolean debugOutput
```
- 构造器详细资料
  - BaseExcelReader
```
public BaseExcelReader(SheetConfig sheetConfig,
                       java.util.List<?> rows,
                       java.util.function.Consumer<?> beanConsumer)
```
    参数:
    
    sheetConfig -
    
    rows -
    
    beanConsumer - 记录处理对象，为null则将记录保存到rows
  - BaseExcelReader
```
public BaseExcelReader(SheetConfig sheetConfig)
```
  - BaseExcelReader
```
public BaseExcelReader(SheetConfig sheetConfig,
                       java.util.function.Consumer<?> beanConsumer)
```
  - BaseExcelReader
```
public BaseExcelReader(java.util.function.Consumer<?> beanConsumer)
```
  - BaseExcelReader
```
public BaseExcelReader()
```
  - BaseExcelReader
```
public BaseExcelReader(BaseExcelReader builder)
```
- 方法详细资料
  - debugOutput
```
public BaseExcelReader<R> debugOutput(java.lang.Boolean debugOutput)
```
    设置调试输出标志
    
    参数:
    
    debugOutput -
    
    返回:
    
    当前对象
    
    从以下版本开始:
    
    3.29.7
  - subFirst
```
public BaseExcelReader<R> subFirst(java.lang.Boolean subFirst)
```
    打开/关闭嵌套字段优先模式,默认开启
    
    参数:
    
    subFirst - 为true 嵌套字段优先,否则按输入字段顺序处理
    
    返回:
    
    当前对象
    
    从以下版本开始:
    
    3.29.8
  - withRowsConsumer
```
public BaseExcelReader<R> withRowsConsumer(java.util.function.Consumer<java.util.List> rowsConsumer)
```
    设置解析成功后解析数据的处理器
    
    参数:
    
    rowsConsumer -
    
    返回:
    
    当前对象
    
    从以下版本开始:
    
    3.29.7
  - getSheetConfig
```
public SheetConfig getSheetConfig()
```
    指定者:
    
    getSheetConfig 在接口中 IExcelReader
  - setSheetConfig
```
public void setSheetConfig(SheetConfig sheetConfig)
```
    指定者:
    
    setSheetConfig 在接口中 IExcelReader
  - read
```
public void read(java.io.File file,
                 java.nio.charset.Charset charset)
          throws java.io.IOException
```
    从接口复制的说明: IExcelReader
    
    从指定的文件导入Excel格式数据
    
    指定者:
    
    read 在接口中 IExcelReader
    
    抛出:
    
    java.io.IOException
  - read
```
public void read(java.lang.String file,
                 java.nio.charset.Charset charset)
          throws java.io.IOException
```
    从接口复制的说明: IExcelReader
    
    从指定的文件导入Excel格式数据
    
    指定者:
    
    read 在接口中 IExcelReader
    
    抛出:
    
    java.io.IOException
  - read
```
public void read(org.springframework.web.multipart.MultipartFile uplodFile,
                 java.nio.charset.Charset charset)
          throws java.io.IOException
```
    从接口复制的说明: IExcelReader
    
    从WEB上传文件导入数据到
    
    指定者:
    
    read 在接口中 IExcelReader
    
    抛出:
    
    java.io.IOException
  - getRows
```
public <T> java.util.List<T> getRows()
```
    返回解析的记录列表
    
    指定者:
    
    getRows 在接口中 IExcelReader
  - setRows
```
public <T> void setRows(java.util.List<T> rows)
```
    从接口复制的说明: IExcelReader
    
    设置解析记录保存列表为null忽略, 多工作薄导入时，设置第一个工作薄解析配置对象的解析记录保存列表
    
    指定者:
    
    setRows 在接口中 IExcelReader
  - read
```
protected void read(java.util.Iterator<R> itor)
```
    遍历导入数据保存到rows
    
    参数:
    
    itor -
  - consumeRows
```
protected final void consumeRows()
```
    从以下版本开始:
    
    3.29.7
  - read
```
public void read(java.io.InputStream inputStream,
                 java.nio.charset.Charset charset,
                 java.lang.String format)
          throws java.io.IOException
```
    从InputStream将导入数据记录，子类必须重写此方法
    
    指定者:
    
    read 在接口中 IExcelReader
    
    参数:
    
    inputStream -
    
    charset - 数据编码为null使用默认值
    
    format - 文件格式,即文件后缀: .xls,xlxs,.cxv
    
    抛出:
    
    java.io.IOException
  - getCellAsString
```
protected java.lang.String getCellAsString(R row,
                                           int idx)
```
    从单元格读取数据转为String，子类必须重写此方法
    
    参数:
    
    row -
    
    idx -
  - isEmptyCell
```
protected boolean isEmptyCell(R row,
                              int idx)
```
    行由idx指定单元为空返回true，否则返回false，子类必须重写此方法
    
    参数:
    
    row -
    
    idx -
  - indexsOfRow
```
protected java.util.List<java.lang.Integer> indexsOfRow(R row)
```
    返回列的索引范围列表，子类必须重写此方法
    
    参数:
    
    row -
  - moreEmptyCheck
```
protected boolean moreEmptyCheck(R row)
```
  - converExp
```
protected java.lang.Object converExp(java.lang.Object s,
                                     PropertyConfig p)
```
  - suffixOf
```
public static java.lang.String suffixOf(java.lang.String input)
```
    返回输入文件名的后缀(转小写),即最后一个'.'及后面的内容, 如果输入字符串不包含'.'返回null
    
    参数:
    
    input - 为null返回null

类 BaseExcelReader<R>

字段概要

构造器概要

方法概要

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

字段详细资料

sheetConfig

fetchColumns

debugOutput

构造器详细资料

BaseExcelReader

BaseExcelReader

BaseExcelReader

BaseExcelReader

BaseExcelReader

BaseExcelReader

方法详细资料

debugOutput

subFirst

withRowsConsumer

getSheetConfig

setSheetConfig

read

read

read

getRows

setRows

read

consumeRows

read

getCellAsString

isEmptyCell

indexsOfRow

moreEmptyCheck

converExp

suffixOf