io.github.millij.poi.ss.reader

接口 SpreadsheetReader

所有已知实现类:

XlsReader, XlsxReader

public interface SpreadsheetReader

An Abstract representation of a Spreadsheet Reader. Any reader implementation (HSSF or XSSF) is expected to implement and provide the below APIs.

方法概要

限定符和类型	方法和说明
<T> java.util.List<T>	read(java.lang.Class<T> beanClz, java.io.File file) Reads the spreadsheet file to beans of the given type.
<T> java.util.List<T>	read(java.lang.Class<T> beanClz, java.io.File file, int sheetNo) Reads the spreadsheet file to beans of the given type.
<T> void	read(java.lang.Class<T> beanClz, java.io.File file, int sheetNo, RowListener<T> listener) Reads the spreadsheet file to beans of the given type.
<T> void	read(java.lang.Class<T> beanClz, java.io.File file, RowListener<T> listener) Reads the spreadsheet file to beans of the given type.
<T> java.util.List<T>	read(java.lang.Class<T> beanClz, java.io.InputStream is) Reads the spreadsheet file to beans of the given type.
<T> java.util.List<T>	read(java.lang.Class<T> beanClz, java.io.InputStream is, int sheetNo) Reads the spreadsheet file to beans of the given type.
<T> void	read(java.lang.Class<T> beanClz, java.io.InputStream is, int sheetNo, RowListener<T> listener) Reads the spreadsheet file to beans of the given type.
<T> void	read(java.lang.Class<T> beanClz, java.io.InputStream is, RowListener<T> listener) Reads the spreadsheet file to beans of the given type.

方法详细资料

read

<T> void read(java.lang.Class<T> beanClz,
              java.io.File file,
              RowListener<T> listener)
       throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. This method will attempt to read all the available sheets of the file and creates the objects of the passed type.

The RowListener implementation callback gets triggered after reading each Row. Best Suited for reading Large files in restricted memory environments.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

file - File object of the spreadsheet file

listener - Custom RowListener implementation for row data callbacks.

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> void read(java.lang.Class<T> beanClz,
              java.io.InputStream is,
              RowListener<T> listener)
       throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. This method will attempt to read all the available sheets of the file and creates the objects of the passed type.

The RowListener implementation callback gets triggered after reading each Row. Best Suited for reading Large files in restricted memory environments.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

is - InputStream of the spreadsheet file

listener - Custom RowListener implementation for row data callbacks.

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> void read(java.lang.Class<T> beanClz,
              java.io.File file,
              int sheetNo,
              RowListener<T> listener)
       throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. Note that only the requested sheet (sheet numbers are indexed from 0) will be read.

The RowListener implementation callback gets triggered after reading each Row. Best Suited for reading Large files in restricted memory environments.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

file - File object of the spreadsheet file

sheetNo - index of the Sheet to be read (index starts from 0)

listener - Custom RowListener implementation for row data callbacks.

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> void read(java.lang.Class<T> beanClz,
              java.io.InputStream is,
              int sheetNo,
              RowListener<T> listener)
       throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. Note that only the requested sheet (sheet numbers are indexed from 0) will be read.

The RowListener implementation callback gets triggered after reading each Row. Best Suited for reading Large files in restricted memory environments.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

is - InputStream of the spreadsheet file

sheetNo - index of the Sheet to be read (index starts from 0)

listener - Custom RowListener implementation for row data callbacks.

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> java.util.List<T> read(java.lang.Class<T> beanClz,
                           java.io.File file)
                    throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. This method will attempt to read all the available sheets of the file and creates the objects of the passed type.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

file - File object of the spreadsheet file

返回:

a List of objects of the parameterized type

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> java.util.List<T> read(java.lang.Class<T> beanClz,
                           java.io.InputStream is)
                    throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. This method will attempt to read all the available sheets of the file and creates the objects of the passed type.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - The Class type to deserialize the rows data

is - InputStream of the spreadsheet file

返回:

a List of objects of the parameterized type

抛出:

SpreadsheetReadException - an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> java.util.List<T> read(java.lang.Class<T> beanClz,
                           java.io.File file,
                           int sheetNo)
                    throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. Note that only the requested sheet (sheet numbers are indexed from 0) will be read.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - beanClz The Class type to deserialize the rows data

file - file File object of the spreadsheet file

sheetNo - index of the Sheet to be read (index starts from 0)

返回:

a List of objects of the parameterized type

抛出:

SpreadsheetReadException - SpreadsheetReadException an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.

read

<T> java.util.List<T> read(java.lang.Class<T> beanClz,
                           java.io.InputStream is,
                           int sheetNo)
                    throws SpreadsheetReadException

Reads the spreadsheet file to beans of the given type. Note that only the requested sheet (sheet numbers are indexed from 0) will be read.

类型参数:

T - The Parameterized bean Class.

参数:

beanClz - beanClz The Class type to deserialize the rows data

is - InputStream of the spreadsheet file

sheetNo - index of the Sheet to be read (index starts from 0)

返回:

a List of objects of the parameterized type

抛出:

SpreadsheetReadException - SpreadsheetReadException an exception is thrown in cases where the file data is not readable or row data to bean mapping failed.