ExcelReader (Excel Write/Read Framework 0.5.4 API)

java.lang.Object
- org.ttzero.excel.reader.ExcelReader

所有已实现的接口:

Closeable, AutoCloseable
```
public class ExcelReader
extends Object
implements Closeable
```
Excel Reader tools
A streaming operation chain, using cursor control, the cursor will only move forward, so you cannot repeatedly operate the same Sheet stream. If you need to read the data of a worksheet multiple times please call the Sheet.reset() method.
The internal Row object of the same Sheet is memory shared, so don't directly convert Stream<Row> to a Collection. You should first consider using the try-with-resource block to use Reader or manually close the ExcelReader.
```
 try (ExcelReader reader = ExcelReader.read(path)) {
     reader.sheets().flatMap(Sheet::rows).forEach(System.out::println);
 } catch (IOException e) { }
```
作者:

guanquan.wang on 2018-09-22

字段概要

字段
限定符和类型	字段和说明
`static int`	`COPY_ON_MERGED` Copy value on merge cells
`protected Drawings`	`drawings` Picture or Tables
`protected boolean`	`hasFormula` A formula flag
`static Set<String>`	`MUST_CHECK_PART`
`protected int`	`option` Reader Option 0: only parse cell value (default) 2: parse cell value and calc 4: copy value on merge cells These attributes can be combined via `\|`, like: VALUE_ONLY\|COPY_ON_MERGED
`protected Path`	`self`
`protected Sheet[]`	`sheets`
`static int`	`VALUE_AND_CALC` Parse cell value and calc
`static int`	`VALUE_ONLY` Specify `ExcelReader` only parse cell value (Default)

构造器概要

构造器
限定符	构造器和说明
`protected`	`ExcelReader()`
	`ExcelReader(InputStream is)`
	`ExcelReader(InputStream is, int option)`
	`ExcelReader(InputStream stream, int bufferSize, int cacheSize, int option)`
	`ExcelReader(Path path)`
	`ExcelReader(Path path, int option)`
	`ExcelReader(Path path, int bufferSize, int cacheSize, int option)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Sheet[]`	`all()` Returns all sheets
`static long`	`cellRangeToLong(String r)` Cell range string convert to long 0-16: column number 17-48: row number range string\| long value ------------\|------------ A1 \| 65537 AA10 \| 655387
`protected ContentType`	`checkContentType(Path root)`
`void`	`close()` Close stream and delete temp files
`ExcelReader`	`copyOnMergeCells()` Copy values when reading merged cells.
`AppInfo`	`getAppInfo()` General information like title,subject and creator
`protected AppInfo`	`getGeneralInfo(Path tmp)`
`int`	`getSize()` Size of sheets
`ExcelType`	`getType()` Type of excel
`static ExcelType`	`getType(Path path)` Check the documents type
`boolean`	`hasFormula()` 已过时。 This method can not accurately reflect whether the workbook contains formulas. Here we only check whether they contain a common calcChain file, and the Excel files generated by some tools do not contain the calcChain file, but write all formulas in each cell.
`protected ExcelReader`	`init(Path path, int bufferSize, int cacheSize, int option)`
`List<Drawings.Picture>`	`listPictures()` List all pictures in excel
`ExcelReader`	`parseFormula()` Make the reader parse formula
`static ExcelReader`	`read(InputStream stream)` Constructor Excel Reader
`static ExcelReader`	`read(InputStream stream, int option)` Constructor Excel Reader
`static ExcelReader`	`read(InputStream stream, int bufferSize, int option)` Constructor Excel Reader
`static ExcelReader`	`read(InputStream stream, int bufferSize, int cacheSize, int option)` Constructor Excel Reader
`static ExcelReader`	`read(Path path)` Constructor Excel Reader
`static ExcelReader`	`read(Path path, int option)` Constructor Excel Reader
`static ExcelReader`	`read(Path path, int bufferSize, int option)` Constructor Excel Reader
`static ExcelReader`	`read(Path path, int bufferSize, int cacheSize, int option)` Constructor Excel Reader
`Sheet`	`sheet(int index)` get by index
`Sheet`	`sheet(String sheetName)` get by name
`protected Sheet`	`sheetFactory(int option)` Create a read sheet
`Stream<Sheet>`	`sheets()` to streams

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

- 字段详细资料
  - VALUE_ONLY
```
public static final int VALUE_ONLY
```
    Specify ExcelReader only parse cell value (Default)
    
    另请参阅:
    
    常量字段值
  - VALUE_AND_CALC
```
public static final int VALUE_AND_CALC
```
    Parse cell value and calc
    
    另请参阅:
    
    常量字段值
  - COPY_ON_MERGED
```
public static final int COPY_ON_MERGED
```
    Copy value on merge cells
    
    另请参阅:
    
    常量字段值
  - self
```
protected Path self
```
  - sheets
```
protected Sheet[] sheets
```
  - option
```
protected int option
```
    Reader Option
    - 0: only parse cell value (default)
    - 2: parse cell value and calc
    - 4: copy value on merge cells
    These attributes can be combined via `|`, like: VALUE_ONLY|COPY_ON_MERGED
  - hasFormula
```
protected boolean hasFormula
```
    A formula flag
  - drawings
```
protected Drawings drawings
```
    Picture or Tables
  - MUST_CHECK_PART
```
public static final Set<String> MUST_CHECK_PART
```
- 构造器详细资料
  - ExcelReader
```
protected ExcelReader()
```
  - ExcelReader
```
public ExcelReader(InputStream is)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(InputStream is,
                   int option)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(InputStream stream,
                   int bufferSize,
                   int cacheSize,
                   int option)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(Path path)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(Path path,
                   int option)
            throws IOException
```
    抛出:
    
    IOException
  - ExcelReader
```
public ExcelReader(Path path,
                   int bufferSize,
                   int cacheSize,
                   int option)
            throws IOException
```
    抛出:
    
    IOException
- 方法详细资料
  - read
```
public static ExcelReader read(Path path)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    path - the excel path
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    stream - the InputStream of excel
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    path - the excel path
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    stream - the InputStream of excel
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int bufferSize,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    path - the excel path
    
    bufferSize - the SharedStrings buffer size. default is 512 This parameter affects the number of read times.
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int bufferSize,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    stream - the InputStream of excel
    
    bufferSize - the SharedStrings buffer size. default is 512 This parameter affects the number of read times.
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - read
```
public static ExcelReader read(Path path,
                               int bufferSize,
                               int cacheSize,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    path - the excel path
    
    bufferSize - the SharedStrings buffer size. default is 512 This parameter affects the number of read times.
    
    cacheSize - the Cache size, default is 512
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if path not exists or I/O error occur
  - read
```
public static ExcelReader read(InputStream stream,
                               int bufferSize,
                               int cacheSize,
                               int option)
                        throws IOException
```
    Constructor Excel Reader
    
    参数:
    
    stream - the InputStream of excel
    
    bufferSize - the SharedStrings buffer size. default is 512 This parameter affects the number of read times.
    
    cacheSize - the Cache size, default is 512
    
    option - the reader option.
    
    返回:
    
    the ExcelReader
    
    抛出:
    
    IOException - if I/O error occur
  - getType
```
public ExcelType getType()
```
    Type of excel
    
    返回:
    
    enum type ExcelType
  - sheets
```
public Stream<Sheet> sheets()
```
    to streams
    
    返回:
    
    Stream of Sheet
  - sheet
```
public Sheet sheet(int index)
```
    get by index
    
    参数:
    
    index - sheet index of workbook
    
    返回:
    
    sheet
  - sheet
```
public Sheet sheet(String sheetName)
```
    get by name
    
    参数:
    
    sheetName - name
    
    返回:
    
    null if not found
  - all
```
public Sheet[] all()
```
    Returns all sheets
    
    返回:
    
    Sheet Array
  - getSize
```
public int getSize()
```
    Size of sheets
    
    返回:
    
    int
  - close
```
public void close()
           throws IOException
```
    Close stream and delete temp files
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - when fail close readers
  - getAppInfo
```
public AppInfo getAppInfo()
```
    General information like title,subject and creator
    
    返回:
    
    the information
  - hasFormula
```
@Deprecated
public boolean hasFormula()
```
    已过时。 This method can not accurately reflect whether the workbook contains formulas. Here we only check whether they contain a common calcChain file, and the Excel files generated by some tools do not contain the calcChain file, but write all formulas in each cell.
    
    Check current workbook has formula
    
    返回:
    
    boolean
  - parseFormula
```
public ExcelReader parseFormula()
```
    Make the reader parse formula
    
    返回:
    
    ExcelReader
  - copyOnMergeCells
```
public ExcelReader copyOnMergeCells()
```
    Copy values when reading merged cells.
    By default, the values of the merged cells are only stored in the first Cell, and other cells have no values. Call this method to copy the value to other cells in the merge.
    |---------| |---------| |---------| | | | 1 | | | 1 | 1 | | 1 | => |----|----| => |----|----| | | | | | | 1 | 1 | |---------| |---------| |---------| Merged(A1:B2) Default Copy Value in A1 others are `null`
    返回:
    
    ExcelReader
  - checkContentType
```
protected ContentType checkContentType(Path root)
```
  - init
```
protected ExcelReader init(Path path,
                           int bufferSize,
                           int cacheSize,
                           int option)
                    throws IOException
```
    抛出:
    
    IOException
  - sheetFactory
```
protected Sheet sheetFactory(int option)
```
    Create a read sheet
    
    参数:
    
    option - the reader option.
    
    返回:
    
    Sheet extends XMLSheet
  - getType
```
public static ExcelType getType(Path path)
```
    Check the documents type
    
    参数:
    
    path - documents path
    
    返回:
    
    enum of ExcelType
  - getGeneralInfo
```
protected AppInfo getGeneralInfo(Path tmp)
```
  - cellRangeToLong
```
public static long cellRangeToLong(String r)
```
    Cell range string convert to long 0-16: column number 17-48: row number
    range string| long value ------------|------------ A1 | 65537 AA10 | 655387
    参数:
    
    r - the range string of cell
    
    返回:
    
    long value
  - listPictures
```
public List<Drawings.Picture> listPictures()
```
    List all pictures in excel
    
    返回:
    
    picture list or null if not exists.

类 ExcelReader

字段概要

构造器概要

方法概要

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

字段详细资料

VALUE_ONLY

VALUE_AND_CALC

COPY_ON_MERGED

self

sheets

option

hasFormula

drawings

MUST_CHECK_PART

构造器详细资料

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

ExcelReader

方法详细资料

read

read

read

read

read

read

read

read

getType

sheets

sheet

sheet

all

getSize

close

getAppInfo

hasFormula

parseFormula

copyOnMergeCells

checkContentType

init

sheetFactory

getType

getGeneralInfo

cellRangeToLong

listPictures