Package org.miaixz.bus.office.excel.sax

Interface ExcelSaxReader<T>

Type Parameters:
T - 子对象类型，用于标记返回值this
All Known Implementing Classes:
Excel03SaxReader, Excel07SaxReader
public interface ExcelSaxReader<T>
Sax方式读取Excel接口，提供一些共用方法
Since:
Java 17+
Author:
Kimi Liu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    RID_PREFIX
    sheet r:Id前缀
    static final String
    SHEET_NAME_PREFIX
    sheet name前缀

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    read(File file)
    开始读取Excel，读取所有sheet
    default T
    read(File file, int rid)
    开始读取Excel
    T
    read(File file, String idOrRidOrSheetName)
    开始读取Excel
    default T
    read(InputStream in)
    开始读取Excel，读取所有sheet，读取结束后并不关闭流
    default T
    read(InputStream in, int rid)
    开始读取Excel，读取结束后并不关闭流
    T
    read(InputStream in, String idOrRidOrSheetName)
    开始读取Excel，读取结束后并不关闭流
    default T
    read(String path)
    开始读取Excel，读取所有sheet
    default T
    read(String path, int idOrRidOrSheetName)
    开始读取Excel
    default T
    read(String path, String idOrRidOrSheetName)
    开始读取Excel

  • Field Details

  • Method Details

    • read

      T read(File file, String idOrRidOrSheetName) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel
      Parameters:
      file - Excel文件
      idOrRidOrSheetName - Excel中的sheet id或者rid编号或sheet名称，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      T read(InputStream in, String idOrRidOrSheetName) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel，读取结束后并不关闭流
      Parameters:
      in - Excel流
      idOrRidOrSheetName - Excel中的sheet id或者rid编号，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(String path) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel，读取所有sheet
      Parameters:
      path - Excel文件路径
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(File file) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel，读取所有sheet
      Parameters:
      file - Excel文件
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(InputStream in) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel，读取所有sheet，读取结束后并不关闭流
      Parameters:
      in - Excel包流
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(String path, int idOrRidOrSheetName) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel
      Parameters:
      path - 文件路径
      idOrRidOrSheetName - Excel中的sheet id或者rid编号或sheet名称，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(String path, String idOrRidOrSheetName) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel
      Parameters:
      path - 文件路径
      idOrRidOrSheetName - Excel中的sheet id或者rid编号或sheet名称，rid必须加rId前缀，例如rId1，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(File file, int rid) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel
      Parameters:
      file - Excel文件
      rid - Excel中的sheet rid编号，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常

    • read

      default T read(InputStream in, int rid) throws org.miaixz.bus.core.lang.exception.InternalException
      开始读取Excel，读取结束后并不关闭流
      Parameters:
      in - Excel流
      rid - Excel中的sheet rid编号，如果为-1处理所有编号的sheet
      Returns:
      this
      Throws:
      org.miaixz.bus.core.lang.exception.InternalException - POI异常