Sheet (Excel Write/Read Framework 0.5.11 API)

所有超级接口:

AutoCloseable, Closeable

所有已知子接口:

CalcSheet, MergeSheet

所有已知实现类:

XMLSheet
```
public interface Sheet
extends Closeable
```
作者:

guanquan.wang at 2019-04-17 11:36

方法概要

所有方法静态方法实例方法抽象方法默认方法已过时的方法
限定符和类型	方法和说明
`default Sheet`	`addHeaderColumnReadOption(int option)` Add header columns preprocessing properties
`CalcSheet`	`asCalcSheet()` Make worksheets parse formulas
`MergeSheet`	`asMergeSheet()` Make worksheets copy value on merge cells
`Sheet`	`asSheet()` Make worksheets parse value only
`Sheet`	`bind(Class<?> clazz)` Set the binding type
`default Sheet`	`bind(Class<?> clazz, int fromRowNum)` Set the binding type
`default Sheet`	`bind(Class<?> clazz, int fromRowNum, int toRowNum)` Set the binding type
`Sheet`	`bind(Class<?> clazz, Row row)` Set the binding type
`void`	`close()` Close resource
`static int`	`col2Int(String col)` Convert column mark to int
`Row`	`createRow()` Create a `Row` to read
`Iterator<Row>`	`dataIterator()` Iterating over data rows without header information and blank lines
`default Stream<Row>`	`dataRows()` Return stream with out header row and empty rows
`default Sheet`	`forceImport()` Use field name matching without `ExcelColumn` annotation When converting row data to Java objects, only fields with `ExcelColumn` annotations are matched by default.
`Dimension`	`getDimension()` Returns The range address of the used area in the current sheet NOTE: This method can only guarantee accurate row ranges
`Row`	`getHeader()` Returns the header of the list.
`int`	`getHeaderColumnReadOption()` Returns Header column options
`int`	`getId()` The worksheet id, it difference with index is that the id will not change because of moving or deleting worksheet.
`int`	`getIndex()` The index of worksheet located at the workbook
`String`	`getName()` The worksheet name
`int`	`getSize()` 已过时。 use `getDimension()` to getting full range address
`default Sheet`	`header(int fromRowNum)` Specify the header rows endpoint
`Sheet`	`header(int fromRowNum, int toRowNum)` Specify the header rows endpoint Note: After specifying the header row number, the row-pointer will move to the next row of the header range.
`default Sheet`	`headerColumnIgnoreCase()` Settings ignore case matching column names
`default Sheet`	`headerColumnToCamelCase()` Convert column name to camel case
`boolean`	`isHidden()` Test Worksheet is hidden
`default boolean`	`isShow()` Test Worksheet is show
`Iterator<Row>`	`iterator()` Iterating each row of data contains header information and blank lines
`List<Drawings.Picture>`	`listPictures()` List all pictures in workbook
`Sheet`	`load()` Load the sheet data
`default Sheet`	`reset()` Reset the `Sheet`'s row index to begging
`default Stream<Row>`	`rows()` Return a stream of all rows
`default void`	`saveAsCSV(BufferedWriter bw)` Save file as Comma-Separated Values.
`default void`	`saveAsCSV(OutputStream os)` Save file as Comma-Separated Values.
`default void`	`saveAsCSV(OutputStream os, Charset charset)` Save file as Comma-Separated Values.
`default void`	`saveAsCSV(Path path)` Save file as Comma-Separated Values.
`default void`	`saveAsCSV(Path path, Charset charset)` Save file as Comma-Separated Values.
`Sheet`	`setHeaderColumnReadOption(int option)` Setting header columns preprocessing properties HeaderRow.FORCE_IMPORT: Match with field name if without ExcelColumn annotation HeaderRow.IGNORE_CASE: Ignore case matching column names HeaderRow.CAMEL_CASE: CAMEL_CASE to camelCase reader.sheet(0).setHeaderColumnReadOption(HeaderRow.FORCE_IMPORT \| HeaderRow.IGNORE_CASE)

- 方法详细资料
  - getName
```
String getName()
```
    The worksheet name
    
    返回:
    
    the sheet name
  - getIndex
```
int getIndex()
```
    The index of worksheet located at the workbook
    
    返回:
    
    the index(zero base)
  - getId
```
int getId()
```
    The worksheet id, it difference with index is that the id will not change because of moving or deleting worksheet.
    
    返回:
    
    id of worksheet
  - getSize
```
@Deprecated
int getSize()
```
    已过时。 use getDimension() to getting full range address
    
    size of rows.
    
    返回:
    
    size of rows -1: unknown size
  - getDimension
```
Dimension getDimension()
```
    Returns The range address of the used area in the current sheet
    NOTE: This method can only guarantee accurate row ranges
    
    返回:
    
    worksheet Dimension ranges
  - isHidden
```
boolean isHidden()
```
    Test Worksheet is hidden
    
    返回:
    
    true if current worksheet is hidden
  - isShow
```
default boolean isShow()
```
    Test Worksheet is show
    
    返回:
    
    true if current worksheet is show
  - header
```
default Sheet header(int fromRowNum)
```
    Specify the header rows endpoint
    
    参数:
    
    fromRowNum - low endpoint (inclusive) of the worksheet (one base)
    
    返回:
    
    current Sheet
    
    抛出:
    
    IndexOutOfBoundsException - if fromRow less than 1
  - header
```
Sheet header(int fromRowNum,
             int toRowNum)
```
    Specify the header rows endpoint
    Note: After specifying the header row number, the row-pointer will move to the next row of the header range. The bind(Class), bind(Class, int), bind(Class, int, int), rows(), dataRows(), iterator(), and dataIterator() will all be affected.
    
    参数:
    
    fromRowNum - low endpoint (inclusive) of the worksheet (one base)
    
    toRowNum - high endpoint (inclusive) of the worksheet (one base)
    
    返回:
    
    current Sheet
    
    抛出:
    
    IndexOutOfBoundsException - if fromRow less than 1
    
    IllegalArgumentException - if toRow less than fromRow
  - getHeader
```
Row getHeader()
```
    Returns the header of the list. The first non-empty line defaults to the header information. You can also call header(int, int) to specify multiple header rows. If there are multiple rows of headers, ':' will be used for stitching.
    +-----------------------------+ | | COMMON | | TITLE +-------+------+------+ | | SUB1 | SUB2 | SUB3 | +------+-------+-------+------+
    The above table will return "TITLE", "COMMON:SUB1", "COMMON:SUB2", "COMMON:SUB3"
    返回:
    
    the HeaderRow
  - bind
```
Sheet bind(Class<?> clazz)
```
    Set the binding type
    
    参数:
    
    clazz - the binding type
    
    返回:
    
    the Sheet
  - bind
```
default Sheet bind(Class<?> clazz,
                   int fromRowNum)
```
    Set the binding type
    
    参数:
    
    clazz - the binding type
    
    fromRowNum - low endpoint (inclusive) of the worksheet (one base)
    
    返回:
    
    the Sheet
  - bind
```
default Sheet bind(Class<?> clazz,
                   int fromRowNum,
                   int toRowNum)
```
    Set the binding type
    
    参数:
    
    clazz - the binding type
    
    fromRowNum - low endpoint (inclusive) of the worksheet (one base)
    
    toRowNum - high endpoint (inclusive) of the worksheet (one base)
    
    返回:
    
    the Sheet
  - bind
```
Sheet bind(Class<?> clazz,
           Row row)
```
    Set the binding type
    
    参数:
    
    clazz - the binding type
    
    row - specify a custom header row
    
    返回:
    
    the Sheet
  - load
```
Sheet load()
    throws IOException
```
    Load the sheet data
    
    返回:
    
    the Sheet
    
    抛出:
    
    IOException - if I/O error occur
  - iterator
```
Iterator<Row> iterator()
```
    Iterating each row of data contains header information and blank lines
    
    返回:
    
    a row iterator
  - dataIterator
```
Iterator<Row> dataIterator()
```
    Iterating over data rows without header information and blank lines
    
    返回:
    
    a row iterator
  - listPictures
```
List<Drawings.Picture> listPictures()
```
    List all pictures in workbook
    
    返回:
    
    picture list or null if not exists.
  - createRow
```
Row createRow()
```
    Create a Row to read
    
    返回:
    
    subclass
  - reset
```
default Sheet reset()
```
    Reset the Sheet's row index to begging
    
    返回:
    
    the unread Sheet
    
    抛出:
    
    ExcelReadException - if I/O error occur.
    
    UnsupportedOperationException - if sub-class un-implement this function.
  - rows
```
default Stream<Row> rows()
```
    Return a stream of all rows
    
    返回:
    
    a Stream<Row> providing the lines of row described by this Sheet
    
    从以下版本开始:
    
    1.8
  - dataRows
```
default Stream<Row> dataRows()
```
    Return stream with out header row and empty rows
    
    返回:
    
    a Stream<Row> providing the lines of row described by this Sheet
    
    从以下版本开始:
    
    1.8
  - col2Int
```
static int col2Int(String col)
```
    Convert column mark to int
    
    参数:
    
    col - column mark
    
    返回:
    
    int value
  - close
```
void close()
    throws IOException
```
    Close resource
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    指定者:
    
    close 在接口中 Closeable
    
    抛出:
    
    IOException - if I/O error occur
  - saveAsCSV
```
default void saveAsCSV(Path path)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    参数:
    
    path - the output storage path
    
    抛出:
    
    IOException - if I/O error occur.
  - saveAsCSV
```
default void saveAsCSV(Path path,
                       Charset charset)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file.
    
    参数:
    
    path - the output storage path
    
    charset - specify a charset, default is UTF-8
    
    抛出:
    
    IOException - if I/O error occur.
  - saveAsCSV
```
default void saveAsCSV(OutputStream os)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    参数:
    
    os - the output
    
    抛出:
    
    IOException - if I/O error occur.
  - saveAsCSV
```
default void saveAsCSV(OutputStream os,
                       Charset charset)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default separator character is ','.
    
    参数:
    
    os - the output
    
    charset - specify a charset
    
    抛出:
    
    IOException - if I/O error occur.
  - saveAsCSV
```
default void saveAsCSV(BufferedWriter bw)
                throws IOException
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    参数:
    
    bw - buffer writer
    
    抛出:
    
    IOException - if I/O error occur.
  - forceImport
```
default Sheet forceImport()
```
    Use field name matching without ExcelColumn annotation
    When converting row data to Java objects, only fields with ExcelColumn annotations are matched by default. forceImport will skip this restriction, and fields without ExcelColumn annotations will be matched with field name
    
    返回:
    
    this Sheet
  - headerColumnIgnoreCase
```
default Sheet headerColumnIgnoreCase()
```
    Settings ignore case matching column names
    
    返回:
    
    this Sheet
  - headerColumnToCamelCase
```
default Sheet headerColumnToCamelCase()
```
    Convert column name to camel case
    
    返回:
    
    this Sheet
  - addHeaderColumnReadOption
```
default Sheet addHeaderColumnReadOption(int option)
```
    Add header columns preprocessing properties
    
    参数:
    
    option - header column options
    
    返回:
    
    this Sheet
  - setHeaderColumnReadOption
```
Sheet setHeaderColumnReadOption(int option)
```
    Setting header columns preprocessing properties
    - HeaderRow.FORCE_IMPORT: Match with field name if without ExcelColumn annotation
    - HeaderRow.IGNORE_CASE: Ignore case matching column names
    - HeaderRow.CAMEL_CASE: CAMEL_CASE to camelCase
    reader.sheet(0).setHeaderColumnReadOption(HeaderRow.FORCE_IMPORT | HeaderRow.IGNORE_CASE)
    参数:
    
    option - header column options
    
    返回:
    
    this Sheet
  - getHeaderColumnReadOption
```
int getHeaderColumnReadOption()
```
    Returns Header column options
    
    返回:
    
    this Sheet
  - asSheet
```
Sheet asSheet()
```
    Make worksheets parse value only
    
    返回:
    
    a empty Sheet
  - asCalcSheet
```
CalcSheet asCalcSheet()
```
    Make worksheets parse formulas
    
    返回:
    
    a empty CalcSheet
  - asMergeSheet
```
MergeSheet asMergeSheet()
```
    Make worksheets copy value on merge cells
    
    返回:
    
    a empty MergeSheet

接口 Sheet

方法概要

方法详细资料

getName

getIndex

getId

getSize

getDimension

isHidden

isShow

header

header

getHeader

bind

bind

bind

bind

load

iterator

dataIterator

listPictures

createRow

reset

rows

dataRows

col2Int

close

saveAsCSV

saveAsCSV

saveAsCSV

saveAsCSV

saveAsCSV

forceImport

headerColumnIgnoreCase

headerColumnToCamelCase

addHeaderColumnReadOption

setHeaderColumnReadOption

getHeaderColumnReadOption

asSheet

asCalcSheet

asMergeSheet