com.github.pjfanning.xlsx.impl

Class StreamingWorkbook

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingWorkbook

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Sheet>, Date1904Support, Workbook

public class StreamingWorkbook
extends Object
implements Workbook, Date1904Support, 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)

Method Summary

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

Specified by:

iterator in interface Iterable<Sheet>

Specified by:

iterator in interface Workbook

sheetIterator

public Iterator<Sheet> sheetIterator()

Specified by:

sheetIterator in interface Workbook

spliterator

public Spliterator<Sheet> spliterator()

Specified by:

spliterator in interface Iterable<Sheet>

Specified by:

spliterator in interface Workbook

getSheetName

public String getSheetName(int sheet)

Specified by:

getSheetName in interface Workbook

getSheetIndex

public int getSheetIndex(String name)

Returns the index of the sheet by his name (case insensitive match)

Specified by:

getSheetIndex in interface Workbook

Parameters:

name - the sheet name

Returns:

index of the sheet (0 based) or -1 if not found

getSheetIndex

public int getSheetIndex(Sheet sheet)

Returns the index of the given sheet

Specified by:

getSheetIndex in interface Workbook

Parameters:

sheet - the sheet to look up

Returns:

index of the sheet (0 based) or -1 if not found

Throws:

IllegalArgumentException - if the sheet provided is not a StreamingSheet

getNumberOfSheets

public int getNumberOfSheets()

Specified by:

getNumberOfSheets in interface Workbook

getSheetAt

public Sheet getSheetAt(int index)
                 throws ReadException

Specified by:

getSheetAt in interface Workbook

Throws:

ReadException

getSheet

public Sheet getSheet(String name)
               throws MissingSheetException,
                      ReadException

Get sheet with the given name

Specified by:

getSheet in interface Workbook

Parameters:

name - - of the sheet

Returns:

Sheet with the name provided

Throws:

MissingSheetException - if no sheet is found with the provided name

ReadException - if there is a problem reading the Excel file

isSheetHidden

public boolean isSheetHidden(int sheetIx)

Specified by:

isSheetHidden in interface Workbook

isSheetVeryHidden

public boolean isSheetVeryHidden(int sheetIx)

Specified by:

isSheetVeryHidden in interface Workbook

getSpreadsheetVersion

public SpreadsheetVersion getSpreadsheetVersion()

Specified by:

getSpreadsheetVersion in interface Workbook

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Workbook

Throws:

IOException

getCoreProperties

public POIXMLProperties.CoreProperties getCoreProperties()

Returns the Core Properties if this feature is enabled on the StreamingReader.Builder

Returns:

CoreProperties

Throws:

IllegalStateException - if StreamingReader.Builder.setReadCoreProperties(boolean) is not set to true

getAllPictures

public List<? extends PictureData> getAllPictures()

Gets all pictures from the Workbook. This approach is not stream friendly.

Specified by:

getAllPictures in interface Workbook

Returns:

the list of pictures (a list of XSSFPictureData objects.)

isDate1904

public boolean isDate1904()

Specified by:

isDate1904 in interface Date1904Support

getActiveSheetIndex

public int getActiveSheetIndex()

Not supported

Specified by:

getActiveSheetIndex in interface Workbook

setActiveSheet

public void setActiveSheet(int sheetIndex)

Not supported

Specified by:

setActiveSheet in interface Workbook

getFirstVisibleTab

public int getFirstVisibleTab()

Not supported

Specified by:

getFirstVisibleTab in interface Workbook

setFirstVisibleTab

public void setFirstVisibleTab(int sheetIndex)

Not supported

Specified by:

setFirstVisibleTab in interface Workbook

setSheetOrder

public void setSheetOrder(String sheetname,
                          int pos)

Not supported

Specified by:

setSheetOrder in interface Workbook

setSelectedTab

public void setSelectedTab(int index)

Not supported

Specified by:

setSelectedTab in interface Workbook

setSheetName

public void setSheetName(int sheet,
                         String name)

Not supported

Specified by:

setSheetName in interface Workbook

createSheet

public Sheet createSheet()

Not supported

Specified by:

createSheet in interface Workbook

createSheet

public Sheet createSheet(String sheetname)

Not supported

Specified by:

createSheet in interface Workbook

cloneSheet

public Sheet cloneSheet(int sheetNum)

Not supported

Specified by:

cloneSheet in interface Workbook

removeSheetAt

public void removeSheetAt(int index)

Not supported

Specified by:

removeSheetAt in interface Workbook

createFont

public Font createFont()

Not supported

Specified by:

createFont in interface Workbook

findFont

public Font findFont(boolean b,
                     short i,
                     short i1,
                     String s,
                     boolean b1,
                     boolean b2,
                     short i2,
                     byte b3)

Not supported

Specified by:

findFont in interface Workbook

getNumberOfFonts

public int getNumberOfFonts()

Not supported

Specified by:

getNumberOfFonts in interface Workbook

getNumberOfFontsAsInt

public int getNumberOfFontsAsInt()

Not supported

Specified by:

getNumberOfFontsAsInt in interface Workbook

getFontAt

public Font getFontAt(int i)

Not supported

Specified by:

getFontAt in interface Workbook

createCellStyle

public CellStyle createCellStyle()

Not supported

Specified by:

createCellStyle in interface Workbook

getNumCellStyles

public int getNumCellStyles()

Not supported

Specified by:

getNumCellStyles in interface Workbook

getCellStyleAt

public CellStyle getCellStyleAt(int i)

Not supported

Specified by:

getCellStyleAt in interface Workbook

write

public void write(OutputStream stream)
           throws IOException

Not supported

Specified by:

write in interface Workbook

Throws:

IOException

getNumberOfNames

public int getNumberOfNames()

Not supported

Specified by:

getNumberOfNames in interface Workbook

getName

public Name getName(String name)

Not supported

Specified by:

getName in interface Workbook

getNames

public List<? extends Name> getNames(String s)

Not supported

Specified by:

getNames in interface Workbook

getAllNames

public List<? extends Name> getAllNames()

Not supported

Specified by:

getAllNames in interface Workbook

createName

public Name createName()

Not supported

Specified by:

createName in interface Workbook

removeName

public void removeName(Name name)

Not supported

Specified by:

removeName in interface Workbook

linkExternalWorkbook

public int linkExternalWorkbook(String name,
                                Workbook workbook)

Not supported

Specified by:

linkExternalWorkbook in interface Workbook

setPrintArea

public void setPrintArea(int sheetIndex,
                         String reference)

Not supported

Specified by:

setPrintArea in interface Workbook

setPrintArea

public void setPrintArea(int sheetIndex,
                         int startColumn,
                         int endColumn,
                         int startRow,
                         int endRow)

Not supported

Specified by:

setPrintArea in interface Workbook

getPrintArea

public String getPrintArea(int sheetIndex)

Not supported

Specified by:

getPrintArea in interface Workbook

removePrintArea

public void removePrintArea(int sheetIndex)

Not supported

Specified by:

removePrintArea in interface Workbook

getMissingCellPolicy

public Row.MissingCellPolicy getMissingCellPolicy()

Not supported

Specified by:

getMissingCellPolicy in interface Workbook

setMissingCellPolicy

public void setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)

Not supported

Specified by:

setMissingCellPolicy in interface Workbook

createDataFormat

public DataFormat createDataFormat()

Not supported

Specified by:

createDataFormat in interface Workbook

addPicture

public int addPicture(byte[] pictureData,
                      int format)

Not supported

Specified by:

addPicture in interface Workbook

getCreationHelper

public CreationHelper getCreationHelper()

Not supported

Specified by:

getCreationHelper in interface Workbook

isHidden

public boolean isHidden()

Not supported

Specified by:

isHidden in interface Workbook

setHidden

public void setHidden(boolean hiddenFlag)

Not supported

Specified by:

setHidden in interface Workbook

setSheetHidden

public void setSheetHidden(int sheetIx,
                           boolean hidden)

Not supported

Specified by:

setSheetHidden in interface Workbook

getSheetVisibility

public SheetVisibility getSheetVisibility(int i)

Not supported

Specified by:

getSheetVisibility in interface Workbook

setSheetVisibility

public void setSheetVisibility(int i,
                               SheetVisibility sheetVisibility)

Not supported

Specified by:

setSheetVisibility in interface Workbook

addToolPack

public void addToolPack(UDFFinder toopack)

Not supported

Specified by:

addToolPack in interface Workbook

setForceFormulaRecalculation

public void setForceFormulaRecalculation(boolean value)

Not supported

Specified by:

setForceFormulaRecalculation in interface Workbook

getForceFormulaRecalculation

public boolean getForceFormulaRecalculation()

Not supported

Specified by:

getForceFormulaRecalculation in interface Workbook

addOlePackage

public int addOlePackage(byte[] bytes,
                         String s,
                         String s1,
                         String s2)
                  throws IOException

Not supported

Specified by:

addOlePackage in interface Workbook

Throws:

IOException

createEvaluationWorkbook

public EvaluationWorkbook createEvaluationWorkbook()

Not supported

Specified by:

createEvaluationWorkbook in interface Workbook

getCellReferenceType

public CellReferenceType getCellReferenceType()

Not supported

Specified by:

getCellReferenceType in interface Workbook

setCellReferenceType

public void setCellReferenceType(CellReferenceType cellReferenceType)

Not supported

Specified by:

setCellReferenceType in interface Workbook