StreamingCell (excel-streaming-reader 3.5.0 API)

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

All Implemented Interfaces:: org.apache.poi.ss.usermodel.Cell

public class StreamingCell
extends java.lang.Object
implements org.apache.poi.ss.usermodel.Cell

Constructor Summary

Constructors
Constructor and Description
`StreamingCell(org.apache.poi.ss.usermodel.Sheet sheet, int columnIndex, int rowIndex, boolean use1904Dates)`
`StreamingCell(org.apache.poi.ss.usermodel.Sheet sheet, int columnIndex, org.apache.poi.ss.usermodel.Row row, boolean use1904Dates)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.poi.ss.util.CellAddress`	`getAddress()`
`org.apache.poi.ss.util.CellRangeAddress`	`getArrayFormulaRange()` Not supported
`boolean`	`getBooleanCellValue()` Get the value of the cell as a boolean.
`org.apache.poi.ss.usermodel.CellType`	`getCachedFormulaResultType()` Only valid for formula cells
`org.apache.poi.ss.usermodel.Comment`	`getCellComment()` Returns cell comment associated with this cell
`java.lang.String`	`getCellFormula()` Return a formula for the cell, for example, `SUM(C4:E4)`
`org.apache.poi.ss.usermodel.CellStyle`	`getCellStyle()`
`org.apache.poi.ss.usermodel.CellType`	`getCellType()` Return the cell type.
`int`	`getColumnIndex()` Returns column index of this cell
`java.util.Date`	`getDateCellValue()` Get the value of the cell as a date.
`byte`	`getErrorCellValue()`
`org.apache.poi.ss.usermodel.Hyperlink`	`getHyperlink()` Returns hyperlink associated with this cell.
`java.time.LocalDateTime`	`getLocalDateTimeCellValue()`
`double`	`getNumericCellValue()` Get the value of the cell as a number.
`java.lang.String`	`getNumericFormat()`
`org.apache.poi.xssf.usermodel.XSSFRichTextString`	`getRichStringCellValue()` Get the value of the cell as a XSSFRichTextString
`org.apache.poi.ss.usermodel.Row`	`getRow()` Row is not guaranteed to be set.
`int`	`getRowIndex()` Returns row index of a row in the sheet that contains this cell
`org.apache.poi.ss.usermodel.Sheet`	`getSheet()`
`java.lang.String`	`getStringCellValue()` Get the value of the cell as a string.
`boolean`	`isPartOfArrayFormulaGroup()` Not supported
`void`	`removeCellComment()` Update operations are not supported
`void`	`removeFormula()` Update operations are not supported
`void`	`removeHyperlink()` Update operations are not supported
`void`	`setAsActiveCell()` Update operations are not supported
`void`	`setBlank()` Update operations are not supported
`void`	`setCellComment(org.apache.poi.ss.usermodel.Comment comment)` Update operations are not supported
`void`	`setCellErrorValue(byte value)` Update operations are not supported
`void`	`setCellFormula(java.lang.String formula)` Update operations are not supported
`void`	`setCellStyle(org.apache.poi.ss.usermodel.CellStyle cellStyle)`
`void`	`setCellType(org.apache.poi.ss.usermodel.CellType cellType)` Update operations are not supported
`void`	`setCellValue(boolean value)` Update operations are not supported
`void`	`setCellValue(java.util.Calendar value)` Update operations are not supported
`void`	`setCellValue(java.util.Date value)` Update operations are not supported
`void`	`setCellValue(double value)` Update operations are not supported
`void`	`setCellValue(java.time.LocalDate value)` Update operations are not supported
`void`	`setCellValue(java.time.LocalDateTime value)` Update operations are not supported
`void`	`setCellValue(org.apache.poi.ss.usermodel.RichTextString value)` Update operations are not supported
`void`	`setCellValue(java.lang.String value)` Update operations are not supported
`void`	`setHyperlink(org.apache.poi.ss.usermodel.Hyperlink link)` Update operations are not supported

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StreamingCell
```
public StreamingCell(org.apache.poi.ss.usermodel.Sheet sheet,
                     int columnIndex,
                     int rowIndex,
                     boolean use1904Dates)
```
  - StreamingCell
```
public StreamingCell(org.apache.poi.ss.usermodel.Sheet sheet,
                     int columnIndex,
                     org.apache.poi.ss.usermodel.Row row,
                     boolean use1904Dates)
```
- Method Detail
  - getNumericFormat
```
public java.lang.String getNumericFormat()
```
  - setCellStyle
```
public void setCellStyle(org.apache.poi.ss.usermodel.CellStyle cellStyle)
```
    Specified by:
    
    setCellStyle in interface org.apache.poi.ss.usermodel.Cell
  - getColumnIndex
```
public int getColumnIndex()
```
    Returns column index of this cell
    
    Specified by:
    
    getColumnIndex in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    zero-based column index of a column in a sheet.
  - getRowIndex
```
public int getRowIndex()
```
    Returns row index of a row in the sheet that contains this cell
    
    Specified by:
    
    getRowIndex in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    zero-based row index of a row in the sheet that contains this cell
  - getRow
```
public org.apache.poi.ss.usermodel.Row getRow()
```
    Row is not guaranteed to be set. Will return null when row is not set.
    
    Specified by:
    
    getRow in interface org.apache.poi.ss.usermodel.Cell
  - getSheet
```
public org.apache.poi.ss.usermodel.Sheet getSheet()
```
    Specified by:
    
    getSheet in interface org.apache.poi.ss.usermodel.Cell
  - getCellType
```
public org.apache.poi.ss.usermodel.CellType getCellType()
```
    Return the cell type.
    
    Specified by:
    
    getCellType in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the cell type
  - getStringCellValue
```
public java.lang.String getStringCellValue()
```
    Get the value of the cell as a string. For blank cells we return an empty string.
    
    Specified by:
    
    getStringCellValue in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the value of the cell as a string
  - getNumericCellValue
```
public double getNumericCellValue()
```
    Get the value of the cell as a number. For strings we throw an exception. For blank cells we return a 0.
    
    Specified by:
    
    getNumericCellValue in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the value of the cell as a number
    
    Throws:
    
    java.lang.NumberFormatException - if the cell value isn't a parseable double.
  - getDateCellValue
```
public java.util.Date getDateCellValue()
```
    Get the value of the cell as a date. For strings we throw an exception. For blank cells we return a null.
    
    Specified by:
    
    getDateCellValue in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the value of the cell as a date
    
    Throws:
    
    java.lang.IllegalStateException - if the cell type returned by getCellType() is CELL_TYPE_STRING
    
    java.lang.NumberFormatException - if the cell value isn't a parseable double.
  - getBooleanCellValue
```
public boolean getBooleanCellValue()
```
    Get the value of the cell as a boolean. For strings we throw an exception. For blank cells we return a false.
    
    Specified by:
    
    getBooleanCellValue in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the value of the cell as a date
  - getCellStyle
```
public org.apache.poi.ss.usermodel.CellStyle getCellStyle()
```
    Specified by:
    
    getCellStyle in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the style of the cell
  - getCellFormula
```
public java.lang.String getCellFormula()
```
    Return a formula for the cell, for example, SUM(C4:E4)
    
    Specified by:
    
    getCellFormula in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    a formula for the cell
    
    Throws:
    
    java.lang.IllegalStateException - if the cell type returned by getCellType() is not CELL_TYPE_FORMULA or if the cell has a shared formula that can't be evaluated
  - getRichStringCellValue
```
public org.apache.poi.xssf.usermodel.XSSFRichTextString getRichStringCellValue()
```
    Get the value of the cell as a XSSFRichTextString
    For numeric cells we throw an exception. For blank cells we return an empty string. For formula cells we return the pre-calculated value if a string, otherwise an exception
    
    Specified by:
    
    getRichStringCellValue in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the value of the cell as a XSSFRichTextString
    
    Throws:
    
    NotSupportedException - if the cell type is unsupported
  - getCachedFormulaResultType
```
public org.apache.poi.ss.usermodel.CellType getCachedFormulaResultType()
```
    Only valid for formula cells
    
    Specified by:
    
    getCachedFormulaResultType in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    one of (CellType.NUMERIC, CellType.STRING, CellType.BOOLEAN, CellType.ERROR) depending on the cached value of the formula
    
    Throws:
    
    java.lang.IllegalStateException - if cell is not formula type
    
    NotSupportedException - if cell formula type is unknown
  - getLocalDateTimeCellValue
```
public java.time.LocalDateTime getLocalDateTimeCellValue()
```
    Specified by:
    
    getLocalDateTimeCellValue in interface org.apache.poi.ss.usermodel.Cell
  - getErrorCellValue
```
public byte getErrorCellValue()
```
    Specified by:
    
    getErrorCellValue in interface org.apache.poi.ss.usermodel.Cell
  - getAddress
```
public org.apache.poi.ss.util.CellAddress getAddress()
```
    Specified by:
    
    getAddress in interface org.apache.poi.ss.usermodel.Cell
  - getCellComment
```
public org.apache.poi.ss.usermodel.Comment getCellComment()
```
    Returns cell comment associated with this cell
    
    Specified by:
    
    getCellComment in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the cell comment associated with this cell or null
    
    Throws:
    
    java.lang.IllegalStateException - if StreamingReader.Builder.setReadComments(boolean) is not set to true
  - getHyperlink
```
public org.apache.poi.ss.usermodel.Hyperlink getHyperlink()
```
    Returns hyperlink associated with this cell. This is not recommended as this data is stored at the end of the sheet. Use the hyperlink methods on sheet instance instead or keep this cell instance in memory until after all the rows have been read.
    
    Specified by:
    
    getHyperlink in interface org.apache.poi.ss.usermodel.Cell
    
    Returns:
    
    the hyperlink associated with this cell or null
    
    Throws:
    
    java.lang.IllegalStateException - if StreamingReader.Builder.setReadHyperlinks(boolean) is not set to true
  - setCellType
```
public void setCellType(org.apache.poi.ss.usermodel.CellType cellType)
```
    Update operations are not supported
    
    Specified by:
    
    setCellType in interface org.apache.poi.ss.usermodel.Cell
  - setBlank
```
public void setBlank()
```
    Update operations are not supported
    
    Specified by:
    
    setBlank in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(double value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(java.util.Date value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(java.util.Calendar value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(java.time.LocalDate value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(java.time.LocalDateTime value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(org.apache.poi.ss.usermodel.RichTextString value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellValue
```
public void setCellValue(java.lang.String value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellFormula
```
public void setCellFormula(java.lang.String formula)
                    throws org.apache.poi.ss.formula.FormulaParseException
```
    Update operations are not supported
    
    Specified by:
    
    setCellFormula in interface org.apache.poi.ss.usermodel.Cell
    
    Throws:
    
    org.apache.poi.ss.formula.FormulaParseException
  - removeFormula
```
public void removeFormula()
                   throws java.lang.IllegalStateException
```
    Update operations are not supported
    
    Specified by:
    
    removeFormula in interface org.apache.poi.ss.usermodel.Cell
    
    Throws:
    
    java.lang.IllegalStateException
  - setCellValue
```
public void setCellValue(boolean value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellValue in interface org.apache.poi.ss.usermodel.Cell
  - setCellErrorValue
```
public void setCellErrorValue(byte value)
```
    Update operations are not supported
    
    Specified by:
    
    setCellErrorValue in interface org.apache.poi.ss.usermodel.Cell
  - setAsActiveCell
```
public void setAsActiveCell()
```
    Update operations are not supported
    
    Specified by:
    
    setAsActiveCell in interface org.apache.poi.ss.usermodel.Cell
  - setCellComment
```
public void setCellComment(org.apache.poi.ss.usermodel.Comment comment)
```
    Update operations are not supported
    
    Specified by:
    
    setCellComment in interface org.apache.poi.ss.usermodel.Cell
  - removeCellComment
```
public void removeCellComment()
```
    Update operations are not supported
    
    Specified by:
    
    removeCellComment in interface org.apache.poi.ss.usermodel.Cell
  - setHyperlink
```
public void setHyperlink(org.apache.poi.ss.usermodel.Hyperlink link)
```
    Update operations are not supported
    
    Specified by:
    
    setHyperlink in interface org.apache.poi.ss.usermodel.Cell
  - removeHyperlink
```
public void removeHyperlink()
```
    Update operations are not supported
    
    Specified by:
    
    removeHyperlink in interface org.apache.poi.ss.usermodel.Cell
  - getArrayFormulaRange
```
public org.apache.poi.ss.util.CellRangeAddress getArrayFormulaRange()
```
    Not supported
    
    Specified by:
    
    getArrayFormulaRange in interface org.apache.poi.ss.usermodel.Cell
  - isPartOfArrayFormulaGroup
```
public boolean isPartOfArrayFormulaGroup()
```
    Not supported
    
    Specified by:
    
    isPartOfArrayFormulaGroup in interface org.apache.poi.ss.usermodel.Cell

Class StreamingCell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamingCell

StreamingCell

Method Detail

getNumericFormat

setCellStyle

getColumnIndex

getRowIndex

getRow

getSheet

getCellType

getStringCellValue

getNumericCellValue

getDateCellValue

getBooleanCellValue

getCellStyle

getCellFormula

getRichStringCellValue

getCachedFormulaResultType

getLocalDateTimeCellValue

getErrorCellValue

getAddress

getCellComment

getHyperlink

setCellType

setBlank

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellFormula

removeFormula

setCellValue

setCellErrorValue

setAsActiveCell

setCellComment

removeCellComment

setHyperlink

removeHyperlink

getArrayFormulaRange

isPartOfArrayFormulaGroup