StreamingSheet (excel-streaming-reader 5.0.4 API)

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

All Implemented Interfaces:: Iterable<Row>, Sheet

public class StreamingSheet
extends Object
implements Sheet

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 and Description

StreamingSheet(String name, StreamingSheetReader reader)

Constructors
Constructor and Description
`StreamingSheet(String name, StreamingSheetReader reader)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addMergedRegion(CellRangeAddress region)` Update operations are not supported
`int`	`addMergedRegionUnsafe(CellRangeAddress cellRangeAddress)` Update operations are not supported
`void`	`addSharedFormula(String siValue, SharedFormula sharedFormula)`
`void`	`addValidationData(DataValidation dataValidation)` Not supported
`void`	`autoSizeColumn(int column)` Update operations are not supported
`void`	`autoSizeColumn(int column, boolean useMergedCells)` Update operations are not supported
`Drawing`	`createDrawingPatriarch()` Not supported
`void`	`createFreezePane(int colSplit, int rowSplit)` Not supported
`void`	`createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow)` Not supported
`Row`	`createRow(int rownum)` Update operations are not supported
`void`	`createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane)` Not supported
`void`	`createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, PaneType activePane)` Not supported
`CellAddress`	`getActiveCell()`
`boolean`	`getAutobreaks()` Not supported
`Comment`	`getCellComment(CellAddress cellAddress)` Return cell comment at row, column, if one exists.
`Map<CellAddress,? extends Comment>`	`getCellComments()` Returns all cell comments on this sheet.
`int[]`	`getColumnBreaks()` Not supported
`int`	`getColumnOutlineLevel(int columnIndex)` Not supported
`CellStyle`	`getColumnStyle(int column)` Not supported
`int`	`getColumnWidth(int columnIndex)`
`float`	`getColumnWidthInPixels(int columnIndex)`
`DataValidationHelper`	`getDataValidationHelper()` Not supported
`List<? extends DataValidation>`	`getDataValidations()` Not supported
`int`	`getDefaultColumnWidth()` Get the default column width for the sheet (if the columns do not define their own width) in characters.
`short`	`getDefaultRowHeight()` Get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
`float`	`getDefaultRowHeightInPoints()` Get the default row height for the sheet measured in point size (if the rows do not define their own height).
`boolean`	`getDisplayGuts()` Not supported
`Drawing<?>`	`getDrawingPatriarch()` Return the sheet's existing drawing, or null if there isn't yet one.
`int`	`getFirstRowNum()` Gets the first row on the sheet.
`boolean`	`getFitToPage()` Not supported
`Footer`	`getFooter()` Not supported
`boolean`	`getForceFormulaRecalculation()` Not supported
`Header`	`getHeader()` Not supported
`boolean`	`getHorizontallyCenter()` Not supported
`Hyperlink`	`getHyperlink(CellAddress cellAddress)` Get hyperlink associated with cell (only if feature is enabled on the Builder).
`Hyperlink`	`getHyperlink(int row, int column)` Get a Hyperlink in this sheet anchored at row, column (only if feature is enabled on the Builder).
`List<? extends Hyperlink>`	`getHyperlinkList()` Get hyperlinks associated with sheet (only if feature is enabled on the Builder).
`int`	`getLastRowNum()` Gets the last row on the sheet.
`short`	`getLeftCol()` Not supported
`double`	`getMargin(PageMargin margin)` Not supported
`double`	`getMargin(short margin)` Not supported
`CellRangeAddress`	`getMergedRegion(int index)` Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
`List<CellRangeAddress>`	`getMergedRegions()` Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
`int`	`getNumMergedRegions()` Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
`PaneInformation`	`getPaneInformation()`
`int`	`getPhysicalNumberOfRows()` Not supported - use `iterator()` or `rowIterator()` to iterate over rows and count the rows
`PrintSetup`	`getPrintSetup()` Not supported
`boolean`	`getProtect()` Not supported
`CellRangeAddress`	`getRepeatingColumns()` Not supported
`CellRangeAddress`	`getRepeatingRows()` Not supported
`Row`	`getRow(int rownum)` Not supported - use `iterator()` or `rowIterator()` instead
`int[]`	`getRowBreaks()` Not supported
`boolean`	`getRowSumsBelow()` Not supported
`boolean`	`getRowSumsRight()` Not supported
`boolean`	`getScenarioProtect()` Not supported
`Map<String,SharedFormula>`	`getSharedFormulaMap()`
`SheetConditionalFormatting`	`getSheetConditionalFormatting()` Not supported
`String`	`getSheetName()`
`short`	`getTopRow()` Not supported
`boolean`	`getVerticallyCenter()` Not supported
`Workbook`	`getWorkbook()` Workbook is only set under certain usage flows.
`void`	`groupColumn(int fromColumn, int toColumn)` Update operations are not supported
`void`	`groupRow(int fromRow, int toRow)` Update operations are not supported
`boolean`	`isColumnBroken(int column)` Not supported
`boolean`	`isColumnHidden(int columnIndex)` Get the hidden state for a given column
`boolean`	`isDisplayFormulas()` Not supported
`boolean`	`isDisplayGridlines()` Not supported
`boolean`	`isDisplayRowColHeadings()` Not supported
`boolean`	`isDisplayZeros()` Not supported
`boolean`	`isPrintGridlines()` Not supported
`boolean`	`isPrintRowAndColumnHeadings()` Not supported
`boolean`	`isRightToLeft()` Not supported
`boolean`	`isRowBroken(int row)` Not supported
`boolean`	`isSelected()` Not supported
`CloseableIterator<Row>`	`iterator()` Alias for `rowIterator()` to allow foreach loops
`void`	`protectSheet(String password)` Not supported
`CellRange<? extends Cell>`	`removeArrayFormula(Cell cell)` Update operations are not supported
`void`	`removeColumnBreak(int column)` Update operations are not supported
`void`	`removeMergedRegion(int index)` Update operations are not supported
`void`	`removeMergedRegions(Collection<Integer> collection)` Update operations are not supported
`void`	`removeRow(Row row)` Update operations are not supported
`void`	`removeRowBreak(int row)` Update operations are not supported
`SharedFormula`	`removeSharedFormula(String siValue)`
`CloseableIterator<Row>`	`rowIterator()` Returns a new iterator of the physical rows.
`void`	`setActiveCell(CellAddress cellAddress)` Not supported
`CellRange<? extends Cell>`	`setArrayFormula(String formula, CellRangeAddress range)` Update operations are not supported
`void`	`setAutobreaks(boolean value)` Update operations are not supported
`AutoFilter`	`setAutoFilter(CellRangeAddress range)` Update operations are not supported
`void`	`setColumnBreak(int column)` Update operations are not supported
`void`	`setColumnGroupCollapsed(int columnNumber, boolean collapsed)` Update operations are not supported
`void`	`setColumnHidden(int columnIndex, boolean hidden)` Update operations are not supported
`void`	`setColumnWidth(int columnIndex, int width)` Update operations are not supported
`void`	`setDefaultColumnStyle(int column, CellStyle style)` Update operations are not supported
`void`	`setDefaultColumnWidth(int width)` Update operations are not supported
`void`	`setDefaultRowHeight(short height)` Update operations are not supported
`void`	`setDefaultRowHeightInPoints(float height)` Update operations are not supported
`void`	`setDisplayFormulas(boolean show)` Update operations are not supported
`void`	`setDisplayGridlines(boolean show)` Update operations are not supported
`void`	`setDisplayGuts(boolean value)` Update operations are not supported
`void`	`setDisplayRowColHeadings(boolean show)` Update operations are not supported
`void`	`setDisplayZeros(boolean value)` Update operations are not supported
`void`	`setFitToPage(boolean value)` Update operations are not supported
`void`	`setForceFormulaRecalculation(boolean value)` Update operations are not supported
`void`	`setHorizontallyCenter(boolean value)` Update operations are not supported
`void`	`setMargin(PageMargin margin, double size)` Update operations are not supported
`void`	`setMargin(short margin, double size)` Update operations are not supported
`void`	`setPrintGridlines(boolean show)` Not supported
`void`	`setPrintRowAndColumnHeadings(boolean b)` Update operations are not supported
`void`	`setRepeatingColumns(CellRangeAddress columnRangeRef)` Update operations are not supported
`void`	`setRepeatingRows(CellRangeAddress rowRangeRef)` Update operations are not supported
`void`	`setRightToLeft(boolean value)` Update operations are not supported
`void`	`setRowBreak(int row)` Update operations are not supported
`void`	`setRowGroupCollapsed(int row, boolean collapse)` Update operations are not supported
`void`	`setRowSumsBelow(boolean value)` Update operations are not supported
`void`	`setRowSumsRight(boolean value)` Update operations are not supported
`void`	`setSelected(boolean value)` Update operations are not supported
`void`	`setVerticallyCenter(boolean value)` Update operations are not supported
`void`	`setZoom(int i)` Update operations are not supported
`void`	`shiftColumns(int startColumn, int endColumn, int n)` Update operations are not supported
`void`	`shiftRows(int startRow, int endRow, int n)` Update operations are not supported
`void`	`shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight)` Update operations are not supported
`void`	`showInPane(int toprow, int leftcol)` Not supported
`Spliterator<Row>`	`spliterator()`
`void`	`ungroupColumn(int fromColumn, int toColumn)` Update operations are not supported
`void`	`ungroupRow(int fromRow, int toRow)` Update operations are not supported
`void`	`validateMergedRegions()` 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
  - StreamingSheet
```
public StreamingSheet(String name,
                      StreamingSheetReader reader)
```
- Method Detail
  - getWorkbook
```
public Workbook getWorkbook()
```
    Workbook is only set under certain usage flows.
    
    Specified by:
    
    getWorkbook in interface Sheet
  - iterator
```
public CloseableIterator<Row> iterator()
```
    Alias for rowIterator() to allow foreach loops
    
    Specified by:
    
    iterator in interface Iterable<Row>
    
    Specified by:
    
    iterator in interface Sheet
    
    Returns:
    
    the streaming iterator, an instance of CloseableIterator - it is recommended that you close the iterator when finished with it if you intend to keep the sheet open.
  - rowIterator
```
public CloseableIterator<Row> rowIterator()
```
    Returns a new iterator of the physical rows. This is an iterator of the PHYSICAL rows. Meaning the 3rd element may not be the third row if say for instance the second row is undefined. This behaviour changed in v4.0.0. Earlier versions only created one simple iterator and repeated calls to this method just returned the same iterator. Creating multiple iterators will slow down your application and should be avoided unless necessary.
    
    Specified by:
    
    rowIterator in interface Sheet
    
    Returns:
    
    the streaming iterator, an instance of CloseableIterator - it is recommended that you close the iterator when finished with it if you intend to keep the sheet open.
  - spliterator
```
public Spliterator<Row> spliterator()
```
    Specified by:
    
    spliterator in interface Iterable<Row>
    
    Specified by:
    
    spliterator in interface Sheet
  - getSheetName
```
public String getSheetName()
```
    Specified by:
    
    getSheetName in interface Sheet
  - isColumnHidden
```
public boolean isColumnHidden(int columnIndex)
```
    Get the hidden state for a given column
    
    Specified by:
    
    isColumnHidden in interface Sheet
    
    Parameters:
    
    columnIndex - - the column to set (0-based)
    
    Returns:
    
    hidden - false if the column is visible
  - getFirstRowNum
```
public int getFirstRowNum()
```
    Gets the first row on the sheet. This value is only available on some sheets where the sheet XML has the dimension data set. At present, this method will return 0 if this dimension data is missing (this may change in a future release).
    
    Specified by:
    
    getFirstRowNum in interface Sheet
    
    Returns:
    
    first row contained in this sheet (0-based)
  - getLastRowNum
```
public int getLastRowNum()
```
    Gets the last row on the sheet. This value is only available on some sheets where the sheet XML has the dimension data set. At present, this method will return 0 if this dimension data is missing (this may change in a future release).
    
    Specified by:
    
    getLastRowNum in interface Sheet
    
    Returns:
    
    last row contained in this sheet (0-based)
  - getCellComment
```
public Comment getCellComment(CellAddress cellAddress)
```
    Return cell comment at row, column, if one exists. Otherwise, return null.
    
    Specified by:
    
    getCellComment in interface Sheet
    
    Parameters:
    
    cellAddress - the location of the cell comment
    
    Returns:
    
    the cell comment, if one exists. Otherwise, return null.
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadComments(boolean) is not set to true
  - getCellComments
```
public Map<CellAddress,? extends Comment> getCellComments()
```
    Returns all cell comments on this sheet.
    
    Specified by:
    
    getCellComments in interface Sheet
    
    Returns:
    
    A map of each Comment in the sheet, keyed on the cell address where the comment is located.
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadComments(boolean) is not set to true
  - getMergedRegion
```
public CellRangeAddress getMergedRegion(int index)
                                 throws NoSuchElementException
```
    Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
    
    Specified by:
    
    getMergedRegion in interface Sheet
    
    Parameters:
    
    index - the index of the merged region to retrieve
    
    Returns:
    
    the merged region at the specified index
    
    Throws:
    
    NoSuchElementException - if the index argument is not a valid index
  - getMergedRegions
```
public List<CellRangeAddress> getMergedRegions()
```
    Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
    
    Specified by:
    
    getMergedRegions in interface Sheet
  - getNumMergedRegions
```
public int getNumMergedRegions()
```
    Only works after sheet is fully read (because merged regions data is stored at the end of the sheet XML).
    
    Specified by:
    
    getNumMergedRegions in interface Sheet
  - getDrawingPatriarch
```
public Drawing<?> getDrawingPatriarch()
```
    Return the sheet's existing drawing, or null if there isn't yet one.
    
    Specified by:
    
    getDrawingPatriarch in interface Sheet
    
    Returns:
    
    a SpreadsheetML drawing
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadShapes(boolean) is not set to true
  - getHyperlink
```
public Hyperlink getHyperlink(int row,
                              int column)
```
    Get a Hyperlink in this sheet anchored at row, column (only if feature is enabled on the Builder).
    
    Specified by:
    
    getHyperlink in interface Sheet
    
    Parameters:
    
    row - The row where the hyperlink is anchored
    
    column - The column where the hyperlink is anchored
    
    Returns:
    
    hyperlink if there is a hyperlink anchored at row, column; otherwise returns null
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadHyperlinks(boolean) is not set to true
  - getHyperlink
```
public Hyperlink getHyperlink(CellAddress cellAddress)
```
    Get hyperlink associated with cell (only if feature is enabled on the Builder). This should only be called after all the rows are read because the hyperlink data is at the end of the sheet.
    
    Specified by:
    
    getHyperlink in interface Sheet
    
    Parameters:
    
    cellAddress - the location of the cell
    
    Returns:
    
    the hyperlink associated with this cell (only if feature is enabled on the Builder) - null if not found
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadHyperlinks(boolean) is not set to true
  - getHyperlinkList
```
public List<? extends Hyperlink> getHyperlinkList()
```
    Get hyperlinks associated with sheet (only if feature is enabled on the Builder). This should only be called after all the rows are read because the hyperlink data is at the end of the sheet.
    
    Specified by:
    
    getHyperlinkList in interface Sheet
    
    Returns:
    
    the hyperlinks associated with this sheet (only if feature is enabled on the Builder) - cast to XlsxHyperlink to access cell reference
    
    Throws:
    
    IllegalStateException - if StreamingReader.Builder.setReadHyperlinks(boolean) is not set to true
  - getActiveCell
```
public CellAddress getActiveCell()
```
    Specified by:
    
    getActiveCell in interface Sheet
  - getDefaultColumnWidth
```
public int getDefaultColumnWidth()
```
    Get the default column width for the sheet (if the columns do not define their own width) in characters.
    Note, this value is different from getColumnWidth(int). The latter is always greater and includes 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
    
    This value is only available after the first row is read (due to the way excel-streaming-reader streams the data).
    
    Specified by:
    
    getDefaultColumnWidth in interface Sheet
    
    Returns:
    
    column width, default value is 8
  - getDefaultRowHeight
```
public short getDefaultRowHeight()
```
    Get the default row height for the sheet (if the rows do not define their own height) in twips (1/20 of a point)
    This value is only available after the first row is read (due to the way excel-streaming-reader streams the data).
    
    Specified by:
    
    getDefaultRowHeight in interface Sheet
    
    Returns:
    
    default row height
  - getDefaultRowHeightInPoints
```
public float getDefaultRowHeightInPoints()
```
    Get the default row height for the sheet measured in point size (if the rows do not define their own height).
    This value is only available after the first row is read (due to the way excel-streaming-reader streams the data).
    
    Specified by:
    
    getDefaultRowHeightInPoints in interface Sheet
    
    Returns:
    
    default row height in points
  - getColumnWidth
```
public int getColumnWidth(int columnIndex)
```
    Specified by:
    
    getColumnWidth in interface Sheet
  - getColumnWidthInPixels
```
public float getColumnWidthInPixels(int columnIndex)
```
    Specified by:
    
    getColumnWidthInPixels in interface Sheet
  - getPaneInformation
```
public PaneInformation getPaneInformation()
```
    Specified by:
    
    getPaneInformation in interface Sheet
  - getSharedFormulaMap
```
public Map<String,SharedFormula> getSharedFormulaMap()
```
    Returns:
    
    immutable copy of the shared formula map for this sheet
  - addSharedFormula
```
public void addSharedFormula(String siValue,
                             SharedFormula sharedFormula)
```
    Parameters:
    
    siValue - the ID for the shared formula (appears in Excel sheet XML as an si attribute
    
    sharedFormula - maps the base cell and formula for the shared formula
  - removeSharedFormula
```
public SharedFormula removeSharedFormula(String siValue)
```
    Parameters:
    
    siValue - the ID for the shared formula (appears in Excel sheet XML as an si attribute
    
    Returns:
    
    the shared formula that was removed (can be null if no existing shared formula is found)
  - createRow
```
public Row createRow(int rownum)
```
    Update operations are not supported
    
    Specified by:
    
    createRow in interface Sheet
  - removeRow
```
public void removeRow(Row row)
```
    Update operations are not supported
    
    Specified by:
    
    removeRow in interface Sheet
  - getRow
```
public Row getRow(int rownum)
```
    Not supported - use iterator() or rowIterator() instead
    
    Specified by:
    
    getRow in interface Sheet
  - getPhysicalNumberOfRows
```
public int getPhysicalNumberOfRows()
```
    Not supported - use iterator() or rowIterator() to iterate over rows and count the rows
    
    Specified by:
    
    getPhysicalNumberOfRows in interface Sheet
  - setColumnHidden
```
public void setColumnHidden(int columnIndex,
                            boolean hidden)
```
    Update operations are not supported
    
    Specified by:
    
    setColumnHidden in interface Sheet
  - setRightToLeft
```
public void setRightToLeft(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setRightToLeft in interface Sheet
  - isRightToLeft
```
public boolean isRightToLeft()
```
    Not supported
    
    Specified by:
    
    isRightToLeft in interface Sheet
  - setColumnWidth
```
public void setColumnWidth(int columnIndex,
                           int width)
```
    Update operations are not supported
    
    Specified by:
    
    setColumnWidth in interface Sheet
  - setDefaultColumnWidth
```
public void setDefaultColumnWidth(int width)
```
    Update operations are not supported
    
    Specified by:
    
    setDefaultColumnWidth in interface Sheet
  - setDefaultRowHeight
```
public void setDefaultRowHeight(short height)
```
    Update operations are not supported
    
    Specified by:
    
    setDefaultRowHeight in interface Sheet
  - setDefaultRowHeightInPoints
```
public void setDefaultRowHeightInPoints(float height)
```
    Update operations are not supported
    
    Specified by:
    
    setDefaultRowHeightInPoints in interface Sheet
  - getColumnStyle
```
public CellStyle getColumnStyle(int column)
```
    Not supported
    
    Specified by:
    
    getColumnStyle in interface Sheet
  - addMergedRegion
```
public int addMergedRegion(CellRangeAddress region)
```
    Update operations are not supported
    
    Specified by:
    
    addMergedRegion in interface Sheet
  - addMergedRegionUnsafe
```
public int addMergedRegionUnsafe(CellRangeAddress cellRangeAddress)
```
    Update operations are not supported
    
    Specified by:
    
    addMergedRegionUnsafe in interface Sheet
  - validateMergedRegions
```
public void validateMergedRegions()
```
    Not supported
    
    Specified by:
    
    validateMergedRegions in interface Sheet
  - setVerticallyCenter
```
public void setVerticallyCenter(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setVerticallyCenter in interface Sheet
  - setHorizontallyCenter
```
public void setHorizontallyCenter(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setHorizontallyCenter in interface Sheet
  - getHorizontallyCenter
```
public boolean getHorizontallyCenter()
```
    Not supported
    
    Specified by:
    
    getHorizontallyCenter in interface Sheet
  - getVerticallyCenter
```
public boolean getVerticallyCenter()
```
    Not supported
    
    Specified by:
    
    getVerticallyCenter in interface Sheet
  - removeMergedRegion
```
public void removeMergedRegion(int index)
```
    Update operations are not supported
    
    Specified by:
    
    removeMergedRegion in interface Sheet
  - removeMergedRegions
```
public void removeMergedRegions(Collection<Integer> collection)
```
    Update operations are not supported
    
    Specified by:
    
    removeMergedRegions in interface Sheet
  - setForceFormulaRecalculation
```
public void setForceFormulaRecalculation(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setForceFormulaRecalculation in interface Sheet
  - getForceFormulaRecalculation
```
public boolean getForceFormulaRecalculation()
```
    Not supported
    
    Specified by:
    
    getForceFormulaRecalculation in interface Sheet
  - setAutobreaks
```
public void setAutobreaks(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setAutobreaks in interface Sheet
  - setDisplayGuts
```
public void setDisplayGuts(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setDisplayGuts in interface Sheet
  - setDisplayZeros
```
public void setDisplayZeros(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setDisplayZeros in interface Sheet
  - isDisplayZeros
```
public boolean isDisplayZeros()
```
    Not supported
    
    Specified by:
    
    isDisplayZeros in interface Sheet
  - setFitToPage
```
public void setFitToPage(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setFitToPage in interface Sheet
  - setRowSumsBelow
```
public void setRowSumsBelow(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setRowSumsBelow in interface Sheet
  - setRowSumsRight
```
public void setRowSumsRight(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setRowSumsRight in interface Sheet
  - getAutobreaks
```
public boolean getAutobreaks()
```
    Not supported
    
    Specified by:
    
    getAutobreaks in interface Sheet
  - getDisplayGuts
```
public boolean getDisplayGuts()
```
    Not supported
    
    Specified by:
    
    getDisplayGuts in interface Sheet
  - getFitToPage
```
public boolean getFitToPage()
```
    Not supported
    
    Specified by:
    
    getFitToPage in interface Sheet
  - getRowSumsBelow
```
public boolean getRowSumsBelow()
```
    Not supported
    
    Specified by:
    
    getRowSumsBelow in interface Sheet
  - getRowSumsRight
```
public boolean getRowSumsRight()
```
    Not supported
    
    Specified by:
    
    getRowSumsRight in interface Sheet
  - isPrintGridlines
```
public boolean isPrintGridlines()
```
    Not supported
    
    Specified by:
    
    isPrintGridlines in interface Sheet
  - setPrintGridlines
```
public void setPrintGridlines(boolean show)
```
    Not supported
    
    Specified by:
    
    setPrintGridlines in interface Sheet
  - isPrintRowAndColumnHeadings
```
public boolean isPrintRowAndColumnHeadings()
```
    Not supported
    
    Specified by:
    
    isPrintRowAndColumnHeadings in interface Sheet
  - setPrintRowAndColumnHeadings
```
public void setPrintRowAndColumnHeadings(boolean b)
```
    Update operations are not supported
    
    Specified by:
    
    setPrintRowAndColumnHeadings in interface Sheet
  - getPrintSetup
```
public PrintSetup getPrintSetup()
```
    Not supported
    
    Specified by:
    
    getPrintSetup in interface Sheet
  - getHeader
```
public Header getHeader()
```
    Not supported
    
    Specified by:
    
    getHeader in interface Sheet
  - getFooter
```
public Footer getFooter()
```
    Not supported
    
    Specified by:
    
    getFooter in interface Sheet
  - setSelected
```
public void setSelected(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setSelected in interface Sheet
  - getMargin
```
public double getMargin(short margin)
```
    Not supported
    
    Specified by:
    
    getMargin in interface Sheet
  - getMargin
```
public double getMargin(PageMargin margin)
```
    Not supported
    
    Specified by:
    
    getMargin in interface Sheet
  - setMargin
```
public void setMargin(short margin,
                      double size)
```
    Update operations are not supported
    
    Specified by:
    
    setMargin in interface Sheet
  - setMargin
```
public void setMargin(PageMargin margin,
                      double size)
```
    Update operations are not supported
    
    Specified by:
    
    setMargin in interface Sheet
  - getProtect
```
public boolean getProtect()
```
    Not supported
    
    Specified by:
    
    getProtect in interface Sheet
  - protectSheet
```
public void protectSheet(String password)
```
    Not supported
    
    Specified by:
    
    protectSheet in interface Sheet
  - getScenarioProtect
```
public boolean getScenarioProtect()
```
    Not supported
    
    Specified by:
    
    getScenarioProtect in interface Sheet
  - setZoom
```
public void setZoom(int i)
```
    Update operations are not supported
    
    Specified by:
    
    setZoom in interface Sheet
  - getTopRow
```
public short getTopRow()
```
    Not supported
    
    Specified by:
    
    getTopRow in interface Sheet
  - getLeftCol
```
public short getLeftCol()
```
    Not supported
    
    Specified by:
    
    getLeftCol in interface Sheet
  - showInPane
```
public void showInPane(int toprow,
                       int leftcol)
```
    Not supported
    
    Specified by:
    
    showInPane in interface Sheet
  - shiftRows
```
public void shiftRows(int startRow,
                      int endRow,
                      int n)
```
    Update operations are not supported
    
    Specified by:
    
    shiftRows in interface Sheet
  - shiftRows
```
public void shiftRows(int startRow,
                      int endRow,
                      int n,
                      boolean copyRowHeight,
                      boolean resetOriginalRowHeight)
```
    Update operations are not supported
    
    Specified by:
    
    shiftRows in interface Sheet
  - shiftColumns
```
public void shiftColumns(int startColumn,
                         int endColumn,
                         int n)
```
    Update operations are not supported
    
    Specified by:
    
    shiftColumns in interface Sheet
  - createFreezePane
```
public void createFreezePane(int colSplit,
                             int rowSplit,
                             int leftmostColumn,
                             int topRow)
```
    Not supported
    
    Specified by:
    
    createFreezePane in interface Sheet
  - createFreezePane
```
public void createFreezePane(int colSplit,
                             int rowSplit)
```
    Not supported
    
    Specified by:
    
    createFreezePane in interface Sheet
  - createSplitPane
```
public void createSplitPane(int xSplitPos,
                            int ySplitPos,
                            int leftmostColumn,
                            int topRow,
                            int activePane)
```
    Not supported
    
    Specified by:
    
    createSplitPane in interface Sheet
  - createSplitPane
```
public void createSplitPane(int xSplitPos,
                            int ySplitPos,
                            int leftmostColumn,
                            int topRow,
                            PaneType activePane)
```
    Not supported
    
    Specified by:
    
    createSplitPane in interface Sheet
  - setDisplayGridlines
```
public void setDisplayGridlines(boolean show)
```
    Update operations are not supported
    
    Specified by:
    
    setDisplayGridlines in interface Sheet
  - isDisplayGridlines
```
public boolean isDisplayGridlines()
```
    Not supported
    
    Specified by:
    
    isDisplayGridlines in interface Sheet
  - setDisplayFormulas
```
public void setDisplayFormulas(boolean show)
```
    Update operations are not supported
    
    Specified by:
    
    setDisplayFormulas in interface Sheet
  - isDisplayFormulas
```
public boolean isDisplayFormulas()
```
    Not supported
    
    Specified by:
    
    isDisplayFormulas in interface Sheet
  - setDisplayRowColHeadings
```
public void setDisplayRowColHeadings(boolean show)
```
    Update operations are not supported
    
    Specified by:
    
    setDisplayRowColHeadings in interface Sheet
  - isDisplayRowColHeadings
```
public boolean isDisplayRowColHeadings()
```
    Not supported
    
    Specified by:
    
    isDisplayRowColHeadings in interface Sheet
  - setRowBreak
```
public void setRowBreak(int row)
```
    Update operations are not supported
    
    Specified by:
    
    setRowBreak in interface Sheet
  - isRowBroken
```
public boolean isRowBroken(int row)
```
    Not supported
    
    Specified by:
    
    isRowBroken in interface Sheet
  - removeRowBreak
```
public void removeRowBreak(int row)
```
    Update operations are not supported
    
    Specified by:
    
    removeRowBreak in interface Sheet
  - getRowBreaks
```
public int[] getRowBreaks()
```
    Not supported
    
    Specified by:
    
    getRowBreaks in interface Sheet
  - getColumnBreaks
```
public int[] getColumnBreaks()
```
    Not supported
    
    Specified by:
    
    getColumnBreaks in interface Sheet
  - setColumnBreak
```
public void setColumnBreak(int column)
```
    Update operations are not supported
    
    Specified by:
    
    setColumnBreak in interface Sheet
  - isColumnBroken
```
public boolean isColumnBroken(int column)
```
    Not supported
    
    Specified by:
    
    isColumnBroken in interface Sheet
  - removeColumnBreak
```
public void removeColumnBreak(int column)
```
    Update operations are not supported
    
    Specified by:
    
    removeColumnBreak in interface Sheet
  - setColumnGroupCollapsed
```
public void setColumnGroupCollapsed(int columnNumber,
                                    boolean collapsed)
```
    Update operations are not supported
    
    Specified by:
    
    setColumnGroupCollapsed in interface Sheet
  - groupColumn
```
public void groupColumn(int fromColumn,
                        int toColumn)
```
    Update operations are not supported
    
    Specified by:
    
    groupColumn in interface Sheet
  - ungroupColumn
```
public void ungroupColumn(int fromColumn,
                          int toColumn)
```
    Update operations are not supported
    
    Specified by:
    
    ungroupColumn in interface Sheet
  - groupRow
```
public void groupRow(int fromRow,
                     int toRow)
```
    Update operations are not supported
    
    Specified by:
    
    groupRow in interface Sheet
  - ungroupRow
```
public void ungroupRow(int fromRow,
                       int toRow)
```
    Update operations are not supported
    
    Specified by:
    
    ungroupRow in interface Sheet
  - setRowGroupCollapsed
```
public void setRowGroupCollapsed(int row,
                                 boolean collapse)
```
    Update operations are not supported
    
    Specified by:
    
    setRowGroupCollapsed in interface Sheet
  - setDefaultColumnStyle
```
public void setDefaultColumnStyle(int column,
                                  CellStyle style)
```
    Update operations are not supported
    
    Specified by:
    
    setDefaultColumnStyle in interface Sheet
  - autoSizeColumn
```
public void autoSizeColumn(int column)
```
    Update operations are not supported
    
    Specified by:
    
    autoSizeColumn in interface Sheet
  - autoSizeColumn
```
public void autoSizeColumn(int column,
                           boolean useMergedCells)
```
    Update operations are not supported
    
    Specified by:
    
    autoSizeColumn in interface Sheet
  - createDrawingPatriarch
```
public Drawing createDrawingPatriarch()
```
    Not supported
    
    Specified by:
    
    createDrawingPatriarch in interface Sheet
  - isSelected
```
public boolean isSelected()
```
    Not supported
    
    Specified by:
    
    isSelected in interface Sheet
  - setArrayFormula
```
public CellRange<? extends Cell> setArrayFormula(String formula,
                                                 CellRangeAddress range)
```
    Update operations are not supported
    
    Specified by:
    
    setArrayFormula in interface Sheet
  - removeArrayFormula
```
public CellRange<? extends Cell> removeArrayFormula(Cell cell)
```
    Update operations are not supported
    
    Specified by:
    
    removeArrayFormula in interface Sheet
  - getDataValidationHelper
```
public DataValidationHelper getDataValidationHelper()
```
    Not supported
    
    Specified by:
    
    getDataValidationHelper in interface Sheet
  - getDataValidations
```
public List<? extends DataValidation> getDataValidations()
```
    Not supported
    
    Specified by:
    
    getDataValidations in interface Sheet
  - addValidationData
```
public void addValidationData(DataValidation dataValidation)
```
    Not supported
    
    Specified by:
    
    addValidationData in interface Sheet
  - setAutoFilter
```
public AutoFilter setAutoFilter(CellRangeAddress range)
```
    Update operations are not supported
    
    Specified by:
    
    setAutoFilter in interface Sheet
  - getSheetConditionalFormatting
```
public SheetConditionalFormatting getSheetConditionalFormatting()
```
    Not supported
    
    Specified by:
    
    getSheetConditionalFormatting in interface Sheet
  - getRepeatingRows
```
public CellRangeAddress getRepeatingRows()
```
    Not supported
    
    Specified by:
    
    getRepeatingRows in interface Sheet
  - getRepeatingColumns
```
public CellRangeAddress getRepeatingColumns()
```
    Not supported
    
    Specified by:
    
    getRepeatingColumns in interface Sheet
  - setRepeatingRows
```
public void setRepeatingRows(CellRangeAddress rowRangeRef)
```
    Update operations are not supported
    
    Specified by:
    
    setRepeatingRows in interface Sheet
  - setRepeatingColumns
```
public void setRepeatingColumns(CellRangeAddress columnRangeRef)
```
    Update operations are not supported
    
    Specified by:
    
    setRepeatingColumns in interface Sheet
  - getColumnOutlineLevel
```
public int getColumnOutlineLevel(int columnIndex)
```
    Not supported
    
    Specified by:
    
    getColumnOutlineLevel in interface Sheet
  - setActiveCell
```
public void setActiveCell(CellAddress cellAddress)
```
    Not supported
    
    Specified by:
    
    setActiveCell in interface Sheet

Class StreamingSheet

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

StreamingSheet

Method Detail

getWorkbook

iterator

rowIterator

spliterator

getSheetName

isColumnHidden

getFirstRowNum

getLastRowNum

getCellComment

getCellComments

getMergedRegion

getMergedRegions

getNumMergedRegions

getDrawingPatriarch

getHyperlink

getHyperlink

getHyperlinkList

getActiveCell

getDefaultColumnWidth

getDefaultRowHeight

getDefaultRowHeightInPoints

getColumnWidth

getColumnWidthInPixels

getPaneInformation

getSharedFormulaMap

addSharedFormula

removeSharedFormula

createRow

removeRow

getRow

getPhysicalNumberOfRows

setColumnHidden

setRightToLeft

isRightToLeft

setColumnWidth

setDefaultColumnWidth

setDefaultRowHeight

setDefaultRowHeightInPoints

getColumnStyle

addMergedRegion

addMergedRegionUnsafe

validateMergedRegions

setVerticallyCenter

setHorizontallyCenter

getHorizontallyCenter

getVerticallyCenter

removeMergedRegion

removeMergedRegions

setForceFormulaRecalculation

getForceFormulaRecalculation

setAutobreaks

setDisplayGuts

setDisplayZeros

isDisplayZeros

setFitToPage

setRowSumsBelow

setRowSumsRight

getAutobreaks

getDisplayGuts

getFitToPage

getRowSumsBelow

getRowSumsRight

isPrintGridlines

setPrintGridlines

isPrintRowAndColumnHeadings

setPrintRowAndColumnHeadings

getPrintSetup

getHeader

getFooter

setSelected