</section>
<anchor id="sxssf"/>
<section><title>SXSSF (Streaming Usermodel API)</title>
- <note>
- SXSSF is a brand new contribution and some features were added after it was first introduced in POI 3.8-beta3.
- Users are advised to try the latest build from trunk. Instructions how to build are <link href="../howtobuild.html">here</link>.
- </note>
<p>
SXSSF (package: org.apache.poi.xssf.streaming) is an API-compatible streaming extension of XSSF to be used when
very large spreadsheets have to be produced, and heap space is limited.
records that have not been flushed by a call to flushRows() are available
for random access.
</p>
+ <p>
+ Note that SXSSF allocates temporary files that you <strong>must</strong> always clean up explicitly, by calling the dispose method.
+ </p>
<p> The example below writes a sheet with a window of 100 rows. When the row count reaches 101,
the row with rownum=0 is flushed to disk and removed from memory, when rownum reaches 102 then the row with rownum=1 is flushed, etc.
</p>
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
public static void main(String[] args) throws Throwable {
- Workbook wb = new SXSSFWorkbook(100); // keep 100 rows in memory, exceeding rows will be flushed to disk
+ SXSSFWorkbook wb = new SXSSFWorkbook(100); // keep 100 rows in memory, exceeding rows will be flushed to disk
Sheet sh = wb.createSheet();
for(int rownum = 0; rownum < 1000; rownum++){
Row row = sh.createRow(rownum);
FileOutputStream out = new FileOutputStream("/temp/sxssf.xlsx");
wb.write(out);
out.close();
+
+ // dispose of temporary files backing this workbook on disk
+ wb.dispose();
}
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
public static void main(String[] args) throws Throwable {
- Workbook wb = new SXSSFWorkbook(-1); // turn off auto-flushing and accumulate all rows in memory
+ SXSSFWorkbook wb = new SXSSFWorkbook(-1); // turn off auto-flushing and accumulate all rows in memory
Sheet sh = wb.createSheet();
for(int rownum = 0; rownum < 1000; rownum++){
Row row = sh.createRow(rownum);
FileOutputStream out = new FileOutputStream("/temp/sxssf.xlsx");
wb.write(out);
out.close();
- }
+
+ // dispose of temporary files backing this workbook on disk
+ wb.dispose();
+ }
]]></source>
wb.setCompressTempFiles(true); // temp files will be gzipped
]]></source>
-
</section>
<anchor id="low_level_api" />
<changes>
<release version="3.9-beta1" date="2012-??-??">
+ <action dev="poi-developers" type="fix">53780 - Fixed memory and temporary file leak in SXSSF </action>
<action dev="poi-developers" type="fix">53380 - ArrayIndexOutOfBounds Excetion parsing word 97 document. </action>
<action dev="poi-developers" type="fix">53434 - Subtotal is not return correct value. </action>
<action dev="poi-developers" type="fix">53642 - [PATCH] XLS formula evaluation logging </action>
*/\r
public File createTempFile()throws IOException {\r
File fd = File.createTempFile("poi-sxssf-sheet-xml", ".gz");\r
- fd.deleteOnExit();\r
return fd;\r
}\r
\r
}
return -1;
}
+
+ /**
+ * Deletes the temporary file that backed this sheet on disk.
+ * @return true if the file was deleted, false if it wasn't.
+ */
+ boolean dispose() {
+ return _writer.dispose();
+ }
}
//Save the template
File tmplFile = File.createTempFile("poi-sxssf-template", ".xlsx");
- tmplFile.deleteOnExit();
- FileOutputStream os = new FileOutputStream(tmplFile);
- _wb.write(os);
- os.close();
-
- //Substitute the template entries with the generated sheet data files
- injectData(tmplFile, stream);
- tmplFile.delete();
+ try
+ {
+ FileOutputStream os = new FileOutputStream(tmplFile);
+ try
+ {
+ _wb.write(os);
+ }
+ finally
+ {
+ os.close();
+ }
+
+ //Substitute the template entries with the generated sheet data files
+ injectData(tmplFile, stream);
+ }
+ finally
+ {
+ tmplFile.delete();
+ }
+ }
+
+ /**
+ * Dispose of temporary files backing this workbook on disk.
+ * Calling this method will render the workbook unusable.
+ * @return true if all temporary files were deleted successfully.
+ */
+ public boolean dispose()
+ {
+ boolean success = true;
+ for (SXSSFSheet sheet : _sxFromXHash.keySet())
+ {
+ success = sheet.dispose() && success;
+ }
+ return success;
}
/**
*/\r
public File createTempFile()throws IOException {\r
File fd = File.createTempFile("poi-sxssf-sheet", ".xml");\r
- fd.deleteOnExit();\r
return fd;\r
}\r
\r
_out.write(chars, last, length - last);\r
}\r
}\r
+\r
+ /**\r
+ * Deletes the temporary file that backed this sheet on disk.\r
+ * @return true if the file was deleted, false if it wasn't.\r
+ */\r
+ boolean dispose() {\r
+ try {\r
+ _out.close();\r
+ return _fd.delete();\r
+ } catch (IOException e){\r
+ return false;\r
+ }\r
+ }\r
}\r
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.util.ArrayList;
/**
* @author Yegor Kozlov
public final class SXSSFITestDataProvider implements ITestDataProvider {
public static final SXSSFITestDataProvider instance = new SXSSFITestDataProvider();
+ private ArrayList<SXSSFWorkbook> instances = new ArrayList<SXSSFWorkbook>();
+
private SXSSFITestDataProvider() {
// enforce singleton
}
public Workbook openSampleWorkbook(String sampleFileName) {
XSSFWorkbook xssfWorkbook = XSSFITestDataProvider.instance.openSampleWorkbook(sampleFileName);
- return new SXSSFWorkbook(xssfWorkbook);
+ SXSSFWorkbook swb = new SXSSFWorkbook(xssfWorkbook);
+ instances.add(swb);
+ return swb;
}
public Workbook writeOutAndReadBack(Workbook wb) {
return result;
}
public SXSSFWorkbook createWorkbook(){
- return new SXSSFWorkbook();
+ SXSSFWorkbook wb = new SXSSFWorkbook();
+ instances.add(wb);
+ return wb;
}
public byte[] getTestDataFileContent(String fileName) {
return POIDataSamples.getSpreadSheetInstance().readFile(fileName);
public String getStandardFileNameExtension() {
return "xlsx";
}
+
+ public synchronized boolean cleanup(){
+ boolean ok = true;
+ for(int i = 0; i < instances.size(); i++){
+ SXSSFWorkbook wb = instances.get(i);
+ ok = ok && wb.dispose();
+ instances.remove(i);
+ }
+ return ok;
+ }
}
super(SXSSFITestDataProvider.instance);
}
+
+ @Override
+ public void tearDown(){
+ SXSSFITestDataProvider.instance.cleanup();
+ }
+
/**
* this test involves evaluation of formulas which isn't supported for SXSSF
*/
Workbook xwb = new XSSFWorkbook();
Cell xCell = xwb.createSheet().createRow(0).createCell(0);
- Workbook swb = new SXSSFWorkbook();
+ Workbook swb = SXSSFITestDataProvider.instance.createWorkbook();
Cell sCell = swb.createSheet().createRow(0).createCell(0);
StringBuffer sb = new StringBuffer();
super(SXSSFITestDataProvider.instance);
}
+
+ @Override
+ public void tearDown(){
+ SXSSFITestDataProvider.instance.cleanup();
+ }
+
}
\ No newline at end of file
super(SXSSFITestDataProvider.instance);
}
+
+ @Override
+ public void tearDown(){
+ SXSSFITestDataProvider.instance.cleanup();
+ }
+
public void testRowBounds() {
baseTestRowBounds(SpreadsheetVersion.EXCEL2007.getLastRowIndex());
}
super(SXSSFITestDataProvider.instance);
}
+
+ @Override
+ public void tearDown(){
+ SXSSFITestDataProvider.instance.cleanup();
+ }
+
+
/**
* cloning of sheets is not supported in SXSSF
*/
import java.io.File;
public final class TestSXSSFWorkbook extends BaseTestWorkbook {
+ public static final SXSSFITestDataProvider _testDataProvider = SXSSFITestDataProvider.instance;
- public TestSXSSFWorkbook() {
- super(SXSSFITestDataProvider.instance);
+ public TestSXSSFWorkbook() {
+ super(_testDataProvider);
}
+ @Override
+ public void tearDown(){
+ _testDataProvider.cleanup();
+ }
+
/**
* cloning of sheets is not supported in SXSSF
*/
"Only XSSFCells can be evaluated.", e.getMessage());
}
}
-
+
public void testExistingWorkbook() {
XSSFWorkbook xssfWorkbook = new XSSFWorkbook();
xssfWorkbook.createSheet("S1");
SXSSFWorkbook wb = new SXSSFWorkbook(xssfWorkbook);
xssfWorkbook = (XSSFWorkbook) SXSSFITestDataProvider.instance.writeOutAndReadBack(wb);
- wb = new SXSSFWorkbook(xssfWorkbook);
+ wb.dispose();
+
+ wb = new SXSSFWorkbook(xssfWorkbook);
assertEquals(1, wb.getNumberOfSheets());
Sheet sheet = wb.getSheetAt(0);
assertNotNull(sheet);
assertEquals("S1", sheet.getSheetName());
+ wb.dispose();
+
}
-
+
public void testAddToExistingWorkbook() {
XSSFWorkbook xssfWorkbook = new XSSFWorkbook();
xssfWorkbook.createSheet("S1");
cell.setCellValue("value 2_1_1");
SXSSFWorkbook wb = new SXSSFWorkbook(xssfWorkbook);
xssfWorkbook = (XSSFWorkbook) SXSSFITestDataProvider.instance.writeOutAndReadBack(wb);
- wb = new SXSSFWorkbook(xssfWorkbook);
-
+ wb.dispose();
+
+ wb = new SXSSFWorkbook(xssfWorkbook);
+
// Add a row to the existing empty sheet
Sheet sheet1 = wb.getSheetAt(0);
Row row1_1 = sheet1.createRow(1);
Cell cell1_1_1 = row1_1.createCell(1);
cell1_1_1.setCellValue("value 1_1_1");
-
+
// Add a row to the existing non-empty sheet
Sheet sheet2 = wb.getSheetAt(1);
Row row2_2 = sheet2.createRow(2);
Cell cell2_2_1 = row2_2.createCell(1);
cell2_2_1.setCellValue("value 2_2_1");
-
+
// Add a sheet with one row
Sheet sheet3 = wb.createSheet("S3");
Row row3_1 = sheet3.createRow(1);
Cell cell3_1_1 = row3_1.createCell(1);
cell3_1_1.setCellValue("value 3_1_1");
-
+
xssfWorkbook = (XSSFWorkbook) SXSSFITestDataProvider.instance.writeOutAndReadBack(wb);
assertEquals(3, xssfWorkbook.getNumberOfSheets());
// Verify sheet 1
File tmp = wr.getTempFile();
assertTrue(tmp.getName().startsWith("poi-sxssf-sheet"));
assertTrue(tmp.getName().endsWith(".xml"));
+ wb.dispose();
wb = new SXSSFWorkbook();
wb.setCompressTempFiles(true);
tmp = wr.getTempFile();
assertTrue(tmp.getName().startsWith("poi-sxssf-sheet-xml"));
assertTrue(tmp.getName().endsWith(".gz"));
+ wb.dispose();
//Test escaping of Unicode control characters
wb = new SXSSFWorkbook();
Cell cell = xssfWorkbook.getSheet("S1").getRow(0).getCell(0);
assertEquals("value?", cell.getStringCellValue());
+ wb.dispose();
+
}
-
+
public void testGZipSheetdataWriter(){
- Workbook wb = new SXSSFWorkbook();
- ((SXSSFWorkbook)wb).setCompressTempFiles(true);
+ SXSSFWorkbook wb = new SXSSFWorkbook();
+ wb.setCompressTempFiles(true);
int rowNum = 1000;
int sheetNum = 5;
for(int i = 0; i < sheetNum; i++){
Row row = sh.createRow(j);
Cell cell1 = row.createCell(0);
cell1.setCellValue(new CellReference(cell1).formatAsString());
-
+
Cell cell2 = row.createCell(1);
cell2.setCellValue(i);
}
}
- wb = SXSSFITestDataProvider.instance.writeOutAndReadBack(wb);
+ XSSFWorkbook xwb = (XSSFWorkbook)SXSSFITestDataProvider.instance.writeOutAndReadBack(wb);
for(int i = 0; i < sheetNum; i++){
- Sheet sh = wb.getSheetAt(i);
+ Sheet sh = xwb.getSheetAt(i);
assertEquals("sheet" + i, sh.getSheetName());
for(int j = 0; j < rowNum; j++){
Row row = sh.getRow(j);
}
}
-
+ wb.dispose();
+
}
+ static void assertWorkbookDispose(SXSSFWorkbook wb)
+ {
+ int rowNum = 1000;
+ int sheetNum = 5;
+ for(int i = 0; i < sheetNum; i++){
+ Sheet sh = wb.createSheet("sheet" + i);
+ for(int j = 0; j < rowNum; j++){
+ Row row = sh.createRow(j);
+ Cell cell1 = row.createCell(0);
+ cell1.setCellValue(new CellReference(cell1).formatAsString());
+
+ Cell cell2 = row.createCell(1);
+ cell2.setCellValue(i);
+
+ Cell cell3 = row.createCell(2);
+ cell3.setCellValue(j);
+ }
+ }
+
+ for (SXSSFSheet sheet : wb._sxFromXHash.keySet()) {
+ assertTrue(sheet.getSheetDataWriter().getTempFile().exists());
+ }
+
+ assertTrue(wb.dispose());
+
+ for (SXSSFSheet sheet : wb._sxFromXHash.keySet()) {
+ assertFalse(sheet.getSheetDataWriter().getTempFile().exists());
+ }
+ }
+
+ public void testWorkbookDispose()
+ {
+ SXSSFWorkbook wb = new SXSSFWorkbook();
+ // the underlying writer is SheetDataWriter
+ assertWorkbookDispose(wb);
+
+ wb = new SXSSFWorkbook();
+ wb.setCompressTempFiles(true);
+ // the underlying writer is GZIPSheetDataWriter
+ assertWorkbookDispose(wb);
+
+ }
}
projects / poi.git / commitdiff