SXSSFCell (Keikai Spreadsheet Build 5.0.0 API)

java.lang.Object
- org.zkoss.poi.xssf.streaming.SXSSFCell

All Implemented Interfaces:

Cell
```
public class SXSSFCell
extends Object
implements Cell
```
Streaming version of XSSFRow implementing the "BigGridDemo" strategy.

Author:

Alex Geller, Four J's Development Tools

Field Summary
- Fields inherited from interface org.zkoss.poi.ss.usermodel.Cell
  CELL_TYPE_BLANK, CELL_TYPE_BOOLEAN, CELL_TYPE_ERROR, CELL_TYPE_FORMULA, CELL_TYPE_NUMERIC, CELL_TYPE_STRING

Constructor Summary

Constructors
Constructor and Description

SXSSFCell(SXSSFRow row, int cellType)

Constructors
Constructor and Description
`SXSSFCell(SXSSFRow row, int cellType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CellRangeAddress`	`getArrayFormulaRange()` Only valid for array formula cells
`boolean`	`getBooleanCellValue()` Get the value of the cell as a boolean.
`int`	`getCachedFormulaResultType()` Only valid for formula cells
`Comment`	`getCellComment()` Returns comment associated with this cell
`String`	`getCellFormula()` Return a formula for the cell, for example, `SUM(C4:E4)`
`CellStyle`	`getCellStyle()` Return the cell's style.
`int`	`getCellType()` Return the cell type.
`int`	`getColumnIndex()` Returns column index of this cell
`Date`	`getDateCellValue()` Get the value of the cell as a date.
`byte`	`getErrorCellValue()` Get the value of the cell as an error code.
`Hyperlink`	`getHyperlink()`
`double`	`getNumericCellValue()` Get the value of the cell as a number.
`RichTextString`	`getRichStringCellValue()` Get the value of the cell as a XSSFRichTextString
`Row`	`getRow()` Returns the Row this cell belongs to
`int`	`getRowIndex()` Returns row index of a row in the sheet that contains this cell
`Sheet`	`getSheet()` Returns the sheet this cell belongs to
`String`	`getStringCellValue()` Get the value of the cell as a string
`boolean`	`isCalcOnLoad()` Old Excel spec(Used in old XLS Excel).
`boolean`	`isPartOfArrayFormulaGroup()`
`void`	`removeCellComment()` Removes the comment for this cell, if there is one.
`void`	`setAsActiveCell()` Sets this cell as the active cell for the worksheet
`void`	`setCellComment(Comment comment)` Assign a comment to this cell
`void`	`setCellErrorValue(byte value)` Set a error value for the cell
`void`	`setCellFormula(String formula)` Sets formula for this cell.
`void`	`setCellStyle(CellStyle style)` Set the style for the cell.
`void`	`setCellType(int cellType)` Set the cells type (numeric, formula or string)
`void`	`setCellValue(boolean value)` Set a boolean value for the cell
`void`	`setCellValue(Calendar value)` Set a date value for the cell.
`void`	`setCellValue(Date value)` Converts the supplied date to its equivalent Excel numeric value and sets that into the cell.
`void`	`setCellValue(double value)` Set a numeric value for the cell
`void`	`setCellValue(RichTextString value)` Set a rich string value for the cell.
`void`	`setCellValue(String value)` Set a string value for the cell.
`void`	`setHyperlink(Hyperlink link)` Assign a hyperlink to this cell
`String`	`toString()` Returns a string representation of the cell

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

- Constructor Detail
  - SXSSFCell
```
public SXSSFCell(SXSSFRow row,
                 int cellType)
```
- Method Detail
  - getColumnIndex
```
public int getColumnIndex()
```
    Returns column index of this cell
    
    Specified by:
    
    getColumnIndex in interface 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 Cell
    
    Returns:
    
    zero-based row index of a row in the sheet that contains this cell
  - getSheet
```
public Sheet getSheet()
```
    Returns the sheet this cell belongs to
    
    Specified by:
    
    getSheet in interface Cell
    
    Returns:
    
    the sheet this cell belongs to
  - getRow
```
public Row getRow()
```
    Returns the Row this cell belongs to
    
    Specified by:
    
    getRow in interface Cell
    
    Returns:
    
    the Row that owns this cell
  - setCellType
```
public void setCellType(int cellType)
```
    Set the cells type (numeric, formula or string)
    
    Specified by:
    
    setCellType in interface Cell
    
    Throws:
    
    IllegalArgumentException - if the specified cell type is invalid
    
    See Also:
    
    Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_FORMULA, Cell.CELL_TYPE_BLANK, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  - getCellType
```
public int getCellType()
```
    Return the cell type.
    
    Specified by:
    
    getCellType in interface Cell
    
    Returns:
    
    the cell type
    
    See Also:
    
    Cell.CELL_TYPE_BLANK, Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_FORMULA, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  - getCachedFormulaResultType
```
public int getCachedFormulaResultType()
```
    Only valid for formula cells
    
    Specified by:
    
    getCachedFormulaResultType in interface Cell
    
    Returns:
    
    one of (Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR) depending on the cached value of the formula
  - setCellValue
```
public void setCellValue(double value)
```
    Set a numeric value for the cell
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - the numeric value to set this cell to. For formulas we'll set the precalculated value, for numerics we'll set its value. For other types we will change the cell to a numeric cell and set its value.
  - setCellValue
```
public void setCellValue(Date value)
```
    Converts the supplied date to its equivalent Excel numeric value and sets that into the cell.
    Note - There is actually no 'DATE' cell type in Excel. In many cases (when entering date values), Excel automatically adjusts the cell style to some date format, creating the illusion that the cell data type is now something besides Cell.CELL_TYPE_NUMERIC. POI does not attempt to replicate this behaviour. To make a numeric cell display as a date, use setCellStyle(CellStyle) etc.
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - the numeric value to set this cell to. For formulas we'll set the precalculated value, for numerics we'll set its value. For other types we will change the cell to a numerics cell and set its value.
  - setCellValue
```
public void setCellValue(Calendar value)
```
    Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as a date.
    This will set the cell value based on the Calendar's timezone. As Excel does not support timezones this means that both 20:00+03:00 and 20:00-03:00 will be reported as the same value (20:00) even that there are 6 hours difference between the two times. This difference can be preserved by using setCellValue(value.getTime()) which will automatically shift the times to the default timezone.
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - the date value to set this cell to. For formulas we'll set the precalculated value, for numerics we'll set its value. For othertypes we will change the cell to a numeric cell and set its value.
  - setCellValue
```
public void setCellValue(RichTextString value)
```
    Set a rich string value for the cell.
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - value to set the cell to. For formulas we'll set the formula string, for String cells we'll set its value. For other types we will change the cell to a string cell and set its value. If value is null then we will change the cell to a Blank cell.
  - setCellValue
```
public void setCellValue(String value)
```
    Set a string value for the cell.
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - value to set the cell to. For formulas we'll set the formula string, for String cells we'll set its value. For other types we will change the cell to a string cell and set its value. If value is null then we will change the cell to a Blank cell.
  - setCellFormula
```
public void setCellFormula(String formula)
                    throws FormulaParseException
```
    Sets formula for this cell.
    Note, this method only sets the formula string and does not calculate the formula value. To set the precalculated value use setCellValue(double) or setCellValue(String)
    
    Specified by:
    
    setCellFormula in interface Cell
    
    Parameters:
    
    formula - the formula to set, e.g. "SUM(C4:E4)". If the argument is null then the current formula is removed.
    
    Throws:
    
    FormulaParseException - if the formula has incorrect syntax or is otherwise invalid
  - getCellFormula
```
public String getCellFormula()
```
    Return a formula for the cell, for example, SUM(C4:E4)
    
    Specified by:
    
    getCellFormula in interface Cell
    
    Returns:
    
    a formula for the cell
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is not CELL_TYPE_FORMULA
  - 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. For formulas or error cells we return the precalculated value;
    
    Specified by:
    
    getNumericCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a number
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is CELL_TYPE_STRING
    
    NumberFormatException - if the cell value isn't a parsable double.
    
    See Also:
    
    for turning this number into a string similar to that which Excel would render this number as.
  - getDateCellValue
```
public 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 Cell
    
    Returns:
    
    the value of the cell as a date
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is CELL_TYPE_STRING
    
    NumberFormatException - if the cell value isn't a parsable double.
    
    See Also:
    
    for formatting this date into a string similar to how excel does.
  - getRichStringCellValue
```
public RichTextString 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 Cell
    
    Returns:
    
    the value of the cell as a XSSFRichTextString
  - getStringCellValue
```
public String getStringCellValue()
```
    Get the value of the cell as a string
    For numeric cells we throw an exception. For blank cells we return an empty string. For formulaCells that are not string Formulas, we throw an exception.
    
    Specified by:
    
    getStringCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a string
  - setCellValue
```
public void setCellValue(boolean value)
```
    Set a boolean value for the cell
    
    Specified by:
    
    setCellValue in interface Cell
    
    Parameters:
    
    value - the boolean value to set this cell to. For formulas we'll set the precalculated value, for booleans we'll set its value. For other types we will change the cell to a boolean cell and set its value.
  - setCellErrorValue
```
public void setCellErrorValue(byte value)
```
    Set a error value for the cell
    
    Specified by:
    
    setCellErrorValue in interface Cell
    
    Parameters:
    
    value - the error value to set this cell to. For formulas we'll set the precalculated value , for errors we'll set its value. For other types we will change the cell to an error cell and set its value.
    
    See Also:
    
    FormulaError
  - getBooleanCellValue
```
public boolean getBooleanCellValue()
```
    Get the value of the cell as a boolean.
    For strings, numbers, and errors, we throw an exception. For blank cells we return a false.
    
    Specified by:
    
    getBooleanCellValue in interface Cell
    
    Returns:
    
    the value of the cell as a boolean
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() is not CELL_TYPE_BOOLEAN, CELL_TYPE_BLANK or CELL_TYPE_FORMULA
  - getErrorCellValue
```
public byte getErrorCellValue()
```
    Get the value of the cell as an error code.
    For strings, numbers, and booleans, we throw an exception. For blank cells we return a 0.
    
    Specified by:
    
    getErrorCellValue in interface Cell
    
    Returns:
    
    the value of the cell as an error code
    
    Throws:
    
    IllegalStateException - if the cell type returned by getCellType() isn't CELL_TYPE_ERROR
    
    See Also:
    
    for error codes
  - setCellStyle
```
public void setCellStyle(CellStyle style)
```
    Set the style for the cell. The style should be an CellStyle created/retreived from the Workbook.
    
    Specified by:
    
    setCellStyle in interface Cell
    
    Parameters:
    
    style - reference contained in the workbook. If the value is null then the style information is removed causing the cell to used the default workbook style.
    
    See Also:
    
    Workbook.createCellStyle()
  - getCellStyle
```
public CellStyle getCellStyle()
```
    Return the cell's style.
    
    Specified by:
    
    getCellStyle in interface Cell
    
    Returns:
    
    the cell's style. Always not-null. Default cell style has zero index and can be obtained as workbook.getCellStyleAt(0)
    
    See Also:
    
    org.zkoss.poi.ss.usermodel.Workbook#getCellStyleAt(short)
  - setAsActiveCell
```
public void setAsActiveCell()
```
    Sets this cell as the active cell for the worksheet
    
    Specified by:
    
    setAsActiveCell in interface Cell
  - setCellComment
```
public void setCellComment(Comment comment)
```
    Assign a comment to this cell
    
    Specified by:
    
    setCellComment in interface Cell
    
    Parameters:
    
    comment - comment associated with this cell
  - getCellComment
```
public Comment getCellComment()
```
    Returns comment associated with this cell
    
    Specified by:
    
    getCellComment in interface Cell
    
    Returns:
    
    comment associated with this cell or null if not found
  - removeCellComment
```
public void removeCellComment()
```
    Removes the comment for this cell, if there is one.
    
    Specified by:
    
    removeCellComment in interface Cell
  - getHyperlink
```
public Hyperlink getHyperlink()
```
    Specified by:
    
    getHyperlink in interface Cell
    
    Returns:
    
    hyperlink associated with this cell or null if not found
  - setHyperlink
```
public void setHyperlink(Hyperlink link)
```
    Assign a hyperlink to this cell
    
    Specified by:
    
    setHyperlink in interface Cell
    
    Parameters:
    
    link - hyperlink associated with this cell
  - getArrayFormulaRange
```
public CellRangeAddress getArrayFormulaRange()
```
    Only valid for array formula cells
    
    Specified by:
    
    getArrayFormulaRange in interface Cell
    
    Returns:
    
    range of the array formula group that the cell belongs to.
  - isPartOfArrayFormulaGroup
```
public boolean isPartOfArrayFormulaGroup()
```
    Specified by:
    
    isPartOfArrayFormulaGroup in interface Cell
    
    Returns:
    
    true if this cell is part of group of cells having a common array formula.
  - toString
```
public String toString()
```
    Returns a string representation of the cell
    Formula cells return the formula string, rather than the formula result. Dates are displayed in dd-MMM-yyyy format Errors are displayed as #ERR<errIdx>
    
    Overrides:
    
    toString in class Object
  - isCalcOnLoad
```
public boolean isCalcOnLoad()
```
    Description copied from interface: Cell
    
    Old Excel spec(Used in old XLS Excel). Because we want to load cached formula result; we have to honer this flag; or we could read in incorrect cached results! (ZSS-873: issue/book/492-movesheet.xls)
    
    Specified by:
    
    isCalcOnLoad in interface Cell
    
    Returns:
    
    true if need calcOnLoad for the cell.

Class SXSSFCell

Field Summary

Fields inherited from interface org.zkoss.poi.ss.usermodel.Cell

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SXSSFCell

Method Detail

getColumnIndex

getRowIndex

getSheet

getRow

setCellType

getCellType

getCachedFormulaResultType

setCellValue

setCellValue

setCellValue

setCellValue

setCellValue

setCellFormula

getCellFormula

getNumericCellValue

getDateCellValue

getRichStringCellValue

getStringCellValue

setCellValue

setCellErrorValue

getBooleanCellValue

getErrorCellValue

setCellStyle

getCellStyle

setAsActiveCell

setCellComment

getCellComment

removeCellComment

getHyperlink

setHyperlink

getArrayFormulaRange

isPartOfArrayFormulaGroup

toString

isCalcOnLoad