Class XSSFCell
- java.lang.Object
-
- org.apache.poi.ss.usermodel.CellBase
-
- org.apache.poi.xssf.usermodel.XSSFCell
-
- All Implemented Interfaces:
Cell
public final class XSSFCell extends CellBase
High level representation of a cell in a row of a spreadsheet.Cells can be numeric, formula-based or string-based (text). The cell type specifies this. String cells cannot contain numbers and numeric cells cannot contain strings (at least according to our model). Client apps should do the conversions themselves. Formula cells have the formula string, as well as the formula result, which can be numeric or string.
Cells should have their number (0 based) before being added to a row. Only cells that have values should be added.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
copyCellFrom(Cell srcCell, CellCopyPolicy policy)
Copy cell value, formula and style, from srcCell per cell copy policy If srcCell is null, clears the cell value and cell style per cell copy policy This does not shift references in formulas.CellRangeAddress
getArrayFormulaRange()
Only valid for array formula cellsboolean
getBooleanCellValue()
Get the value of the cell as a boolean.CellType
getCachedFormulaResultType()
Only valid for formula cellsXSSFComment
getCellComment()
Returns cell comment associated with this celljava.lang.String
getCellFormula()
Return a formula for the cell, for example,SUM(C4:E4)
XSSFCellStyle
getCellStyle()
Return the cell's style.CellType
getCellType()
Return the cell type.int
getColumnIndex()
Returns column index of this cellCTCell
getCTCell()
Returns the xml bean containing information about the cell's location (reference), value, data type, formatting, and formulajava.util.Date
getDateCellValue()
Get the value of the cell as a date.java.lang.String
getErrorCellString()
Returns the error message, such as #VALUE!byte
getErrorCellValue()
Get the value of the cell as an error code.XSSFHyperlink
getHyperlink()
Returns hyperlink associated with this celljava.time.LocalDateTime
getLocalDateTimeCellValue()
Get the value of the cell as a LocalDateTime.double
getNumericCellValue()
Get the value of the cell as a number.java.lang.String
getRawValue()
Returns the raw, underlying ooxml value for the celljava.lang.String
getReference()
Returns an A1 style reference to the location of this cellXSSFRichTextString
getRichStringCellValue()
Get the value of the cell as a XSSFRichTextStringXSSFRow
getRow()
Returns the row this cell belongs toint
getRowIndex()
Returns row index of a row in the sheet that contains this cellXSSFSheet
getSheet()
Returns the sheet this cell belongs tojava.lang.String
getStringCellValue()
Get the value of the cell as a stringboolean
isPartOfArrayFormulaGroup()
void
removeCellComment()
Removes the comment for this cell, if there is one.void
removeHyperlink()
Removes the hyperlink for this cell, if there is one.void
setAsActiveCell()
Sets this cell as the active cell for the worksheetvoid
setCellComment(Comment comment)
Assign a comment to this cell.void
setCellErrorValue(byte errorCode)
Set a error value for the cellvoid
setCellErrorValue(FormulaError error)
Set a error value for the cellvoid
setCellStyle(CellStyle style)
Set the style for the cell.void
setCellValue(boolean value)
Set a boolean value for the cellvoid
setCellValueImpl(double value)
void
setCTCell(CTCell cell)
Set a new internal xml bean.void
setHyperlink(Hyperlink hyperlink)
Assign a hyperlink to this cell.java.lang.String
toString()
Returns a string representation of the cellvoid
updateCellReferencesForShifting(java.lang.String msg)
-
Methods inherited from class org.apache.poi.ss.usermodel.CellBase
getAddress, removeFormula, setBlank, setCellFormula, setCellType, setCellValue, setCellValue, setCellValue, setCellValue, setCellValue, setCellValue, tryToDeleteArrayFormula
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.ss.usermodel.Cell
setCellValue
-
-
-
-
Method Detail
-
copyCellFrom
@Beta public void copyCellFrom(Cell srcCell, CellCopyPolicy policy)
Copy cell value, formula and style, from srcCell per cell copy policy If srcCell is null, clears the cell value and cell style per cell copy policy This does not shift references in formulas. UseXSSFRowShifter
to shift references in formulas.- Parameters:
srcCell
- The cell to take value, formula and style frompolicy
- The policy for copying the information, seeCellCopyPolicy
- Throws:
java.lang.IllegalArgumentException
- if copy cell style and srcCell is from a different workbook- See Also:
CellUtil.copyCell(Cell, Cell, CellCopyPolicy, CellCopyContext)
-
getSheet
public XSSFSheet getSheet()
Returns the sheet this cell belongs to- Returns:
- the sheet this cell belongs to
-
getRow
public XSSFRow getRow()
Returns the row this cell belongs to- Returns:
- the row this cell belongs to
-
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.
- Returns:
- the value of the cell as a boolean
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
is notCellType.BOOLEAN
,CellType.BLANK
orCellType.FORMULA
-
setCellValue
public void setCellValue(boolean value)
Set a boolean value for the 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.
-
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;
- Returns:
- the value of the cell as a number
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
isCellType.STRING
java.lang.NumberFormatException
- if the cell value isn't a parsabledouble
.- See Also:
for turning this number into a string similar to that which Excel would render this number as.
-
setCellValueImpl
public void setCellValueImpl(double value)
-
getStringCellValue
public java.lang.String getStringCellValue()
Get the value of the cell as a stringFor 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
- Returns:
- the value of the cell as a string
-
getRichStringCellValue
public XSSFRichTextString getRichStringCellValue()
Get the value of the cell as a XSSFRichTextStringFor 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
- Returns:
- the value of the cell as a XSSFRichTextString
-
getCellFormula
public java.lang.String getCellFormula()
Return a formula for the cell, for example,SUM(C4:E4)
- Returns:
- a formula for the cell
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
is notCellType.FORMULA
-
getColumnIndex
public int getColumnIndex()
Returns column index of this 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- Returns:
- zero-based row index of a row in the sheet that contains this cell
-
getReference
public java.lang.String getReference()
Returns an A1 style reference to the location of this cell- Returns:
- A1 style reference to the location of this cell
-
getCellStyle
public XSSFCellStyle getCellStyle()
Return the cell's style. Since POI v5.2.3, this returns the column style if the cell has no style of its own. If no column default style is set, the row default style is checked. This method has always fallen back to return the default style if there is no other style to return.- Returns:
- the cell's style.
- See Also:
Workbook.getCellStyleAt(int)
-
setCellStyle
public void setCellStyle(CellStyle style)
Set the style for the cell. The style should be an XSSFCellStyle created/retrieved from the XSSFWorkbook.
To change the style of a cell without affecting other cells that use the same style, use
CellUtil.setCellStyleProperties(Cell, java.util.Map)
- 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.- Throws:
java.lang.IllegalArgumentException
- if style belongs to a different styles source (most likely because style is from a different Workbook)- See Also:
Workbook.createCellStyle()
-
getCellType
public CellType getCellType()
Return the cell type. Tables in an array formula returnCellType.FORMULA
for all cells, even though the formula is only defined in the OOXML file for the top left cell of the array.NOTE: POI does not support data table formulas. Cells in a data table appear to POI as plain cells typed from their cached value.
- Returns:
- the cell type
-
getCachedFormulaResultType
public CellType getCachedFormulaResultType()
Only valid for formula cells- Returns:
- one of (
CellType.NUMERIC
,CellType.STRING
,CellType.BOOLEAN
,CellType.ERROR
) depending on the cached value of the formula
-
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.
- Returns:
- the value of the cell as a date
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
isCellType.STRING
java.lang.NumberFormatException
- if the cell value isn't a parsabledouble
.- See Also:
for formatting this date into a string similar to how excel does.
-
getLocalDateTimeCellValue
public java.time.LocalDateTime getLocalDateTimeCellValue()
Get the value of the cell as a LocalDateTime.For strings we throw an exception. For blank cells we return a null.
- Returns:
- the value of the cell as a LocalDateTime
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
isCellType.STRING
java.lang.NumberFormatException
- if the cell value isn't a parsabledouble
.- See Also:
for formatting this date into a string similar to how excel does.
-
getErrorCellString
public java.lang.String getErrorCellString() throws java.lang.IllegalStateException
Returns the error message, such as #VALUE!- Returns:
- the error message such as #VALUE!
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
isn'tCellType.ERROR
- See Also:
FormulaError
-
getErrorCellValue
public byte getErrorCellValue() throws java.lang.IllegalStateException
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.
- Returns:
- the value of the cell as an error code
- Throws:
java.lang.IllegalStateException
- if the cell type returned bygetCellType()
isn't#ERROR
- See Also:
FormulaError
-
setCellErrorValue
public void setCellErrorValue(byte errorCode)
Set a error value for the cell- Parameters:
errorCode
- 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
-
setCellErrorValue
public void setCellErrorValue(FormulaError error)
Set a error value for the cell- Parameters:
error
- 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.
-
setAsActiveCell
public void setAsActiveCell()
Description copied from interface:Cell
Sets this cell as the active cell for the worksheet
-
toString
public java.lang.String toString()
Returns a string representation of the cellFormula 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 classjava.lang.Object
-
getRawValue
public java.lang.String getRawValue()
Returns the raw, underlying ooxml value for the cellIf the cell contains a string, then this value is an index into the shared string table, pointing to the actual string value. Otherwise, the value of the cell is expressed directly in this element. Cells containing formulas express the last calculated result of the formula in this element.
- Returns:
- the raw cell value as contained in the underlying CTCell bean,
null
for blank cells.
-
getCellComment
public XSSFComment getCellComment()
Returns cell comment associated with this cell- Returns:
- the cell comment associated with this cell or
null
-
setCellComment
public void setCellComment(Comment comment)
Assign a comment to this cell. If the supplied comment is null, the comment for this cell will be removed.- Parameters:
comment
- the XSSFComment associated with this cell
-
removeCellComment
public void removeCellComment()
Removes the comment for this cell, if there is one.
-
getHyperlink
public XSSFHyperlink getHyperlink()
Returns hyperlink associated with this cell- Returns:
- hyperlink associated with this cell or
null
if not found
-
setHyperlink
public void setHyperlink(Hyperlink hyperlink)
Assign a hyperlink to this cell. If the supplied hyperlink is null, the hyperlink for this cell will be removed.- Parameters:
hyperlink
- the hyperlink to associate with this cell
-
removeHyperlink
public void removeHyperlink()
Removes the hyperlink for this cell, if there is one.
-
getCTCell
@Internal public CTCell getCTCell()
Returns the xml bean containing information about the cell's location (reference), value, data type, formatting, and formula- Returns:
- the xml bean containing information about this cell
-
setCTCell
@Internal public void setCTCell(CTCell cell)
Set a new internal xml bean. This is only for internal use, do not call this from outside! This is necessary in some rare cases to work around XMLBeans specialties.
-
getArrayFormulaRange
public CellRangeAddress getArrayFormulaRange()
Description copied from interface:Cell
Only valid for array formula cells- Returns:
- range of the array formula group that the cell belongs to.
-
isPartOfArrayFormulaGroup
public boolean isPartOfArrayFormulaGroup()
- Returns:
true
if this cell is part of group of cells having a common array formula.
-
updateCellReferencesForShifting
public void updateCellReferencesForShifting(java.lang.String msg)
-
-