improved javadoc on SXSSFWorkbook(XSSFWorkbook wb)

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1241373 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yegor Kozlov 2012-02-07 08:17:21 +00:00
parent 16ea202e52
commit 465974f540
1 changed files with 36 additions and 1 deletions

View File

@ -78,6 +78,41 @@ public class SXSSFWorkbook implements Workbook
this(null /*workbook*/);
}
/**
* Construct a workbook from a template.
* <p>
* There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
* <ol>
* <li>
* Append new sheets to existing workbooks. You can open existing
* workbook from a file or create on the fly with XSSF.
* </li>
* <li>
* Append rows to existing sheets. The row number MUST be greater
* than max(rownum) in the template sheet.
* </li>
* <li>
* Use existing workbook as a template and re-use global objects such
* as cell styles, formats, images, etc.
* </li>
* </ol>
* All three use cases can work in a combination.
* </p>
* What is not supported:
* <ul>
* <li>
* Access initial cells and rows in the template. After constructing
* SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and
* SXSSFSheet@getRow and SXSSFRow#getCell return null.
* </li>
* <li>
* Override existing cells and rows. The API silently allows that but
* the output file is invalid and Excel cannot read it.
* </li>
* </ul>
*
* @param workbook the template workbook
*/
public SXSSFWorkbook(XSSFWorkbook workbook){
this(workbook, DEFAULT_WINDOW_SIZE);
}