Workbook (Excel Write/Read Framework 0.5.4 API)

java.lang.Object
- org.ttzero.excel.entity.Workbook

所有已实现的接口:

Storable
```
public class Workbook
extends Object
implements Storable
```
The workbook is the basic unit of Excel, and an 'xlsx' or 'xls' file corresponds to a workbook instance.
When writing an Excel file, you must setting the property first and then add Sheet into Workbook, finally call the writeTo(java.nio.file.Path) method to perform the write operation. The default file format is open-xml(xlsx). You can also call the saveAsExcel2003() method to output as 'xls' format (only supported BIFF8 format, ie excel 97~2003).
The property contains setName(String), setCreator(String), setCompany(String), setAutoSize(boolean) and setOddFill(Fill) You can also call setWorkbookWriter(IWorkbookWriter) method to setting a custom WorkbookWriter to achieve special demand.
The writeTo(java.nio.file.Path) method is a terminating statement, and all settings placed after this statement will not be reflected in the final Excel file.
A typical example as follow:
```
 new Workbook("{name}", "{author}")
     // Print debug logs
     .watch(System.out::println)
     // Auto size the column width
     .setAutoSize(true)
     // Add a Worksheet
     .addSheet(new ListSheet<ListObjectSheetTest.Item>("{worksheet name}").setData(new ArrayList<>()))
     // Add an other Worksheet
     .addSheet(new ListMapSheet("{worksheet name}").setData(new ArrayList<>()))
     // Write to absolute path '/tmp/{name}.xlsx'
     .writeTo(Paths.get("/tmp/"));
```
Some referer links: POI | Office 365 | DocumentFormat.OpenXml.Spreadsheet Namespace | 介绍 Microsoft Office (2007) Open XML 文件格式
作者:

guanquan.wang on 2017/9/26.

构造器概要

构造器
构造器和说明
`Workbook()` Create a unnamed workbook EEC finds the 'non-name-file' keyword under the `resources/I18N/message.XXX.properties` file first.
`Workbook(String name)` Create a workbook with the specified name.
`Workbook(String name, String creator)` Create a workbook with the specified name and author.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Workbook`	`addSheet(List<?> data, Column... columns)` Add a `ListSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(PreparedStatement ps, Column... columns)` Add a `StatementSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(PreparedStatement ps, ParamProcessor pp, Column... columns)` Add a `StatementSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(ResultSet rs, Column... columns)` Add a `ResultSetSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(Sheet sheet)` Add a `Sheet` to the tail
`Workbook`	`addSheet(String sql, Column... columns)` Add a `StatementSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(String name, List<?> data, Column... columns)` Add a `ListSheet` to the tail with Worksheet name and header `Column` setting.
`Workbook`	`addSheet(String sql, ParamProcessor pp, Column... columns)` Add a `StatementSheet` to the tail with header `Column` setting.
`Workbook`	`addSheet(String name, PreparedStatement ps, Column... columns)` Add a `StatementSheet` to the tail with worksheet name and header `Column` setting.
`Workbook`	`addSheet(String name, PreparedStatement ps, ParamProcessor pp, Column... columns)` Add a `StatementSheet` to the tail with worksheet name and header `Column` setting.
`Workbook`	`addSheet(String name, ResultSet rs, Column... columns)` Add a `ResultSetSheet` to the tail with worksheet name and header `Column` setting.
`Workbook`	`addSheet(String name, String sql, Column... columns)` Add a `StatementSheet` to the tail with worksheet name and header `Column` setting.
`Workbook`	`addSheet(String name, String sql, ParamProcessor pp, Column... columns)` Add a `StatementSheet` to the tail with worksheet name and header `Column` setting.
`Workbook`	`cancelOddFill()` Cancel the odd-fill style
`protected void`	`checkAndInitWriter()` Check and Create `IWorkbookWriter`
`Workbook`	`forceExport()` Force export of attributes without `ExcelColumn` annotations
`int`	`getAutoOdd()` Returns the autoOdd setting
`Object`	`getBind()` Returns the replacement object
`String`	`getCompany()` Returns the company name where the author is employed
`Core`	`getCore()` Returns the basic information about workbook
`String`	`getCreator()` Returns the excel author
`int`	`getForceExport()` Returns the force export
`I18N`	`getI18N()` Returns the `I18N` util
`String`	`getName()` Returns the workbook name
`Fill`	`getOddFill()` Returns the odd-fill style
`Sheet`	`getSheet(String sheetName)` Return a `Sheet` with the specified name Note: This method can only return the `Sheet` which name specified when created.
`Sheet`	`getSheetAt(int index)` Returns the Sheet of the specified index
`Sheet[]`	`getSheets()` Returns all `Sheet` in this workbook
`int`	`getSize()` Returns the size of `Sheet` in this workbook
`SharedStrings`	`getSst()` Returns the Shared String Table
`Styles`	`getStyles()` Returns the global `Styles`
`InputStream`	`getTemplate()` Returns the template io-stream
`WaterMark`	`getWaterMark()` Returns the `WaterMark`
`IWorkbookWriter`	`getWorkbookWriter()` Returns the `IWorkbookWriter`
`protected void`	`init()` Create some global entry.
`Workbook`	`insertSheet(int index, Sheet sheet)` Insert a `Sheet` at the specified index
`boolean`	`isAutoSize()` Returns whether to auto-adjust the column width
`Workbook`	`remove(int index)` Remove the `Sheet` from the specified index
`Workbook`	`saveAsCSV()` Save file as Comma-Separated Values.
`Workbook`	`saveAsExcel2003()` Save as excel97~2003 You mast add eec-e3-support.jar into class path to support excel97~2003
`Workbook`	`setAutoSize(boolean autoSize)` Setting auto-adjust the column width
`Workbook`	`setCompany(String company)` Setting the name of the company where the author is employed
`Workbook`	`setConnection(Connection con)` Setting the database `Connection` EEC does not actively close the database connection, and needs to be manually closed externally.
`Workbook`	`setCore(Core core)` Setting basic information,such as title, subject, keyword, category...
`Workbook`	`setCreator(String creator)` Setting the excel author name.
`Workbook`	`setName(String name)` Setting the workbook name
`Workbook`	`setOddFill(Fill fill)` Setting the odd-fill style, default fill color is #E2EDDA
`Workbook`	`setWaterMark(WaterMark waterMark)` Setting `WaterMark` Use `WaterMark.of(java.lang.String)` method to create a water mark.
`Workbook`	`setWorkbookWriter(IWorkbookWriter workbookWriter)` Setting a customize workbook writer
`protected Path`	`template()`
`Workbook`	`watch(Watch watch)` Setting a `Watch`
`void`	`what(String code)` Output the export detail info
`void`	`what(String code, String... args)` Output export detail info
`Workbook`	`withTemplate(InputStream is, Object o)` Bind a excel template and set an object to replace the placeholder character in template
`void`	`writeTo(File file)` Export the workbook to the specified folder
`void`	`writeTo(OutputStream os)` Export the workbook to the specified `OutputStream`.
`void`	`writeTo(Path path)` Export the workbook to the specified folder If the path is a folder, save the workbook to that folder, if there has duplicate file name, add '(n)' after the output file name to avoid overwriting the original file.

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

- 构造器详细资料
  - Workbook
```
public Workbook()
```
    Create a unnamed workbook EEC finds the 'non-name-file' keyword under the resources/I18N/message.XXX.properties file first. If there contains the keyword, use this value as the default file name, otherwise use 'Non name' as the name.
  - Workbook
```
public Workbook(String name)
```
    Create a workbook with the specified name. Use this name as the file name when saving to disk
    
    参数:
    
    name - the workbook name
  - Workbook
```
public Workbook(String name,
                String creator)
```
    Create a workbook with the specified name and author.
    
    参数:
    
    name - the workbook name
    
    creator - the author, it will getting the System.getProperty("user.name") if it not be setting.
- 方法详细资料
  - getName
```
public String getName()
```
    Returns the workbook name
    
    返回:
    
    the workbook name
  - setName
```
public Workbook setName(String name)
```
    Setting the workbook name
    
    参数:
    
    name - the workbook name
    
    返回:
    
    the Workbook
  - getAutoOdd
```
public int getAutoOdd()
```
    Returns the autoOdd setting
    
    返回:
    
    1 if odd-fill
  - getCreator
```
public String getCreator()
```
    Returns the excel author
    
    返回:
    
    the author
  - getCompany
```
public String getCompany()
```
    Returns the company name where the author is employed
    
    返回:
    
    the company name
  - getOddFill
```
public Fill getOddFill()
```
    Returns the odd-fill style
    
    返回:
    
    the Fill style
  - getI18N
```
public I18N getI18N()
```
    Returns the I18N util
    
    返回:
    
    the I18N util
  - getSize
```
public int getSize()
```
    Returns the size of Sheet in this workbook
    
    返回:
    
    ths size of Worksheet
  - getCore
```
public Core getCore()
```
    Returns the basic information about workbook
    
    返回:
    
    the Core instance
  - setCore
```
public Workbook setCore(Core core)
```
    Setting basic information,such as title, subject, keyword, category...
    
    参数:
    
    core - the Core instance
    
    返回:
    
    ths size of Worksheet
  - getSst
```
public SharedStrings getSst()
```
    Returns the Shared String Table
    
    返回:
    
    the global SharedStrings
  - getSheets
```
public final Sheet[] getSheets()
```
    Returns all Sheet in this workbook
    
    返回:
    
    array of Sheet
  - getWaterMark
```
public WaterMark getWaterMark()
```
    Returns the WaterMark
    
    返回:
    
    the Workbook
  - setWaterMark
```
public Workbook setWaterMark(WaterMark waterMark)
```
    Setting WaterMark
    Use WaterMark.of(java.lang.String) method to create a water mark.
    
    参数:
    
    waterMark - the water mark
    
    返回:
    
    the Workbook
  - setConnection
```
public Workbook setConnection(Connection con)
```
    Setting the database Connection
    EEC does not actively close the database connection, and needs to be manually closed externally. The Statement and ResultSet generated inside this EEC will be actively closed.
    
    参数:
    
    con - the database connection
    
    返回:
    
    the Workbook
  - setAutoSize
```
public Workbook setAutoSize(boolean autoSize)
```
    Setting auto-adjust the column width
    
    参数:
    
    autoSize - boolean value
    
    返回:
    
    the Workbook
  - isAutoSize
```
public boolean isAutoSize()
```
    Returns whether to auto-adjust the column width
    
    返回:
    
    true if auto-adjust the column width
  - forceExport
```
public Workbook forceExport()
```
    Force export of attributes without ExcelColumn annotations
    
    返回:
    
    the Workbook
  - getForceExport
```
public int getForceExport()
```
    Returns the force export
    
    返回:
    
    1 if force, otherwise returns 0
  - getStyles
```
public Styles getStyles()
```
    Returns the global Styles
    
    返回:
    
    the Styles
  - setCreator
```
public Workbook setCreator(String creator)
```
    Setting the excel author name.
    If you do not set the creator it will get the current OS login user name, usually this is not a good idea. Applications are usually publish on server or cloud server, getting the system login user name doesn't make sense. If you don't want to set it and default setting the system login user name, you can set it to an empty string ("").
    Does anyone agree with this idea? If anyone agrees, I will consider removing this setting.
    
    参数:
    
    creator - the author name
    
    返回:
    
    the Workbook
  - setCompany
```
public Workbook setCompany(String company)
```
    Setting the name of the company where the author is employed
    
    参数:
    
    company - the company name
    
    返回:
    
    the Workbook
  - cancelOddFill
```
public Workbook cancelOddFill()
```
    Cancel the odd-fill style
    
    返回:
    
    the Workbook
  - setOddFill
```
public Workbook setOddFill(Fill fill)
```
    Setting the odd-fill style, default fill color is #E2EDDA
    
    参数:
    
    fill - the Fill style
    
    返回:
    
    the Workbook
  - getWorkbookWriter
```
public IWorkbookWriter getWorkbookWriter()
```
    Returns the IWorkbookWriter
    
    返回:
    
    the workbook writer
  - addSheet
```
public Workbook addSheet(Sheet sheet)
```
    Add a Sheet to the tail
    
    参数:
    
    sheet - a Worksheet
    
    返回:
    
    the Workbook
  - addSheet
```
public Workbook addSheet(List<?> data,
                         Column... columns)
```
    Add a ListSheet to the tail with header Column setting. Also you can use addSheet(new ListSheet<>(data, columns) to achieve the same effect.
    
    参数:
    
    data - List<?> data
    
    columns - the header columns
    
    返回:
    
    the Workbook
  - addSheet
```
public Workbook addSheet(String name,
                         List<?> data,
                         Column... columns)
```
    Add a ListSheet to the tail with Worksheet name and header Column setting. Also you can use addSheet(new ListSheet<>(name, data, columns) to achieve the same effect.
    
    参数:
    
    name - the name of worksheet
    
    data - List<?> data
    
    columns - the header columns
    
    返回:
    
    the Workbook
  - addSheet
```
public Workbook addSheet(ResultSet rs,
                         Column... columns)
```
    Add a ResultSetSheet to the tail with header Column setting. Also you can use addSheet(new ResultSetSheet(rs, columns) to achieve the same effect.
    
    参数:
    
    rs - the ResultSet
    
    columns - the header columns
    
    返回:
    
    the Workbook
  - addSheet
```
public Workbook addSheet(String name,
                         ResultSet rs,
                         Column... columns)
```
    Add a ResultSetSheet to the tail with worksheet name and header Column setting. Also you can use addSheet(new ResultSetSheet(name, rs, columns)
    
    参数:
    
    name - the worksheet name
    
    rs - the ResultSet
    
    columns - the header columns
    
    返回:
    
    the Workbook
  - addSheet
```
public Workbook addSheet(String sql,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with header Column setting. Also you can use addSheet(new StatementSheet(connection, sql, columns) to achieve the same effect.
    
    参数:
    
    sql - the query SQL string
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(String name,
                         String sql,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with worksheet name and header Column setting. Also you can use addSheet(new StatementSheet(name, connection, sql, columns) to achieve the same effect.
    
    参数:
    
    name - the worksheet name
    
    sql - the query SQL string
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(String sql,
                         ParamProcessor pp,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with header Column setting. The ParamProcessor is a sql parameter replacement function-interface to replace "?" in the sql string.
    Also you can use addSheet(new StatementSheet(connection, sql, paramProcessor, columns) to achieve the same effect.
    workbook.addSheet("users", "select id, name from users where `class` = ?" , ps -> ps.setString(1, "middle") ...
    参数:
    
    sql - the query SQL string
    
    pp - the sql parameter replacement function-interface
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(String name,
                         String sql,
                         ParamProcessor pp,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with worksheet name and header Column setting. The ParamProcessor is a sql parameter replacement function-interface to replace "?" in the sql string.
    Also you can use addSheet(new StatementSheet(name, connection, sql, paramProcessor, columns) to achieve the same effect.
    workbook.addSheet("users", "select id, name from users where `class` = ?" , ps -> ps.setString(1, "middle") ...
    参数:
    
    name - the worksheet name
    
    sql - the query SQL string
    
    pp - the sql parameter replacement function-interface
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(PreparedStatement ps,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with header Column setting. Also you can use addSheet(new StatementSheet(null, columns).setPs(ps) to achieve the same effect.
    
    参数:
    
    ps - the PreparedStatement
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(String name,
                         PreparedStatement ps,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with worksheet name and header Column setting. Also you can use addSheet(new StatementSheet(name, columns).setPs(ps) to achieve the same effect.
    
    参数:
    
    name - the worksheet name
    
    ps - the PreparedStatement
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(PreparedStatement ps,
                         ParamProcessor pp,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with header Column setting.
    
    参数:
    
    ps - the PreparedStatement
    
    pp - the sql parameter replacement function-interface
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - addSheet
```
public Workbook addSheet(String name,
                         PreparedStatement ps,
                         ParamProcessor pp,
                         Column... columns)
                  throws SQLException
```
    Add a StatementSheet to the tail with worksheet name and header Column setting.
    workbook.addSheet("users", ps, ps -> ps.setString(1, "middle") ...
    参数:
    
    name - the worksheet name
    
    ps - PreparedStatement
    
    pp - the sql parameter replacement function-interface
    
    columns - the header columns
    
    返回:
    
    the Workbook
    
    抛出:
    
    SQLException - if a database access error occurs
  - insertSheet
```
public Workbook insertSheet(int index,
                            Sheet sheet)
```
    Insert a Sheet at the specified index
    
    参数:
    
    index - the index (zero-base) to insert at
    
    sheet - a worksheet
    
    返回:
    
    the Workbook
  - remove
```
public Workbook remove(int index)
```
    Remove the Sheet from the specified index
    
    参数:
    
    index - the index (zero-base) to be delete
    
    返回:
    
    the Workbook
  - getSheetAt
```
public Sheet getSheetAt(int index)
```
    Returns the Sheet of the specified index
    
    参数:
    
    index - the index (zero-base)
    
    返回:
    
    the Sheet
    
    抛出:
    
    IndexOutOfBoundsException - if index is negative number or greater than the worksheet size in current workbook
  - getSheet
```
public Sheet getSheet(String sheetName)
```
    Return a Sheet with the specified name
    Note: This method can only return the Sheet which name specified when created.
    
    参数:
    
    sheetName - the sheet name
    
    返回:
    
    the Sheet, returns null if not found
  - watch
```
public Workbook watch(Watch watch)
```
    Setting a Watch
    
    参数:
    
    watch - a debug watch
    
    返回:
    
    the Workbook
  - saveAsExcel2003
```
public Workbook saveAsExcel2003()
                         throws OperationNotSupportedException
```
    Save as excel97~2003
    You mast add eec-e3-support.jar into class path to support excel97~2003
    
    返回:
    
    the Workbook
    
    抛出:
    
    OperationNotSupportedException - if eec-e3-support not import into class path
  - saveAsCSV
```
public Workbook saveAsCSV()
```
    Save file as Comma-Separated Values. Each worksheet corresponds to a csv file. Default charset is 'UTF8' and separator character is ','.
    
    返回:
    
    the Workbook
  - what
```
public void what(String code)
```
    Output the export detail info
    
    参数:
    
    code - the message code in message properties file
  - what
```
public void what(String code,
                 String... args)
```
    Output export detail info
    
    参数:
    
    code - the message code in message properties file
    
    args - the placeholder values
  - writeTo
```
public void writeTo(Path path)
             throws IOException
```
    Export the workbook to the specified folder
    If the path is a folder, save the workbook to that folder, if there has duplicate file name, add '(n)' after the output file name to avoid overwriting the original file. If it is a file, overwrite the file.
    
    指定者:
    
    writeTo 在接口中 Storable
    
    参数:
    
    path - the output pat, It can be a directory or a full file path
    
    抛出:
    
    IOException - if I/O error occur
  - writeTo
```
public void writeTo(OutputStream os)
             throws IOException,
                    ExcelWriteException
```
    Export the workbook to the specified OutputStream. It mostly used for small excel file export and download
    public void export(HttpServletResponse response) throws IOException { String fileName = java.net.URLEncoder.encode("{name}.xlsx", "UTF-8"); response.setHeader(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + fileName + "\"; filename*=utf-8''" + fileName); new Workbook("{name}", "{author}") .setAutoSize(true) .addSheet(new ListSheet<ListObjectSheetTest.Item>("{worksheet name}", new ArrayList<>())) // Write to HttpServletResponse .writeTo(response.getOutputStream()); }
    参数:
    
    os - the OutputStream
    
    抛出:
    
    IOException - if I/O error occur
    
    ExcelWriteException - other runtime error
  - writeTo
```
public void writeTo(File file)
             throws IOException,
                    ExcelWriteException
```
    Export the workbook to the specified folder
    
    参数:
    
    file - the output file name
    
    抛出:
    
    IOException - if I/O error occur
    
    ExcelWriteException - other runtime error
  - getTemplate
```
public InputStream getTemplate()
```
    Returns the template io-stream
    
    返回:
    
    the io-stream of template
  - getBind
```
public Object getBind()
```
    Returns the replacement object
    
    返回:
    
    the object
  - withTemplate
```
public Workbook withTemplate(InputStream is,
                             Object o)
```
    Bind a excel template and set an object to replace the placeholder character in template
    
    参数:
    
    is - the template io-stream
    
    o - bind a replacement object
    
    返回:
    
    the Workbook
  - template
```
protected Path template()
                 throws IOException
```
    抛出:
    
    IOException
  - setWorkbookWriter
```
public Workbook setWorkbookWriter(IWorkbookWriter workbookWriter)
```
    Setting a customize workbook writer
    
    参数:
    
    workbookWriter - a customize IWorkbookWriter
    
    返回:
    
    the Workbook
  - init
```
protected void init()
```
    Create some global entry.
  - checkAndInitWriter
```
protected void checkAndInitWriter()
```
    Check and Create IWorkbookWriter

类 Workbook

构造器概要

方法概要

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

构造器详细资料

Workbook

Workbook

Workbook

方法详细资料

getName

setName

getAutoOdd

getCreator

getCompany

getOddFill

getI18N

getSize

getCore

setCore

getSst

getSheets

getWaterMark

setWaterMark

setConnection

setAutoSize

isAutoSize

forceExport

getForceExport

getStyles

setCreator

setCompany

cancelOddFill

setOddFill

getWorkbookWriter

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

addSheet

insertSheet

remove

getSheetAt

getSheet

watch

saveAsExcel2003

saveAsCSV

what

what

writeTo

writeTo

writeTo

getTemplate

getBind

withTemplate

template

setWorkbookWriter

init

checkAndInitWriter