程序包 gu.sql2java.excel

类 ExcelReader

java.lang.Object
gu.sql2java.excel.ExcelReader
所有已实现的接口:
IExcelReader
public final class ExcelReader extends Object implements IExcelReader
EXCEL(.xls,.xlsx,.csv)文件导入,支持多工作薄导入
从以下版本开始:
3.29.0
作者:
guyadong

  • 构造器详细资料

    • ExcelReader

      public ExcelReader()
      默认构造方法，创建第一个工作薄配置

    • ExcelReader

      public ExcelReader(Consumer<?> beanConsumer)
      构造方法 创建第一个工作薄配置
      参数:
      beanConsumer -

    • ExcelReader

      public ExcelReader(SheetConfig sheetConfig, Consumer<?> beanConsumer)
      构造方法 创建第一个工作薄配置
      参数:
      sheetConfig -
      beanConsumer -

    • ExcelReader

      public ExcelReader(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer)
      构造方法 创建第一个工作薄配置
      参数:
      sheetConfig -
      rows -
      beanConsumer -

    • ExcelReader

      public ExcelReader(SheetConfig sheetConfig)

    • ExcelReader

      public ExcelReader(BaseExcelReader<?> builder)

  • 方法详细资料

    • debugOutput

      public ExcelReader debugOutput(Boolean debugOutput)
      设置调试输出标志
      参数:
      debugOutput -

    • subFirst

      public ExcelReader subFirst(boolean subFirst, int... indexes)
      打开/关闭嵌套字段优先模式,默认开启
      参数:
      subFirst - 为true 嵌套字段优先,否则按输入字段顺序处理
      indexes - 工作薄解析配置对象索引
      返回:
      当前对象
      从以下版本开始:
      3.29.9

    • subFirst

      public ExcelReader subFirst(boolean subFirst, String... names)
      打开/关闭嵌套字段优先模式,默认开启
      参数:
      subFirst - 为true 嵌套字段优先,否则按输入字段顺序处理
      names - 工作薄解析配置对象对应的工作薄名称
      返回:
      当前对象
      从以下版本开始:
      3.29.9

    • readerWorkSort

      public ExcelReader readerWorkSort(Iterable<Integer> indexes)
      多工作薄导入的情况下， 指定工作薄解析配置的执行顺序，如果不指定则从0开始顺序执行
      参数:
      indexes -
      返回:
      当前对象
      从以下版本开始:
      3.29.7

    • readerWorkSort

      public ExcelReader readerWorkSort(int... indexes)
      多工作薄导入的情况下， 指定工作薄解析配置的执行顺序，如果不指定则从0开始顺序执行
      参数:
      indexes -
      返回:
      当前对象
      从以下版本开始:
      3.29.7

    • configSheet

      public ExcelReader configSheet(Iterable<BaseExcelReader<?>> readers)
      顺序设置工作薄解析配置对象
      参数:
      readers -
      返回:
      当前对象
      从以下版本开始:
      3.29.8

    • configSheet

      public ExcelReader configSheet(BaseExcelReader<?>... readers)
      顺序设置工作薄解析配置对象
      参数:
      readers -
      返回:
      当前对象
      从以下版本开始:
      3.29.8

    • configSheet

      public <B extends BaseExcelReader<?>> ExcelReader configSheet(B reader, int index)
      为指定索引设置工作薄解析配置
      参数:
      reader -
      index - 指定配置索引位置(0-based)
      返回:
      当前对象
      从以下版本开始:
      3.29.7

    • configSheet

      public ExcelReader configSheet(SheetConfig sheetConfig, List<?> rows, Consumer<?> beanConsumer, int index)
      为指定索引设置工作薄解析配置
      参数:
      sheetConfig -
      rows - 工作薄的解析记录保存列表
      beanConsumer -
      index - 指定配置索引位置(0-based)
      返回:
      当前对象

    • configSheet

      public ExcelReader configSheet(SheetConfig sheetConfig, Consumer<?> beanConsumer, int index)
      为指定索引设置工作薄解析配置
      参数:
      sheetConfig -
      beanConsumer -
      index - 0-based index
      返回:
      当前对象
      另请参阅:

    • configSheet

      public ExcelReader configSheet(SheetConfig sheetConfig, int index)
      为指定索引设置工作薄解析配置
      参数:
      sheetConfig -
      index - 0-based index
      返回:
      当前对象
      另请参阅:

    • configSheet

      public ExcelReader configSheet(Consumer<?> beanConsumer, int index)
      为指定索引设置工作薄解析配置
      参数:
      beanConsumer -
      index - 0-based index
      返回:
      当前对象
      另请参阅:

    • read

      public void read(InputStream inputStream, Charset charset, String format) throws IOException
      从InputStream将导入数据记录
      多工作薄导入时，如果解析配置SheetConfig 指定了工作薄名称(参见 SheetConfig.sheetName 字段 )，优先使用SheetName查找工作薄 如果没有指定工作薄名，则查找对应的索引获取 Sheet读取数据
      指定者:
      read 在接口中 IExcelReader
      参数:
      inputStream -
      charset - 数据编码为null使用默认值
      format - 文件格式,即文件后缀: .xls,xlxs,.cxv
      抛出:
      IOException

    • setRows

      public <T> void setRows(List<T> rows)
      设置第一个工作薄解析配置对象的解析记录保存列表为null忽略
      指定者:
      setRows 在接口中 IExcelReader

    • getRows

      public <T> List<T> getRows()
      返回第一个工作薄解析配置对象的解析记录保存列表
      指定者:
      getRows 在接口中 IExcelReader

    • setRows

      public <T> ExcelReader setRows(List<T> rows, int index)
      设置索引指定的工作薄的解析记录保存列表为null忽略， 索引无效抛出异常
      类型参数:
      T -
      参数:
      rows -
      index -
      返回:
      当前对象

    • setRows

      public <T> ExcelReader setRows(List<T> rows, String sheetName)
      设置工作薄名指定的工作薄的解析记录保存列表为null忽略， 按工作薄名无法找到工作薄则抛出异常
      类型参数:
      T -
      参数:
      rows -
      sheetName - 工作薄名
      返回:
      当前对象

    • getRows

      public <T> List<T> getRows(int index)
      返回索引指定的工作薄的解析记录保存列表， 索引无效抛出异常
      类型参数:
      T -
      参数:
      index -

    • getRows

      public <T> List<T> getRows(String sheetName)
      返回工作薄名指定的工作薄的解析记录保存列表， 按工作薄名无法找到工作薄则抛出异常
      类型参数:
      T -
      参数:
      sheetName -

    • setSheetConfig

      public void setSheetConfig(SheetConfig sheetConfig)
      指定者:
      setSheetConfig 在接口中 IExcelReader

    • getSheetConfig

      public SheetConfig getSheetConfig()
      指定者:
      getSheetConfig 在接口中 IExcelReader

    • read

      public void read(org.springframework.web.multipart.MultipartFile uplodFile, Charset charset) throws IOException
      从接口复制的说明: IExcelReader
      从WEB上传文件导入数据到
      指定者:
      read 在接口中 IExcelReader
      抛出:
      IOException

    • read

      public void read(String file, Charset charset) throws IOException
      从接口复制的说明: IExcelReader
      从指定的文件导入Excel格式数据
      指定者:
      read 在接口中 IExcelReader
      抛出:
      IOException

    • read

      public void read(File file, Charset charset) throws IOException
      从接口复制的说明: IExcelReader
      从指定的文件导入Excel格式数据
      指定者:
      read 在接口中 IExcelReader
      抛出:
      IOException