Package org.apache.poi.xssf.streaming

Class DeferredSXSSFSheet

java.lang.Object

org.apache.poi.xssf.streaming.SXSSFSheet

org.apache.poi.xssf.streaming.DeferredSXSSFSheet

All Implemented Interfaces:

Iterable<Row>, Sheet, OoxmlSheetExtensions

@Beta
public class DeferredSXSSFSheet
extends SXSSFSheet

A variant of SXSSFSheet that uses a RowGeneratorFunction to lazily create rows. This variant is experimental and APIs may change at short notice.

Since:

5.0.0

See Also:

• DeferredSXSSFWorkbook
• RowGeneratorFunction

Field Summary

Fields inherited from interface org.apache.poi.ss.usermodel.Sheet

BottomMargin, FooterMargin, HeaderMargin, LeftMargin, PANE_LOWER_LEFT, PANE_LOWER_RIGHT, PANE_UPPER_LEFT, PANE_UPPER_RIGHT, RightMargin, TopMargin

Constructor Summary

Constructors

Constructor	Description
DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook, XSSFSheet xSheet)

Method Summary

Modifier and Type	Method	Description
InputStream	getWorksheetXMLInputStream()	Unsupported in DeferredSXSSFSheet
void	setRowGenerator(RowGeneratorFunction rowGenerator)	Add a function to generate rows for the sheet.
void	writeRows(OutputStream out)

Methods inherited from class org.apache.poi.xssf.streaming.SXSSFSheet

addHyperlink, addMergedRegion, addMergedRegionUnsafe, addValidationData, areAllRowsFlushed, autoSizeColumn, autoSizeColumn, changeRowNum, createDrawingPatriarch, createFreezePane, createFreezePane, createRow, createSplitPane, createSplitPane, disableLocking, enableLocking, flushBufferedData, flushRows, flushRows, getActiveCell, getAutobreaks, getCellComment, getCellComments, getColumnBreaks, getColumnOutlineLevel, getColumnStyle, getColumnWidth, getColumnWidthInPixels, getDataValidationHelper, getDataValidations, getDefaultColumnWidth, getDefaultRowHeight, getDefaultRowHeightInPoints, getDisplayGuts, getDrawingPatriarch, getFirstRowNum, getFitToPage, getFooter, getForceFormulaRecalculation, getHeader, getHorizontallyCenter, getHyperlink, getHyperlink, getHyperlinkList, getLastFlushedRowNum, getLastRowNum, getLeftCol, getMargin, getMargin, getMergedRegion, getMergedRegions, getNumMergedRegions, getPaneInformation, getPhysicalNumberOfRows, getPrintSetup, getProtect, getRepeatingColumns, getRepeatingRows, getRow, getRowBreaks, getRowNum, getRowSumsBelow, getRowSumsRight, getScenarioProtect, getSheetConditionalFormatting, getSheetName, getTabColor, getTopRow, getTrackedColumnsForAutoSizing, getVerticallyCenter, getVMLDrawing, getWorkbook, groupColumn, groupRow, isColumnBroken, isColumnHidden, isColumnTrackedForAutoSizing, isDisplayFormulas, isDisplayGridlines, isDisplayRowColHeadings, isDisplayZeros, isPrintGridlines, isPrintRowAndColumnHeadings, isRightToLeft, isRowBroken, isSelected, lockAutoFilter, lockDeleteColumns, lockDeleteRows, lockFormatCells, lockFormatColumns, lockFormatRows, lockInsertColumns, lockInsertHyperlinks, lockInsertRows, lockObjects, lockPivotTables, lockScenarios, lockSelectLockedCells, lockSelectUnlockedCells, lockSort, protectSheet, removeArrayFormula, removeColumnBreak, removeMergedRegion, removeMergedRegions, removeRow, removeRowBreak, rowIterator, setActiveCell, setArrayFormula, setAutobreaks, setAutoFilter, setColumnBreak, setColumnGroupCollapsed, setColumnHidden, setColumnWidth, setDefaultColumnStyle, setDefaultColumnWidth, setDefaultRowHeight, setDefaultRowHeightInPoints, setDisplayFormulas, setDisplayGridlines, setDisplayGuts, setDisplayRowColHeadings, setDisplayZeros, setFitToPage, setForceFormulaRecalculation, setHorizontallyCenter, setMargin, setMargin, setPrintGridlines, setPrintRowAndColumnHeadings, setRandomAccessWindowSize, setRepeatingColumns, setRepeatingRows, setRightToLeft, setRowBreak, setRowGroupCollapsed, setRowOutlineLevel, setRowSumsBelow, setRowSumsRight, setSelected, setTabColor, setTabColor, setVerticallyCenter, setZoom, shiftColumns, shiftRows, shiftRows, showInPane, spliterator, trackAllColumnsForAutoSizing, trackColumnForAutoSizing, trackColumnsForAutoSizing, ungroupColumn, ungroupRow, untrackAllColumnsForAutoSizing, untrackColumnForAutoSizing, untrackColumnsForAutoSizing, validateMergedRegions

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.apache.poi.ss.usermodel.Sheet

iterator

Constructor Details

DeferredSXSSFSheet

public DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook,
 XSSFSheet xSheet)
                   throws IOException

Throws:

IOException

Method Details

getWorksheetXMLInputStream

public InputStream getWorksheetXMLInputStream()
                                       throws IOException

Unsupported in DeferredSXSSFSheet

Overrides:

getWorksheetXMLInputStream in class SXSSFSheet

Throws:

RuntimeException - this is unsupported

IOException

setRowGenerator

public void setRowGenerator(RowGeneratorFunction rowGenerator)

Add a function to generate rows for the sheet. This function should only create rows and cells. Any other settings like creating cell styles should be done in separate calls outside this function.

Parameters:

rowGenerator - RowGeneratorFunction

writeRows

public void writeRows(OutputStream out)
               throws IOException

Throws:

IOException