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:
java.lang.Iterable<Row>
,Sheet
,OoxmlSheetExtensions
@Beta public class DeferredSXSSFSheet extends SXSSFSheet
A variant of SXSSFSheet that uses aRowGeneratorFunction
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.io.InputStream
getWorksheetXMLInputStream()
Unsupported in DeferredSXSSFSheetvoid
setRowGenerator(RowGeneratorFunction rowGenerator)
Add a function to generate rows for the sheet.void
writeRows(java.io.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
-
-
-
-
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
Unsupported in DeferredSXSSFSheet- Overrides:
getWorksheetXMLInputStream
in classSXSSFSheet
- Throws:
java.lang.RuntimeException
- this is unsupportedjava.io.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(java.io.OutputStream out) throws java.io.IOException
- Throws:
java.io.IOException
-
-