Package 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
-
-
Field Summary
-
Fields inherited from class org.apache.poi.xssf.streaming.SXSSFWorkbook
DEFAULT_WINDOW_SIZE
-
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 Description DeferredSXSSFWorkbook()
DeferredSXSSFWorkbook(int rowAccessWindowSize)
DeferredSXSSFWorkbook(XSSFWorkbook workbook)
DeferredSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.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 indexjava.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, createCellStyle, createDataFormat, createEvaluationWorkbook, createFont, createName, dispose, findFont, getActiveSheetIndex, getAllNames, getAllPictures, getCellReferenceType, getCellStyleAt, getCreationHelper, getFirstVisibleTab, getFontAt, getForceFormulaRecalculation, getMissingCellPolicy, getName, getNames, getNumberOfFonts, getNumberOfFontsAsInt, getNumberOfNames, getNumberOfSheets, getNumCellStyles, getPrintArea, getRandomAccessWindowSize, getSheet, getSheetAt, getSheetIndex, getSheetIndex, getSheetName, getSheetVisibility, getSpreadsheetVersion, getXSSFWorkbook, isCompressTempFiles, isHidden, isSheetHidden, isSheetVeryHidden, linkExternalWorkbook, removeName, removePrintArea, setActiveSheet, setCellReferenceType, setCompressTempFiles, setFirstVisibleTab, setForceFormulaRecalculation, setHidden, setMissingCellPolicy, setPrintArea, setPrintArea, setSelectedTab, setSheetHidden, setSheetName, setSheetOrder, setSheetVisibility, setShouldCalculateSheetDimensions, setZip64Mode, shouldCalculateSheetDimensions, spliterator, write, writeAvoidingTempFiles
-
-
-
-
Constructor Detail
-
DeferredSXSSFWorkbook
public DeferredSXSSFWorkbook()
-
DeferredSXSSFWorkbook
public DeferredSXSSFWorkbook(int rowAccessWindowSize)
-
DeferredSXSSFWorkbook
public DeferredSXSSFWorkbook(XSSFWorkbook workbook)
-
DeferredSXSSFWorkbook
public DeferredSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize)
-
-
Method Detail
-
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 interfaceWorkbook
- Overrides:
createSheet
in classSXSSFWorkbook
- 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 interfaceWorkbook
- Overrides:
createSheet
in classSXSSFWorkbook
- 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 interfaceWorkbook
- Overrides:
sheetIterator
in classSXSSFWorkbook
- 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 interfaceWorkbook
- Overrides:
removeSheetAt
in classSXSSFWorkbook
- Parameters:
index
- of the sheet to remove (0-based)
-
-