Package org.apache.poi.xssf.streaming
Class SheetDataWriter
- java.lang.Object
-
- org.apache.poi.xssf.streaming.SheetDataWriter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Direct Known Subclasses:
GZIPSheetDataWriter
,SheetDataWriterWithDecorator
public class SheetDataWriter extends Object implements Closeable
Initially copied from BigGridDemo "SpreadsheetWriter". Unlike the original code which wrote the entire document, this class only writes the "sheetData" document fragment so that it was renamed to "SheetDataWriter"
-
-
Constructor Summary
Constructors Constructor Description SheetDataWriter()
SheetDataWriter(SharedStringsTable sharedStringsTable)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
flush and close the temp data writer.File
createTempFile()
Create a temp file to write sheet data.Writer
createWriter(File fd)
Create a writer for the sheet data.int
getLastFlushedRow()
int
getLowestIndexOfFlushedRows()
int
getNumberOfCellsOfLastFlushedRow()
int
getNumberOfFlushedRows()
InputStream
getWorksheetXMLInputStream()
void
writeCell(int columnIndex, Cell cell)
void
writeRow(int rownum, SXSSFRow row)
Write a row to the file
-
-
-
Constructor Detail
-
SheetDataWriter
public SheetDataWriter() throws IOException
- Throws:
IOException
-
SheetDataWriter
public SheetDataWriter(SharedStringsTable sharedStringsTable) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createTempFile
public File createTempFile() throws IOException
Create a temp file to write sheet data. By default, temp files are created in the default temporary-file directory with a prefix "poi-sxssf-sheet" and suffix ".xml". Subclasses can override it and specify a different temp directory or filename or suffix, e.g..gz
- Returns:
- temp file to write sheet data
- Throws:
IOException
-
createWriter
public Writer createWriter(File fd) throws IOException
Create a writer for the sheet data.- Parameters:
fd
- the file to write to- Throws:
IOException
-
close
public void close() throws IOException
flush and close the temp data writer. This method must be invoked before callinggetWorksheetXMLInputStream()
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
getWorksheetXMLInputStream
public InputStream getWorksheetXMLInputStream() throws IOException
- Returns:
- a stream to read temp file with the sheet data
- Throws:
IOException
-
getNumberOfFlushedRows
public int getNumberOfFlushedRows()
-
getNumberOfCellsOfLastFlushedRow
public int getNumberOfCellsOfLastFlushedRow()
-
getLowestIndexOfFlushedRows
public int getLowestIndexOfFlushedRows()
-
getLastFlushedRow
public int getLastFlushedRow()
-
writeRow
public void writeRow(int rownum, SXSSFRow row) throws IOException
Write a row to the file- Parameters:
rownum
- 0-based row numberrow
- a row- Throws:
IOException
- If an I/O error occurs
-
writeCell
public void writeCell(int columnIndex, Cell cell) throws IOException
- Throws:
IOException
-
-