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:

java.lang.Iterable<Row>, Sheet

@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 class org.apache.poi.xssf.streaming.SXSSFSheet

_autoSizeColumnTracker, _workbook, _writer

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 and Description
DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook, XSSFSheet xSheet)

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getWorksheetXMLInputStream()
void	setRowGenerator(RowGeneratorFunction rowGenerator)
void	writeRows(java.io.OutputStream out)

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

addMergedRegion, addMergedRegionUnsafe, addValidationData, areAllRowsFlushed, autoSizeColumn, autoSizeColumn, changeRowNum, createDrawingPatriarch, createFreezePane, createFreezePane, createRow, createSplitPane, disableLocking, enableLocking, 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, getMergedRegion, getMergedRegions, getNumMergedRegions, getPaneInformation, getPhysicalNumberOfRows, getPrintSetup, getProtect, getRepeatingColumns, getRepeatingRows, getRow, getRowBreaks, getRowNum, getRowSumsBelow, getRowSumsRight, getScenarioProtect, getSheetConditionalFormatting, getSheetName, getTabColor, getTopRow, getTrackedColumnsForAutoSizing, getVerticallyCenter, getWorkbook, groupColumn, groupRow, isColumnBroken, isColumnHidden, isColumnTrackedForAutoSizing, isDisplayFormulas, isDisplayGridlines, isDisplayRowColHeadings, isDisplayZeros, isPrintGridlines, isPrintRowAndColumnHeadings, isRightToLeft, isRowBroken, isSelected, iterator, 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, setPrintGridlines, setPrintRowAndColumnHeadings, setRandomAccessWindowSize, setRepeatingColumns, setRepeatingRows, setRightToLeft, setRowBreak, setRowGroupCollapsed, setRowOutlineLevel, setRowSumsBelow, setRowSumsRight, setSelected, setTabColor, setTabColor, setVerticallyCenter, setZoom, shiftColumns, shiftRows, shiftRows, showInPane, trackAllColumnsForAutoSizing, trackColumnForAutoSizing, trackColumnsForAutoSizing, ungroupColumn, ungroupRow, untrackAllColumnsForAutoSizing, untrackColumnForAutoSizing, untrackColumnsForAutoSizing, validateMergedRegions

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DeferredSXSSFSheet

public DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook,
                          XSSFSheet xSheet)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getWorksheetXMLInputStream

public java.io.InputStream getWorksheetXMLInputStream()
                                               throws java.io.IOException

Overrides:

getWorksheetXMLInputStream in class SXSSFSheet

Throws:

java.io.IOException

setRowGenerator

public void setRowGenerator(RowGeneratorFunction rowGenerator)

writeRows

public void writeRows(java.io.OutputStream out)
               throws java.io.IOException

Throws:

java.io.IOException