org.apache.poi.xssf.streaming

Class DeferredSXSSFWorkbook

java.lang.Object

org.apache.poi.xssf.streaming.SXSSFWorkbook

org.apache.poi.xssf.streaming.DeferredSXSSFWorkbook

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<Sheet>, Workbook

@Beta
public class DeferredSXSSFWorkbook
extends SXSSFWorkbook

An variant of SXSSFWorkbook that avoids generating a temporary file and writes data directly to the provided OutputStream. This variant is experimental and APIs may change at short notice.

Since:

5.0.0

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.xssf.streaming.SXSSFWorkbook

SXSSFWorkbook.ISheetInjector, SXSSFWorkbook.SheetIterator<T extends Sheet>

Field Summary

Fields inherited from class org.apache.poi.xssf.streaming.SXSSFWorkbook

_sharedStringSource, _wb, DEFAULT_WINDOW_SIZE, zip64Mode

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

MAX_SENSITIVE_SHEET_NAME_LEN, PICTURE_TYPE_DIB, PICTURE_TYPE_EMF, PICTURE_TYPE_JPEG, PICTURE_TYPE_PICT, PICTURE_TYPE_PNG, PICTURE_TYPE_WMF

Constructor Summary

Constructors

Constructor and Description
DeferredSXSSFWorkbook()
DeferredSXSSFWorkbook(int rowAccessWindowSize)
DeferredSXSSFWorkbook(XSSFWorkbook workbook)
DeferredSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize)

Method Summary

Modifier and Type	Method and Description
DeferredSXSSFSheet	createSheet() Create a Sheet for this Workbook, adds it to the sheets and returns the high level representation.
DeferredSXSSFSheet	createSheet(java.lang.String sheetname) Create a Sheet for this Workbook, adds it to the sheets and returns the high level representation.
protected SheetDataWriter	createSheetDataWriter()
protected StreamingSheetWriter	createSheetDataWriter(java.io.OutputStream out)
protected SXSSFWorkbook.ISheetInjector	createSheetInjector(SXSSFSheet sxSheet)
DeferredSXSSFSheet	getStreamingSheet(java.lang.String name) Gets sheet with the given name for streaming.
DeferredSXSSFSheet	getStreamingSheetAt(int index) Gets the sheet at the given index for streaming.
XSSFSheet	getXSSFSheet(java.lang.String name)
void	removeSheetAt(int index) Removes sheet at the given index
java.util.Iterator<Sheet>	sheetIterator() Returns an iterator of the sheets in the workbook in sheet order.

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

addOlePackage, addPicture, addToolPack, cloneSheet, close, createArchiveOutputStream, createCellStyle, createDataFormat, createEvaluationWorkbook, createFont, createName, dispose, findFont, flushSheets, getActiveSheetIndex, getAllNames, getAllPictures, getCellReferenceType, getCellStyleAt, getCreationHelper, getFirstVisibleTab, getFontAt, getForceFormulaRecalculation, getMissingCellPolicy, getName, getNames, getNumberOfFonts, getNumberOfFontsAsInt, getNumberOfNames, getNumberOfSheets, getNumCellStyles, getPrintArea, getRandomAccessWindowSize, getSharedStringSource, getSheet, getSheetAt, getSheetFromZipEntryName, getSheetIndex, getSheetIndex, getSheetName, getSheetVisibility, getSpreadsheetVersion, getXSSFWorkbook, injectData, isCompressTempFiles, isDate1904, isHidden, isSheetHidden, isSheetVeryHidden, linkExternalWorkbook, removeName, removePrintArea, setActiveSheet, setCellReferenceType, setCompressTempFiles, setFirstVisibleTab, setForceFormulaRecalculation, setHidden, setMissingCellPolicy, setPrintArea, setPrintArea, setRandomAccessWindowSize, setSelectedTab, setSheetHidden, setSheetName, setSheetOrder, setSheetVisibility, setShouldCalculateSheetDimensions, setZip64Mode, shouldCalculateSheetDimensions, spliterator, write, writeAvoidingTempFiles

Methods inherited from class java.lang.Object

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

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

iterator

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DeferredSXSSFWorkbook

public DeferredSXSSFWorkbook()

DeferredSXSSFWorkbook

public DeferredSXSSFWorkbook(int rowAccessWindowSize)

DeferredSXSSFWorkbook

public DeferredSXSSFWorkbook(XSSFWorkbook workbook)

DeferredSXSSFWorkbook

public DeferredSXSSFWorkbook(XSSFWorkbook workbook,
                             int rowAccessWindowSize)

Method Detail

createSheetDataWriter

@NotImplemented
protected SheetDataWriter createSheetDataWriter()
                                                         throws java.io.IOException

Overrides:

createSheetDataWriter in class SXSSFWorkbook

Throws:

java.io.IOException

createSheetDataWriter

protected StreamingSheetWriter createSheetDataWriter(java.io.OutputStream out)
                                              throws java.io.IOException

Throws:

java.io.IOException

createSheetInjector

protected SXSSFWorkbook.ISheetInjector createSheetInjector(SXSSFSheet sxSheet)
                                                    throws java.io.IOException

Overrides:

createSheetInjector in class SXSSFWorkbook

Throws:

java.io.IOException

createSheet

public DeferredSXSSFSheet createSheet()

Description copied from class: SXSSFWorkbook

Create a Sheet for this Workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

Specified by:

createSheet in interface Workbook

Overrides:

createSheet in class SXSSFWorkbook

Returns:

Sheet representing the new sheet.

createSheet

public DeferredSXSSFSheet createSheet(java.lang.String sheetname)

Description copied from class: SXSSFWorkbook

Create a Sheet for this Workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.

Specified by:

createSheet in interface Workbook

Overrides:

createSheet in class SXSSFWorkbook

Parameters:

sheetname - sheetname to set for the sheet.

Returns:

Sheet representing the new sheet.

See Also:

WorkbookUtil.createSafeSheetName(String nameProposal)

sheetIterator

public java.util.Iterator<Sheet> sheetIterator()

Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets.

Specified by:

sheetIterator in interface Workbook

Overrides:

sheetIterator in class SXSSFWorkbook

Returns:

an iterator of the sheets.

getStreamingSheetAt

public DeferredSXSSFSheet getStreamingSheetAt(int index)

Gets the sheet at the given index for streaming.

Parameters:

index - the index

Returns:

the streaming sheet at

getXSSFSheet

public XSSFSheet getXSSFSheet(java.lang.String name)

getStreamingSheet

public DeferredSXSSFSheet getStreamingSheet(java.lang.String name)

Gets sheet with the given name for streaming.

Parameters:

name - the name

Returns:

the streaming sheet

removeSheetAt

public void removeSheetAt(int index)

Removes sheet at the given index

Specified by:

removeSheetAt in interface Workbook

Overrides:

removeSheetAt in class SXSSFWorkbook

Parameters:

index - of the sheet to remove (0-based)