XMLSheet (Excel Write/Read Framework 0.5.25 API)

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

所有已实现的接口:

Closeable, AutoCloseable, Sheet
```
public class XMLSheet
extends Object
implements Sheet
```
The open-xml format Worksheet

作者:

guanquan.wang on 2018-09-22

嵌套类概要

嵌套类
限定符和类型类和说明

protected static class XMLSheet.Marker
保存工作表当前状态并担任reset方法还原

嵌套类
限定符和类型	类和说明
`protected static class`	`XMLSheet.Marker` 保存工作表当前状态并担任reset方法还原

字段概要

字段
限定符和类型	字段和说明
`protected char[]`	`cb`
`protected Dimension`	`dimension`
`protected Drawings`	`drawings`
`protected ZipEntry`	`entry`
`protected boolean`	`eof`
`protected HeaderRow`	`header`
`protected boolean`	`heof`
`protected boolean`	`hidden`
`protected int`	`hrf`
`protected int`	`hrl`
`protected int`	`id`
`protected int`	`index`
`protected long`	`lastRowMark`
`protected int`	`length`
`protected long`	`mark`
`protected String`	`name`
`protected int`	`nChar`
`protected int`	`option`
`protected String`	`path`
`protected Reader`	`reader`
`protected RelManager`	`relManager`
`protected XMLRow`	`sRow`
`protected SharedStrings`	`sst` The Shared String Table
`protected int`	`startRow` 已过时。未使用，下个版本删除
`protected Styles`	`styles` The `Styles`
`protected boolean`	`useCurrentRow`
`protected ZipFile`	`zipFile`

构造器概要

构造器
构造器和说明

XMLSheet()

XMLSheet(XMLSheet sheet)

构造器
构造器和说明
`XMLSheet()`
`XMLSheet(XMLSheet sheet)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`FullSheet`	`asFullSheet()` 将工作表转为`FullSheet`支持全属性读取
`XMLSheet`	`asSheet()` 将工作表转为普通工作表`Sheet`，它只专注获取值
`XMLSheet`	`bind(Class<?> clazz)` Set the binding type
`Sheet`	`bind(Class<?> clazz, Row row)` 绑定数据类型并指定表头，后续可以通过`Row.get()`方法直接将行数据转为指定的对象
`void`	`close()` close reader
`protected Row`	`createHeader(char[] cb, int start, int n)`
`XMLRow`	`createRow()`
`Iterator<Row>`	`dataIterator()` Iterating over data rows without header information and blank lines
`protected Row`	`findRow0()`
`Dimension`	`getDimension()` Returns The range address of the used area in the current sheet NOTE: This method can only guarantee accurate row ranges
`int`	`getFirstRow()` 已过时。无效方法后续删除
`Row`	`getHeader()` Returns the header of the list.
`protected Row`	`getHeader(int fromRowNum, int toRowNum)`
`int`	`getHeaderColumnReadOption()` Returns Header column options
`int`	`getId()` Returns the worksheet id
`int`	`getIndex()` The index of worksheet located at the workbook
`String`	`getName()` The worksheet name
`RelManager`	`getRelManager()` 获取关系管理器
`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.
`boolean`	`isHidden()` Test Worksheet is hidden
`Iterator<Row>`	`iterator()` Iterating each row of data contains header information and blank lines
`List<Drawings.Picture>`	`listPictures()` List all pictures in workbook
`XMLSheet`	`load()` 加载sheet.xml并解析头信息，如果已加载则直接跳到标记位
`protected XMLRow`	`nextRow()` iterator rows
`protected void`	`parseBOF()`
`protected Dimension`	`parseDimension()`
`XMLSheet`	`reset()` Reset the `XMLSheet`'s row index to begging
`protected void`	`setDrawings(Drawings drawings)` Setting the `Drawings` info
`Sheet`	`setHeaderColumnReadOption(int option)` Setting header columns preprocessing properties
`protected void`	`setId(int id)` Setting id of worksheet
`protected void`	`setIndex(int index)`
`protected void`	`setName(String name)` Setting the worksheet name
`protected void`	`setPath(String path)` Setting the worksheet xml path
`protected void`	`setSharedStrings(SharedStrings sst)` Setting the Shared String Table
`protected void`	`setStyles(Styles styles)` Setting `Styles`
`protected void`	`setZipEntry(ZipEntry entry)` Setting the worksheet zip entry
`protected void`	`setZipFile(ZipFile zipFile)` Setting the source zip file
`protected void`	`subElement(char[] cb, int offset, int n)`
`String`	`toString()`

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

从接口继承的方法 org.ttzero.excel.reader.Sheet
addHeaderColumnReadOption, asCalcSheet, asMergeSheet, bind, bind, dataRows, forceImport, getSize, header, headerColumnIgnoreCase, headerColumnToCamelCase, isShow, rows, saveAsCSV, saveAsCSV, saveAsCSV, saveAsCSV, saveAsCSV

- 字段详细资料
  - name
```
protected String name
```
  - index
```
protected int index
```
  - path
```
protected String path
```
  - id
```
protected int id
```
  - sst
```
protected SharedStrings sst
```
    The Shared String Table
  - styles
```
protected Styles styles
```
    The Styles
  - startRow
```
@Deprecated
protected int startRow
```
    已过时。未使用，下个版本删除
  - header
```
protected HeaderRow header
```
  - hidden
```
protected boolean hidden
```
  - useCurrentRow
```
protected boolean useCurrentRow
```
  - dimension
```
protected Dimension dimension
```
  - drawings
```
protected Drawings drawings
```
  - hrf
```
protected int hrf
```
  - hrl
```
protected int hrl
```
  - zipFile
```
protected ZipFile zipFile
```
  - entry
```
protected ZipEntry entry
```
  - option
```
protected int option
```
  - relManager
```
protected RelManager relManager
```
  - reader
```
protected Reader reader
```
  - cb
```
protected char[] cb
```
  - nChar
```
protected int nChar
```
  - length
```
protected int length
```
  - eof
```
protected boolean eof
```
  - heof
```
protected boolean heof
```
  - mark
```
protected long mark
```
  - sRow
```
protected XMLRow sRow
```
  - lastRowMark
```
protected long lastRowMark
```
- 构造器详细资料
  - XMLSheet
```
public XMLSheet()
```
  - XMLSheet
```
public XMLSheet(XMLSheet sheet)
```
- 方法详细资料
  - setName
```
protected void setName(String name)
```
    Setting the worksheet name
    
    参数:
    
    name - the worksheet name
  - setPath
```
protected void setPath(String path)
```
    Setting the worksheet xml path
    
    参数:
    
    path - the temp path
  - setZipFile
```
protected void setZipFile(ZipFile zipFile)
```
    Setting the source zip file
    
    参数:
    
    zipFile - source data
  - setZipEntry
```
protected void setZipEntry(ZipEntry entry)
```
    Setting the worksheet zip entry
    
    参数:
    
    entry - source data
  - setSharedStrings
```
protected void setSharedStrings(SharedStrings sst)
```
    Setting the Shared String Table
    
    参数:
    
    sst - the SharedStrings
  - setStyles
```
protected void setStyles(Styles styles)
```
    Setting Styles
    
    参数:
    
    styles - the Styles
  - getName
```
public String getName()
```
    The worksheet name
    
    指定者:
    
    getName 在接口中 Sheet
    
    返回:
    
    the sheet name
  - getIndex
```
public int getIndex()
```
    The index of worksheet located at the workbook
    
    指定者:
    
    getIndex 在接口中 Sheet
    
    返回:
    
    the index(zero base)
  - setIndex
```
protected void setIndex(int index)
```
  - getId
```
public int getId()
```
    Returns the worksheet id
    
    指定者:
    
    getId 在接口中 Sheet
    
    返回:
    
    int value
  - setId
```
protected void setId(int id)
```
    Setting id of worksheet
    
    参数:
    
    id - the id of worksheet
  - setDrawings
```
protected void setDrawings(Drawings drawings)
```
    Setting the Drawings info
    
    参数:
    
    drawings - resource info
  - getDimension
```
public Dimension getDimension()
```
    Returns The range address of the used area in the current sheet
    NOTE: This method can only guarantee accurate row ranges
    
    指定者:
    
    getDimension 在接口中 Sheet
    
    返回:
    
    worksheet Dimension ranges
  - getFirstRow
```
@Deprecated
public int getFirstRow()
```
    已过时。无效方法后续删除
    
    The index of first used row
    
    返回:
    
    the index
  - isHidden
```
public boolean isHidden()
```
    Test Worksheet is hidden
    
    指定者:
    
    isHidden 在接口中 Sheet
    
    返回:
    
    true: if current sheet is hidden
  - header
```
public 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), Sheet.bind(Class, int), Sheet.bind(Class, int, int), Sheet.rows(), Sheet.dataRows(), iterator(), and dataIterator() will all be affected.
    
    指定者:
    
    header 在接口中 Sheet
    
    参数:
    
    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
```
public Row getHeader()
```
    Returns the header of the list. The first non-empty line defaults to the header information.
    
    指定者:
    
    getHeader 在接口中 Sheet
    
    返回:
    
    the HeaderRow
  - getHeader
```
protected Row getHeader(int fromRowNum,
                        int toRowNum)
```
  - bind
```
public XMLSheet bind(Class<?> clazz)
```
    Set the binding type
    
    指定者:
    
    bind 在接口中 Sheet
    
    参数:
    
    clazz - the binding type
    
    返回:
    
    sheet
  - bind
```
public Sheet bind(Class<?> clazz,
                  Row row)
```
    从接口复制的说明: Sheet
    
    绑定数据类型并指定表头，后续可以通过Row.get()方法直接将行数据转为指定的对象
    
    指定者:
    
    bind 在接口中 Sheet
    
    参数:
    
    clazz - 行数据需要转换的对象类型
    
    row - 自定义表头
    
    返回:
    
    当前工作表
  - getRelManager
```
public RelManager getRelManager()
```
    获取关系管理器
    
    返回:
    
    关系管理器实例
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - load
```
public XMLSheet load()
              throws IOException
```
    加载sheet.xml并解析头信息，如果已加载则直接跳到标记位
    
    指定者:
    
    load 在接口中 Sheet
    
    返回:
    
    Sheet
    
    抛出:
    
    IOException - if io error occur
  - parseBOF
```
protected void parseBOF()
                 throws IOException
```
    抛出:
    
    IOException
  - nextRow
```
protected XMLRow nextRow()
```
    iterator rows
    
    返回:
    
    Row
  - findRow0
```
protected Row findRow0()
```
  - iterator
```
public Iterator<Row> iterator()
```
    Iterating each row of data contains header information and blank lines
    
    指定者:
    
    iterator 在接口中 Sheet
    
    返回:
    
    a row iterator
  - dataIterator
```
public Iterator<Row> dataIterator()
```
    Iterating over data rows without header information and blank lines
    
    指定者:
    
    dataIterator 在接口中 Sheet
    
    返回:
    
    a row iterator
  - listPictures
```
public List<Drawings.Picture> listPictures()
```
    List all pictures in workbook
    
    指定者:
    
    listPictures 在接口中 Sheet
    
    返回:
    
    picture list or null if not exists.
  - close
```
public void close()
           throws IOException
```
    close reader
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException - if io error occur
  - setHeaderColumnReadOption
```
public Sheet setHeaderColumnReadOption(int option)
```
    Setting header columns preprocessing properties
    
    指定者:
    
    setHeaderColumnReadOption 在接口中 Sheet
    
    参数:
    
    option - 额外属性
    
    返回:
    
    this Sheet
  - getHeaderColumnReadOption
```
public int getHeaderColumnReadOption()
```
    Returns Header column options
    
    指定者:
    
    getHeaderColumnReadOption 在接口中 Sheet
    
    返回:
    
    this Sheet
  - reset
```
public XMLSheet reset()
```
    Reset the XMLSheet's row index to begging
    
    指定者:
    
    reset 在接口中 Sheet
    
    返回:
    
    the unread XMLSheet
  - createRow
```
public XMLRow createRow()
```
  - parseDimension
```
protected Dimension parseDimension()
```
  - subElement
```
protected void subElement(char[] cb,
                          int offset,
                          int n)
```
  - createHeader
```
protected Row createHeader(char[] cb,
                           int start,
                           int n)
```
  - asSheet
```
public XMLSheet asSheet()
```
    从接口复制的说明: Sheet
    
    将工作表转为普通工作表Sheet，它只专注获取值
    
    指定者:
    
    asSheet 在接口中 Sheet
    
    返回:
    
    Sheet
  - asFullSheet
```
public FullSheet asFullSheet()
```
    从接口复制的说明: Sheet
    
    将工作表转为FullSheet支持全属性读取
    
    指定者:
    
    asFullSheet 在接口中 Sheet
    
    返回:
    
    FullSheet

类 XMLSheet

嵌套类概要

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.ttzero.excel.reader.Sheet

字段详细资料

name

index

path

id

sst

styles

startRow

header

hidden

useCurrentRow

dimension

drawings

hrf

hrl

zipFile

entry

option

relManager

reader

cb

nChar

length

eof

heof

mark

sRow

lastRowMark

构造器详细资料

XMLSheet

XMLSheet

方法详细资料

setName

setPath

setZipFile

setZipEntry

setSharedStrings

setStyles

getName

getIndex

setIndex

getId

setId

setDrawings

getDimension

getFirstRow

isHidden

header

getHeader

getHeader

bind

bind

getRelManager

toString

load

parseBOF

nextRow

findRow0

iterator

dataIterator

listPictures

close

setHeaderColumnReadOption

getHeaderColumnReadOption

reset

createRow

parseDimension

subElement

createHeader

asSheet

asFullSheet