StreamingWorkbook (excel-streaming-reader 3.5.0 API)

java.lang.Object
- com.github.pjfanning.xlsx.impl.StreamingWorkbook

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<org.apache.poi.ss.usermodel.Sheet>, org.apache.poi.ss.usermodel.Date1904Support, org.apache.poi.ss.usermodel.Workbook
```
public class StreamingWorkbook
extends java.lang.Object
implements org.apache.poi.ss.usermodel.Workbook, org.apache.poi.ss.usermodel.Date1904Support, java.lang.AutoCloseable
```

Field Summary
- 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

StreamingWorkbook(StreamingWorkbookReader reader)

Constructors
Constructor and Description
`StreamingWorkbook(StreamingWorkbookReader reader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addOlePackage(byte[] bytes, java.lang.String s, java.lang.String s1, java.lang.String s2)` Not supported
`int`	`addPicture(byte[] pictureData, int format)` Not supported
`void`	`addToolPack(org.apache.poi.ss.formula.udf.UDFFinder toopack)` Not supported
`org.apache.poi.ss.usermodel.Sheet`	`cloneSheet(int sheetNum)` Not supported
`void`	`close()`
`org.apache.poi.ss.usermodel.CellStyle`	`createCellStyle()` Not supported
`org.apache.poi.ss.usermodel.DataFormat`	`createDataFormat()` Not supported
`org.apache.poi.ss.formula.EvaluationWorkbook`	`createEvaluationWorkbook()` Not supported
`org.apache.poi.ss.usermodel.Font`	`createFont()` Not supported
`org.apache.poi.ss.usermodel.Name`	`createName()` Not supported
`org.apache.poi.ss.usermodel.Sheet`	`createSheet()` Not supported
`org.apache.poi.ss.usermodel.Sheet`	`createSheet(java.lang.String sheetname)` Not supported
`org.apache.poi.ss.usermodel.Font`	`findFont(boolean b, short i, short i1, java.lang.String s, boolean b1, boolean b2, short i2, byte b3)` Not supported
`int`	`getActiveSheetIndex()` Not supported
`java.util.List<? extends org.apache.poi.ss.usermodel.Name>`	`getAllNames()` Not supported
`java.util.List<? extends org.apache.poi.ss.usermodel.PictureData>`	`getAllPictures()` Gets all pictures from the Workbook.
`org.apache.poi.ss.usermodel.CellStyle`	`getCellStyleAt(int i)` Not supported
`org.apache.poi.ooxml.POIXMLProperties.CoreProperties`	`getCoreProperties()` Returns the Core Properties if this feature is enabled on the `StreamingReader.Builder`
`org.apache.poi.ss.usermodel.CreationHelper`	`getCreationHelper()` Not supported
`int`	`getFirstVisibleTab()` Not supported
`org.apache.poi.ss.usermodel.Font`	`getFontAt(int i)` Not supported
`boolean`	`getForceFormulaRecalculation()` Not supported
`org.apache.poi.ss.usermodel.Row.MissingCellPolicy`	`getMissingCellPolicy()` Not supported
`org.apache.poi.ss.usermodel.Name`	`getName(java.lang.String name)` Not supported
`java.util.List<? extends org.apache.poi.ss.usermodel.Name>`	`getNames(java.lang.String s)` Not supported
`int`	`getNumberOfFonts()` Not supported
`int`	`getNumberOfFontsAsInt()` Not supported
`int`	`getNumberOfNames()` Not supported
`int`	`getNumberOfSheets()`
`int`	`getNumCellStyles()` Not supported
`java.lang.String`	`getPrintArea(int sheetIndex)` Not supported
`org.apache.poi.ss.usermodel.Sheet`	`getSheet(java.lang.String name)` Get sheet with the given name
`org.apache.poi.ss.usermodel.Sheet`	`getSheetAt(int index)`
`int`	`getSheetIndex(org.apache.poi.ss.usermodel.Sheet sheet)`
`int`	`getSheetIndex(java.lang.String name)`
`java.lang.String`	`getSheetName(int sheet)`
`org.apache.poi.ss.usermodel.SheetVisibility`	`getSheetVisibility(int i)` Not supported
`org.apache.poi.ss.SpreadsheetVersion`	`getSpreadsheetVersion()`
`boolean`	`isDate1904()`
`boolean`	`isHidden()` Not supported
`boolean`	`isSheetHidden(int sheetIx)`
`boolean`	`isSheetVeryHidden(int sheetIx)`
`java.util.Iterator<org.apache.poi.ss.usermodel.Sheet>`	`iterator()`
`int`	`linkExternalWorkbook(java.lang.String name, org.apache.poi.ss.usermodel.Workbook workbook)` Not supported
`void`	`removeName(org.apache.poi.ss.usermodel.Name name)` Not supported
`void`	`removePrintArea(int sheetIndex)` Not supported
`void`	`removeSheetAt(int index)` Not supported
`void`	`setActiveSheet(int sheetIndex)` Not supported
`void`	`setFirstVisibleTab(int sheetIndex)` Not supported
`void`	`setForceFormulaRecalculation(boolean value)` Not supported
`void`	`setHidden(boolean hiddenFlag)` Not supported
`void`	`setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy missingCellPolicy)` Not supported
`void`	`setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)` Not supported
`void`	`setPrintArea(int sheetIndex, java.lang.String reference)` Not supported
`void`	`setSelectedTab(int index)` Not supported
`void`	`setSheetHidden(int sheetIx, boolean hidden)` Not supported
`void`	`setSheetName(int sheet, java.lang.String name)` Not supported
`void`	`setSheetOrder(java.lang.String sheetname, int pos)` Not supported
`void`	`setSheetVisibility(int i, org.apache.poi.ss.usermodel.SheetVisibility sheetVisibility)` Not supported
`java.util.Iterator<org.apache.poi.ss.usermodel.Sheet>`	`sheetIterator()`
`java.util.Spliterator<org.apache.poi.ss.usermodel.Sheet>`	`spliterator()`
`void`	`write(java.io.OutputStream stream)` Not supported

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

- Constructor Detail
  - StreamingWorkbook
```
public StreamingWorkbook(StreamingWorkbookReader reader)
```
- Method Detail
  - iterator
```
public java.util.Iterator<org.apache.poi.ss.usermodel.Sheet> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<org.apache.poi.ss.usermodel.Sheet>
    
    Specified by:
    
    iterator in interface org.apache.poi.ss.usermodel.Workbook
  - sheetIterator
```
public java.util.Iterator<org.apache.poi.ss.usermodel.Sheet> sheetIterator()
```
    Specified by:
    
    sheetIterator in interface org.apache.poi.ss.usermodel.Workbook
  - spliterator
```
public java.util.Spliterator<org.apache.poi.ss.usermodel.Sheet> spliterator()
```
    Specified by:
    
    spliterator in interface java.lang.Iterable<org.apache.poi.ss.usermodel.Sheet>
    
    Specified by:
    
    spliterator in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetName
```
public java.lang.String getSheetName(int sheet)
```
    Specified by:
    
    getSheetName in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetIndex
```
public int getSheetIndex(java.lang.String name)
```
    Specified by:
    
    getSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetIndex
```
public int getSheetIndex(org.apache.poi.ss.usermodel.Sheet sheet)
```
    Specified by:
    
    getSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfSheets
```
public int getNumberOfSheets()
```
    Specified by:
    
    getNumberOfSheets in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetAt
```
public org.apache.poi.ss.usermodel.Sheet getSheetAt(int index)
```
    Specified by:
    
    getSheetAt in interface org.apache.poi.ss.usermodel.Workbook
  - getSheet
```
public org.apache.poi.ss.usermodel.Sheet getSheet(java.lang.String name)
```
    Get sheet with the given name
    
    Specified by:
    
    getSheet in interface org.apache.poi.ss.usermodel.Workbook
    
    Parameters:
    
    name - - of the sheet
    
    Returns:
    
    Sheet with the name provided
    
    Throws:
    
    MissingSheetException - if no sheet is found with the provided name
  - isSheetHidden
```
public boolean isSheetHidden(int sheetIx)
```
    Specified by:
    
    isSheetHidden in interface org.apache.poi.ss.usermodel.Workbook
  - isSheetVeryHidden
```
public boolean isSheetVeryHidden(int sheetIx)
```
    Specified by:
    
    isSheetVeryHidden in interface org.apache.poi.ss.usermodel.Workbook
  - getSpreadsheetVersion
```
public org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion()
```
    Specified by:
    
    getSpreadsheetVersion in interface org.apache.poi.ss.usermodel.Workbook
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface org.apache.poi.ss.usermodel.Workbook
    
    Throws:
    
    java.io.IOException
  - getCoreProperties
```
public org.apache.poi.ooxml.POIXMLProperties.CoreProperties getCoreProperties()
```
    Returns the Core Properties if this feature is enabled on the StreamingReader.Builder
    
    Returns:
    
    CoreProperties
    
    Throws:
    
    java.lang.IllegalStateException - if StreamingReader.Builder.setReadCoreProperties(boolean) is not set to true
  - getAllPictures
```
public java.util.List<? extends org.apache.poi.ss.usermodel.PictureData> getAllPictures()
```
    Gets all pictures from the Workbook. This approach is not stream friendly.
    
    Specified by:
    
    getAllPictures in interface org.apache.poi.ss.usermodel.Workbook
    
    Returns:
    
    the list of pictures (a list of XSSFPictureData objects.)
  - isDate1904
```
public boolean isDate1904()
```
    Specified by:
    
    isDate1904 in interface org.apache.poi.ss.usermodel.Date1904Support
  - getActiveSheetIndex
```
public int getActiveSheetIndex()
```
    Not supported
    
    Specified by:
    
    getActiveSheetIndex in interface org.apache.poi.ss.usermodel.Workbook
  - setActiveSheet
```
public void setActiveSheet(int sheetIndex)
```
    Not supported
    
    Specified by:
    
    setActiveSheet in interface org.apache.poi.ss.usermodel.Workbook
  - getFirstVisibleTab
```
public int getFirstVisibleTab()
```
    Not supported
    
    Specified by:
    
    getFirstVisibleTab in interface org.apache.poi.ss.usermodel.Workbook
  - setFirstVisibleTab
```
public void setFirstVisibleTab(int sheetIndex)
```
    Not supported
    
    Specified by:
    
    setFirstVisibleTab in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetOrder
```
public void setSheetOrder(java.lang.String sheetname,
                          int pos)
```
    Not supported
    
    Specified by:
    
    setSheetOrder in interface org.apache.poi.ss.usermodel.Workbook
  - setSelectedTab
```
public void setSelectedTab(int index)
```
    Not supported
    
    Specified by:
    
    setSelectedTab in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetName
```
public void setSheetName(int sheet,
                         java.lang.String name)
```
    Not supported
    
    Specified by:
    
    setSheetName in interface org.apache.poi.ss.usermodel.Workbook
  - createSheet
```
public org.apache.poi.ss.usermodel.Sheet createSheet()
```
    Not supported
    
    Specified by:
    
    createSheet in interface org.apache.poi.ss.usermodel.Workbook
  - createSheet
```
public org.apache.poi.ss.usermodel.Sheet createSheet(java.lang.String sheetname)
```
    Not supported
    
    Specified by:
    
    createSheet in interface org.apache.poi.ss.usermodel.Workbook
  - cloneSheet
```
public org.apache.poi.ss.usermodel.Sheet cloneSheet(int sheetNum)
```
    Not supported
    
    Specified by:
    
    cloneSheet in interface org.apache.poi.ss.usermodel.Workbook
  - removeSheetAt
```
public void removeSheetAt(int index)
```
    Not supported
    
    Specified by:
    
    removeSheetAt in interface org.apache.poi.ss.usermodel.Workbook
  - createFont
```
public org.apache.poi.ss.usermodel.Font createFont()
```
    Not supported
    
    Specified by:
    
    createFont in interface org.apache.poi.ss.usermodel.Workbook
  - findFont
```
public org.apache.poi.ss.usermodel.Font findFont(boolean b,
                                                 short i,
                                                 short i1,
                                                 java.lang.String s,
                                                 boolean b1,
                                                 boolean b2,
                                                 short i2,
                                                 byte b3)
```
    Not supported
    
    Specified by:
    
    findFont in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfFonts
```
public int getNumberOfFonts()
```
    Not supported
    
    Specified by:
    
    getNumberOfFonts in interface org.apache.poi.ss.usermodel.Workbook
  - getNumberOfFontsAsInt
```
public int getNumberOfFontsAsInt()
```
    Not supported
    
    Specified by:
    
    getNumberOfFontsAsInt in interface org.apache.poi.ss.usermodel.Workbook
  - getFontAt
```
public org.apache.poi.ss.usermodel.Font getFontAt(int i)
```
    Not supported
    
    Specified by:
    
    getFontAt in interface org.apache.poi.ss.usermodel.Workbook
  - createCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle createCellStyle()
```
    Not supported
    
    Specified by:
    
    createCellStyle in interface org.apache.poi.ss.usermodel.Workbook
  - getNumCellStyles
```
public int getNumCellStyles()
```
    Not supported
    
    Specified by:
    
    getNumCellStyles in interface org.apache.poi.ss.usermodel.Workbook
  - getCellStyleAt
```
public org.apache.poi.ss.usermodel.CellStyle getCellStyleAt(int i)
```
    Not supported
    
    Specified by:
    
    getCellStyleAt in interface org.apache.poi.ss.usermodel.Workbook
  - write
```
public void write(java.io.OutputStream stream)
           throws java.io.IOException
```
    Not supported
    
    Specified by:
    
    write in interface org.apache.poi.ss.usermodel.Workbook
    
    Throws:
    
    java.io.IOException
  - getNumberOfNames
```
public int getNumberOfNames()
```
    Not supported
    
    Specified by:
    
    getNumberOfNames in interface org.apache.poi.ss.usermodel.Workbook
  - getName
```
public org.apache.poi.ss.usermodel.Name getName(java.lang.String name)
```
    Not supported
    
    Specified by:
    
    getName in interface org.apache.poi.ss.usermodel.Workbook
  - getNames
```
public java.util.List<? extends org.apache.poi.ss.usermodel.Name> getNames(java.lang.String s)
```
    Not supported
    
    Specified by:
    
    getNames in interface org.apache.poi.ss.usermodel.Workbook
  - getAllNames
```
public java.util.List<? extends org.apache.poi.ss.usermodel.Name> getAllNames()
```
    Not supported
    
    Specified by:
    
    getAllNames in interface org.apache.poi.ss.usermodel.Workbook
  - createName
```
public org.apache.poi.ss.usermodel.Name createName()
```
    Not supported
    
    Specified by:
    
    createName in interface org.apache.poi.ss.usermodel.Workbook
  - removeName
```
public void removeName(org.apache.poi.ss.usermodel.Name name)
```
    Not supported
    
    Specified by:
    
    removeName in interface org.apache.poi.ss.usermodel.Workbook
  - linkExternalWorkbook
```
public int linkExternalWorkbook(java.lang.String name,
                                org.apache.poi.ss.usermodel.Workbook workbook)
```
    Not supported
    
    Specified by:
    
    linkExternalWorkbook in interface org.apache.poi.ss.usermodel.Workbook
  - setPrintArea
```
public void setPrintArea(int sheetIndex,
                         java.lang.String reference)
```
    Not supported
    
    Specified by:
    
    setPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - setPrintArea
```
public void setPrintArea(int sheetIndex,
                         int startColumn,
                         int endColumn,
                         int startRow,
                         int endRow)
```
    Not supported
    
    Specified by:
    
    setPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - getPrintArea
```
public java.lang.String getPrintArea(int sheetIndex)
```
    Not supported
    
    Specified by:
    
    getPrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - removePrintArea
```
public void removePrintArea(int sheetIndex)
```
    Not supported
    
    Specified by:
    
    removePrintArea in interface org.apache.poi.ss.usermodel.Workbook
  - getMissingCellPolicy
```
public org.apache.poi.ss.usermodel.Row.MissingCellPolicy getMissingCellPolicy()
```
    Not supported
    
    Specified by:
    
    getMissingCellPolicy in interface org.apache.poi.ss.usermodel.Workbook
  - setMissingCellPolicy
```
public void setMissingCellPolicy(org.apache.poi.ss.usermodel.Row.MissingCellPolicy missingCellPolicy)
```
    Not supported
    
    Specified by:
    
    setMissingCellPolicy in interface org.apache.poi.ss.usermodel.Workbook
  - createDataFormat
```
public org.apache.poi.ss.usermodel.DataFormat createDataFormat()
```
    Not supported
    
    Specified by:
    
    createDataFormat in interface org.apache.poi.ss.usermodel.Workbook
  - addPicture
```
public int addPicture(byte[] pictureData,
                      int format)
```
    Not supported
    
    Specified by:
    
    addPicture in interface org.apache.poi.ss.usermodel.Workbook
  - getCreationHelper
```
public org.apache.poi.ss.usermodel.CreationHelper getCreationHelper()
```
    Not supported
    
    Specified by:
    
    getCreationHelper in interface org.apache.poi.ss.usermodel.Workbook
  - isHidden
```
public boolean isHidden()
```
    Not supported
    
    Specified by:
    
    isHidden in interface org.apache.poi.ss.usermodel.Workbook
  - setHidden
```
public void setHidden(boolean hiddenFlag)
```
    Not supported
    
    Specified by:
    
    setHidden in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetHidden
```
public void setSheetHidden(int sheetIx,
                           boolean hidden)
```
    Not supported
    
    Specified by:
    
    setSheetHidden in interface org.apache.poi.ss.usermodel.Workbook
  - getSheetVisibility
```
public org.apache.poi.ss.usermodel.SheetVisibility getSheetVisibility(int i)
```
    Not supported
    
    Specified by:
    
    getSheetVisibility in interface org.apache.poi.ss.usermodel.Workbook
  - setSheetVisibility
```
public void setSheetVisibility(int i,
                               org.apache.poi.ss.usermodel.SheetVisibility sheetVisibility)
```
    Not supported
    
    Specified by:
    
    setSheetVisibility in interface org.apache.poi.ss.usermodel.Workbook
  - addToolPack
```
public void addToolPack(org.apache.poi.ss.formula.udf.UDFFinder toopack)
```
    Not supported
    
    Specified by:
    
    addToolPack in interface org.apache.poi.ss.usermodel.Workbook
  - setForceFormulaRecalculation
```
public void setForceFormulaRecalculation(boolean value)
```
    Not supported
    
    Specified by:
    
    setForceFormulaRecalculation in interface org.apache.poi.ss.usermodel.Workbook
  - getForceFormulaRecalculation
```
public boolean getForceFormulaRecalculation()
```
    Not supported
    
    Specified by:
    
    getForceFormulaRecalculation in interface org.apache.poi.ss.usermodel.Workbook
  - addOlePackage
```
public int addOlePackage(byte[] bytes,
                         java.lang.String s,
                         java.lang.String s1,
                         java.lang.String s2)
                  throws java.io.IOException
```
    Not supported
    
    Specified by:
    
    addOlePackage in interface org.apache.poi.ss.usermodel.Workbook
    
    Throws:
    
    java.io.IOException
  - createEvaluationWorkbook
```
public org.apache.poi.ss.formula.EvaluationWorkbook createEvaluationWorkbook()
```
    Not supported
    
    Specified by:
    
    createEvaluationWorkbook in interface org.apache.poi.ss.usermodel.Workbook

Class StreamingWorkbook

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

StreamingWorkbook

Method Detail

iterator

sheetIterator

spliterator

getSheetName

getSheetIndex

getSheetIndex

getNumberOfSheets

getSheetAt

getSheet

isSheetHidden

isSheetVeryHidden

getSpreadsheetVersion

close

getCoreProperties

getAllPictures

isDate1904

getActiveSheetIndex

setActiveSheet

getFirstVisibleTab

setFirstVisibleTab

setSheetOrder

setSelectedTab

setSheetName

createSheet

createSheet

cloneSheet

removeSheetAt

createFont

findFont

getNumberOfFonts

getNumberOfFontsAsInt

getFontAt

createCellStyle

getNumCellStyles

getCellStyleAt

write

getNumberOfNames

getName

getNames

getAllNames

createName

removeName

linkExternalWorkbook

setPrintArea

setPrintArea

getPrintArea

removePrintArea

getMissingCellPolicy

setMissingCellPolicy

createDataFormat

addPicture

getCreationHelper

isHidden

setHidden

setSheetHidden

getSheetVisibility

setSheetVisibility

addToolPack

setForceFormulaRecalculation

getForceFormulaRecalculation

addOlePackage

createEvaluationWorkbook