Package org.apache.poi.hssf.usermodel
Class HSSFCell
- java.lang.Object
-
- org.apache.poi.ss.usermodel.CellBase
-
- org.apache.poi.hssf.usermodel.HSSFCell
-
- All Implemented Interfaces:
Cell
public class HSSFCell 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.
-
-
Field Summary
Fields Modifier and Type Field Description static short
ENCODING_COMPRESSED_UNICODE
static short
ENCODING_UNCHANGED
static short
ENCODING_UTF_16
static int
LAST_COLUMN_NUMBER
The maximum number of columns in BIFF8
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CellRangeAddress
getArrayFormulaRange()
Only valid for array formula cellsboolean
getBooleanCellValue()
get the value of the cell as a boolean.CellType
getCachedFormulaResultType()
Only valid for formula cellsHSSFComment
getCellComment()
Returns comment associated with this celljava.lang.String
getCellFormula()
Return a formula for the cell, for example,SUM(C4:E4)
HSSFCellStyle
getCellStyle()
get the style for the cell.CellType
getCellType()
get the cells type (numeric, formula or string)int
getColumnIndex()
Returns column index of this celljava.util.Date
getDateCellValue()
Get the value of the cell as a date.byte
getErrorCellValue()
get the value of the cell as an error code.HSSFHyperlink
getHyperlink()
java.time.LocalDateTime
getLocalDateTimeCellValue()
Get the value of the cell as a LocalDateTime.double
getNumericCellValue()
Get the value of the cell as a number.HSSFRichTextString
getRichStringCellValue()
get the value of the cell as a string - for numeric cells we throw an exception.HSSFRow
getRow()
Returns the HSSFRow this cell belongs toint
getRowIndex()
Returns row index of a row in the sheet that contains this cellHSSFSheet
getSheet()
Returns the HSSFSheet this cell belongs tojava.lang.String
getStringCellValue()
get the value of the cell as a string - for numeric cells we throw an exception.boolean
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)
Deprecated.3.15 beta 2.void
setCellErrorValue(FormulaError error)
set a error value for the cellvoid
setCellStyle(HSSFCellStyle style)
void
setCellStyle(CellStyle style)
Set the style for the cell.void
setCellValue(boolean value)
set a boolean value for the cellvoid
setHyperlink(Hyperlink hyperlink)
Assign a hyperlink to this cell.java.lang.String
toString()
Returns a string representation of the cell This method returns a simple representation, anything more complex should be in user code, with knowledge of the semantics of the sheet being processed.-
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
-
-
-
-
Field Detail
-
LAST_COLUMN_NUMBER
public static final int LAST_COLUMN_NUMBER
The maximum number of columns in BIFF8
-
ENCODING_UNCHANGED
public static final short ENCODING_UNCHANGED
- See Also:
- Constant Field Values
-
ENCODING_COMPRESSED_UNICODE
public static final short ENCODING_COMPRESSED_UNICODE
- See Also:
- Constant Field Values
-
ENCODING_UTF_16
public static final short ENCODING_UTF_16
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSheet
public HSSFSheet getSheet()
Returns the HSSFSheet this cell belongs to- Returns:
- the HSSFSheet that owns this cell
-
getRow
public HSSFRow getRow()
Returns the HSSFRow this cell belongs to- Returns:
- the HSSFRow that owns this cell
-
getRowIndex
public int getRowIndex()
Description copied from interface:Cell
Returns row index of a row in the sheet that contains this cell- Returns:
- the (zero based) index of the row containing this cell
-
getColumnIndex
public int getColumnIndex()
Description copied from interface:Cell
Returns column index of this cell- Returns:
- zero-based column index of a column in a sheet.
-
getCellType
public CellType getCellType()
get the cells type (numeric, formula or string)- Returns:
- the cell type
-
getCellFormula
public java.lang.String getCellFormula()
Description copied from interface:Cell
Return a formula for the cell, for example,SUM(C4:E4)
- Returns:
- a formula for the cell
-
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. SeeHSSFDataFormatter
for turning this number into a string similar to that which Excel would render this number as.- Returns:
- the value of the cell as a number
- See Also:
for turning this number into a string similar to that which Excel would render this number as.
-
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. SeeHSSFDataFormatter
for formatting this date into a string similar to how excel does.- Returns:
- the value of the cell as a date
- 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. SeeHSSFDataFormatter
for formatting this date into a string similar to how excel does.- Returns:
- the value of the cell as a LocalDateTime
- See Also:
for formatting this date into a string similar to how excel does.
-
getStringCellValue
public java.lang.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- Returns:
- the value of the cell as a string
-
getRichStringCellValue
public HSSFRichTextString getRichStringCellValue()
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- Returns:
- the value of the cell as a XSSFRichTextString
-
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.
-
setCellErrorValue
@Deprecated public void setCellErrorValue(byte errorCode)
Deprecated.3.15 beta 2. UsesetCellErrorValue(FormulaError)
instead.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. For error code byte, seeFormulaError
.- 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.
-
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
-
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.- Returns:
- the value of the cell as an error code
- See Also:
for error codes
-
setCellStyle
public void setCellStyle(CellStyle style)
Set the style for the cell. The style should be an HSSFCellStyle created/retrieved from the HSSFWorkbook.
To change the style of a cell without affecting other cells that use the same style, use
CellUtil.setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, java.util.Map)
- Parameters:
style
- reference contained in the workbook- See Also:
HSSFWorkbook.createCellStyle()
,HSSFWorkbook.getCellStyleAt(int)
-
setCellStyle
public void setCellStyle(HSSFCellStyle style)
-
getCellStyle
public HSSFCellStyle getCellStyle()
get the style for the cell. This is a reference to a cell style contained in the workbook object.- Returns:
- the cell's style. Always not-null. Default cell style has zero index and can be obtained as
workbook.getCellStyleAt(0)
- See Also:
HSSFWorkbook.getCellStyleAt(int)
-
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 cell This method returns a simple representation, anything more complex should be in user code, with knowledge of the semantics of the sheet being processed. 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 classjava.lang.Object
-
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
- comment associated with this cell
-
getCellComment
public HSSFComment getCellComment()
Returns comment associated with this cell- Returns:
- comment associated with this cell
-
removeCellComment
public void removeCellComment()
Removes the comment for this cell, if there is one. WARNING - some versions of excel will loose all comments after performing this action!
-
getHyperlink
public HSSFHyperlink getHyperlink()
- 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
- hyperlink associated with this cell
-
removeHyperlink
public void removeHyperlink()
Removes the hyperlink for this cell, if there is one.
-
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 - Since:
- POI 4.0
-
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.
-
-