Apache POI - Common 5.3.0 · org.apache.poi.hssf.usermodel.HSSFCell

Modifier and Type	Field and Description
private final HSSFWorkbook	_book
private CellType	_cellType
private HSSFComment	_comment
private CellValueRecordInterface	_record
private final HSSFSheet	_sheet
private HSSFRichTextString	_stringValue
public static final short	ENCODING_COMPRESSED_UNICODE
public static final short	ENCODING_UNCHANGED
public static final short	ENCODING_UTF_16
private static final String	FILE_FORMAT_NAME
private static final String	LAST_COLUMN_NAME
public static final int	LAST_COLUMN_NUMBER The maximum number of columns in BIFF8

Access	Constructor and Description
protected	HSSFCell(HSSFWorkbook - Workbook record of the workbook containing this cell book, HSSFSheet - Sheet record of the sheet containing this cell sheet, int - the row of this cell row, short - the column for this cell col) Creates new Cell - Should only be called by HSSFRow.
protected	HSSFCell(HSSFWorkbook - Workbook record of the workbook containing this cell book, HSSFSheet - Sheet record of the sheet containing this cell sheet, int - the row of this cell row, short - the column for this cell col, CellType - Type of cell type) Creates new Cell - Should only be called by HSSFRow.
protected	HSSFCell(HSSFWorkbook - Workbook record of the workbook containing this cell book, HSSFSheet - Sheet record of the sheet containing this cell sheet, CellValueRecordInterface - the Cell Value Record we wish to represent cval) Creates an HSSFCell from a CellValueRecordInterface.

Method Summary

Modifier and Type	Method and Description
private short	Returns: the index of a ExtendedFormatRecord record that will be referenced by the cell applyUserCellStyle(HSSFCellStyle the user style to apply style) Applying a user-defined style (UDS) is special.
private static void	checkBounds(int cellIndex)
private static void	checkFormulaCachedValueType(CellType expectedTypeCode, FormulaRecord fr)
private boolean	convertCellValueToBoolean() Chooses a new boolean value for the cell when its type is changing.
private String	convertCellValueToString()
private static CellType	determineType(CellValueRecordInterface cval) used internally -- given a cell value record, figure out its type
public CellRangeAddress	getArrayFormulaRange() Implements org.apache.poi.ss.usermodel.Cell.getArrayFormulaRange. Only valid for array formula cells
public boolean	getBooleanCellValue() Implements org.apache.poi.ss.usermodel.Cell.getBooleanCellValue. get the value of the cell as a boolean.
protected InternalWorkbook	getBoundWorkbook() Returns the Workbook that this Cell is bound to
public CellType	Returns: one of (`CellType#NUMERIC`, `CellType#STRING`, `CellType#BOOLEAN`, `CellType#ERROR`) depending on the cached value of the formula getCachedFormulaResultType() Implements org.apache.poi.ss.usermodel.Cell.getCachedFormulaResultType. Only valid for formula cells
public HSSFComment	Returns: comment associated with this cell getCellComment() Implements org.apache.poi.ss.usermodel.Cell.getCellComment. Returns comment associated with this cell
public String	getCellFormula() Implements org.apache.poi.ss.usermodel.Cell.getCellFormula. Return a formula for the cell, for example, `SUM(C4:E4)`
public HSSFCellStyle	getCellStyle() Implements org.apache.poi.ss.usermodel.Cell.getCellStyle. get the style for the cell.
public CellType	getCellType() Implements org.apache.poi.ss.usermodel.Cell.getCellType. get the cells type (numeric, formula or string)
protected CellValueRecordInterface	Returns: CellValueRecordInterface representing the cell via the low level api. getCellValueRecord() Should only be used by HSSFSheet and friends.
public int	getColumnIndex() Implements org.apache.poi.ss.usermodel.Cell.getColumnIndex. Returns column index of this cell
public Date	getDateCellValue() Implements org.apache.poi.ss.usermodel.Cell.getDateCellValue. Get the value of the cell as a date.
public byte	getErrorCellValue() Implements org.apache.poi.ss.usermodel.Cell.getErrorCellValue. get the value of the cell as an error code.
public HSSFHyperlink	Returns: hyperlink associated with this cell or `null` if not found getHyperlink() Implements org.apache.poi.ss.usermodel.Cell.getHyperlink.
public LocalDateTime	getLocalDateTimeCellValue() Implements org.apache.poi.ss.usermodel.Cell.getLocalDateTimeCellValue. Get the value of the cell as a LocalDateTime.
public double	getNumericCellValue() Implements org.apache.poi.ss.usermodel.Cell.getNumericCellValue. Get the value of the cell as a number.
public HSSFRichTextString	getRichStringCellValue() Implements org.apache.poi.ss.usermodel.Cell.getRichStringCellValue. get the value of the cell as a string - for numeric cells we throw an exception.
public HSSFRow	Returns: the HSSFRow that owns this cell getRow() Implements org.apache.poi.ss.usermodel.Cell.getRow. Returns the HSSFRow this cell belongs to
public int	Returns: the (zero based) index of the row containing this cell getRowIndex() Implements org.apache.poi.ss.usermodel.Cell.getRowIndex. Returns row index of a row in the sheet that contains this cell
public HSSFSheet	Returns: the HSSFSheet that owns this cell getSheet() Implements org.apache.poi.ss.usermodel.Cell.getSheet. Returns the HSSFSheet this cell belongs to
protected SpreadsheetVersion	getSpreadsheetVersion() Implements abstract org.apache.poi.ss.usermodel.CellBase.getSpreadsheetVersion. Get the spreadsheet version for the given implementation.
public String	getStringCellValue() Implements org.apache.poi.ss.usermodel.Cell.getStringCellValue. get the value of the cell as a string - for numeric cells we throw an exception.
public boolean	isPartOfArrayFormulaGroup() Implements org.apache.poi.ss.usermodel.Cell.isPartOfArrayFormulaGroup.
private void	notifyFormulaChanging() Should be called any time that a formula could potentially be deleted.
private CellValue	readValue()
public void	removeCellComment() Implements org.apache.poi.ss.usermodel.Cell.removeCellComment. Removes the comment for this cell, if there is one.
protected void	removeFormulaImpl() Implements abstract org.apache.poi.ss.usermodel.CellBase.removeFormulaImpl. Implementation-specific removal of the formula.
public void	removeHyperlink() Implements org.apache.poi.ss.usermodel.Cell.removeHyperlink. Removes the hyperlink for this cell, if there is one.
private void	restoreValue(CellValue value)
public void	setAsActiveCell() Implements org.apache.poi.ss.usermodel.Cell.setAsActiveCell. Sets this cell as the active cell for the worksheet
pack-priv void	setCellArrayFormula(CellRangeAddress range)
public void	setCellComment(Comment comment associated with this cell comment) Implements org.apache.poi.ss.usermodel.Cell.setCellComment. Assign a comment to this cell.
public void	setCellErrorValue(byte 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, see `FormulaError`. errorCode) Implements org.apache.poi.ss.usermodel.Cell.setCellErrorValue. Deprecated 3.15 beta 2. Use `setCellErrorValue(FormulaError)` instead. set an error value for the cell
public void	setCellErrorValue(FormulaError 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. error) set an error value for the cell
protected void	setCellFormulaImpl(String The text of the formula to set. formula) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellFormulaImpl. Implementation-specific setting the formula.
public void	setCellStyle(CellStyle reference contained in the workbook style) Implements org.apache.poi.ss.usermodel.Cell.setCellStyle. Set the style for the cell.
public void	setCellStyle(HSSFCellStyle style)
private void	setCellType(CellType cellType, boolean setValue, int row, short col, short styleIndex) sets the cell type.
protected void	setCellTypeImpl(CellType new cell type. Guaranteed non-null, not _NONE. cellType) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellTypeImpl. Implementation-specific logic
public void	setCellValue(boolean 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. value) Implements org.apache.poi.ss.usermodel.Cell.setCellValue. set a boolean value for the cell
protected void	setCellValueImpl(double the new value to set value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a numeric value.
protected void	setCellValueImpl(Date the new date to set value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a date value.
protected void	setCellValueImpl(LocalDateTime the new date to set value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a date value.
protected void	setCellValueImpl(Calendar the new calendar value to set value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a calendar value.
protected void	setCellValueImpl(String the new value to set. value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a string value.
protected void	setCellValueImpl(RichTextString the new value to set. value) Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl. Implementation-specific way to set a RichTextString value.
public void	setHyperlink(Hyperlink hyperlink associated with this cell hyperlink) Implements org.apache.poi.ss.usermodel.Cell.setHyperlink. Assign a hyperlink to this cell.
public String	toString() Overrides java.lang.Object.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.
private static RuntimeException	typeMismatch(CellType expectedTypeCode, CellType actualTypeCode, boolean isFormulaCell)
protected void	updateCellNum(short the new cell number num) Updates the cell record's idea of what column it belongs in (0 based)

Inherited from org.apache.poi.ss.usermodel.CellBase:: getAddress getValueType removeFormula setBlank setCellFormula setCellType setCellValue setCellValue setCellValue setCellValue setCellValue setCellValue tryToDeleteArrayFormula

_book	back to summary
private final HSSFWorkbook _book

_cellType	back to summary
private CellType _cellType

_comment	back to summary
private HSSFComment _comment

_record	back to summary
private CellValueRecordInterface _record

_sheet	back to summary
private final HSSFSheet _sheet

_stringValue	back to summary
private HSSFRichTextString _stringValue

ENCODING_COMPRESSED_UNICODE	back to summary
public static final short ENCODING_COMPRESSED_UNICODE

ENCODING_UNCHANGED	back to summary
public static final short ENCODING_UNCHANGED

ENCODING_UTF_16	back to summary
public static final short ENCODING_UTF_16

FILE_FORMAT_NAME	back to summary
private static final String FILE_FORMAT_NAME

LAST_COLUMN_NAME	back to summary
private static final String LAST_COLUMN_NAME

LAST_COLUMN_NUMBER	back to summary
public static final int LAST_COLUMN_NUMBER The maximum number of columns in BIFF8

HSSFCell	back to summary
protected HSSFCell(HSSFWorkbook book, HSSFSheet sheet, int row, short col) Creates new Cell - Should only be called by HSSFRow. This creates a cell from scratch. When the cell is initially created it is set to `CellType#BLANK`. Cell types can be changed/overwritten by calling setCellValue with the appropriate type as a parameter although conversions from one type to another may be prohibited. Parameters book:HSSFWorkbook - Workbook record of the workbook containing this cell sheet:HSSFSheet - Sheet record of the sheet containing this cell row:int - the row of this cell col:short - the column for this cell See Also `org.apache.poi.hssf.usermodel.HSSFRow#createCell(int)`

HSSFCell	back to summary
protected HSSFCell(HSSFWorkbook book, HSSFSheet sheet, int row, short col, CellType type) Creates new Cell - Should only be called by HSSFRow. This creates a cell from scratch. Parameters book:HSSFWorkbook - Workbook record of the workbook containing this cell sheet:HSSFSheet - Sheet record of the sheet containing this cell row:int - the row of this cell col:short - the column for this cell type:CellType - Type of cell See Also `org.apache.poi.hssf.usermodel.HSSFRow#createCell(int, CellType)`

HSSFCell	back to summary
protected HSSFCell(HSSFWorkbook book, HSSFSheet sheet, CellValueRecordInterface cval) Creates an HSSFCell from a CellValueRecordInterface. HSSFSheet uses this when reading in cells from an existing sheet. Parameters book:HSSFWorkbook - Workbook record of the workbook containing this cell sheet:HSSFSheet - Sheet record of the sheet containing this cell cval:CellValueRecordInterface - the Cell Value Record we wish to represent

Method Detail

applyUserCellStyle	back to summary
private short applyUserCellStyle(HSSFCellStyle style) Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent. The proceudre to apply a UDS is as follows: 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex() and xfType == ExtendedFormatRecord.XF_CELL. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style and set the parentIndex to be style.getIndex() 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record Parameters style:HSSFCellStyle the user style to apply Returns:short the index of a ExtendedFormatRecord record that will be referenced by the cell

applyUserCellStyle

back to summary

private short applyUserCellStyle(HSSFCellStyle style)

Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent. The proceudre to apply a UDS is as follows: 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex() and xfType == ExtendedFormatRecord.XF_CELL. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style and set the parentIndex to be style.getIndex() 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record

Parameters

style:HSSFCellStyle: the user style to apply

Returns:short

the index of a ExtendedFormatRecord record that will be referenced by the cell

checkBounds	back to summary
private static void checkBounds(int cellIndex) Exceptions IllegalStateException: if the bounds are exceeded.

checkFormulaCachedValueType	back to summary
private static void checkFormulaCachedValueType(CellType expectedTypeCode, FormulaRecord fr)

convertCellValueToBoolean	back to summary
private boolean convertCellValueToBoolean() Chooses a new boolean value for the cell when its type is changing. Usually the caller is calling setCellType() with the intention of calling setCellValue(boolean) straight afterwards. This method only exists to give the cell a somewhat reasonable value until the setCellValue() call (if at all). TODO - perhaps a method like setCellTypeAndValue(int, Object) should be introduced to avoid this Exceptions IllegalStateException: if cell type cannot be converted to boolean

convertCellValueToBoolean

back to summary

private boolean convertCellValueToBoolean()

Chooses a new boolean value for the cell when its type is changing.

Usually the caller is calling setCellType() with the intention of calling setCellValue(boolean) straight afterwards. This method only exists to give the cell a somewhat reasonable value until the setCellValue() call (if at all). TODO - perhaps a method like setCellTypeAndValue(int, Object) should be introduced to avoid this

Exceptions

IllegalStateException:: if cell type cannot be converted to boolean

convertCellValueToString	back to summary
private String convertCellValueToString()

determineType	back to summary
private static CellType determineType(CellValueRecordInterface cval) used internally -- given a cell value record, figure out its type

getArrayFormulaRange	back to summary
public CellRangeAddress getArrayFormulaRange() Implements org.apache.poi.ss.usermodel.Cell.getArrayFormulaRange. Doc from org.apache.poi.ss.usermodel.Cell.getArrayFormulaRange. Only valid for array formula cells Returns:CellRangeAddress range of the array formula group that the cell belongs to. Annotations @Override

getArrayFormulaRange

back to summary

public CellRangeAddress getArrayFormulaRange()

Implements org.apache.poi.ss.usermodel.Cell.getArrayFormulaRange.

Doc from org.apache.poi.ss.usermodel.Cell.getArrayFormulaRange.

Only valid for array formula cells

Returns:CellRangeAddress

range of the array formula group that the cell belongs to.

Annotations

@Override

getBooleanCellValue	back to summary
public boolean getBooleanCellValue() Implements org.apache.poi.ss.usermodel.Cell.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:boolean Doc from org.apache.poi.ss.usermodel.Cell.getBooleanCellValue. the value of the cell as a boolean Annotations @Override

getBooleanCellValue

back to summary

public boolean getBooleanCellValue()

Implements org.apache.poi.ss.usermodel.Cell.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:boolean

Doc from org.apache.poi.ss.usermodel.Cell.getBooleanCellValue.

the value of the cell as a boolean

Annotations

@Override

getBoundWorkbook	back to summary
protected InternalWorkbook getBoundWorkbook() Returns the Workbook that this Cell is bound to

getCachedFormulaResultType back to summary

getCachedFormulaResultType	back to summary
public CellType getCachedFormulaResultType() Implements org.apache.poi.ss.usermodel.Cell.getCachedFormulaResultType. Only valid for formula cells Returns:CellType one of (`CellType#NUMERIC`, `CellType#STRING`, `CellType#BOOLEAN`, `CellType#ERROR`) depending on the cached value of the formula Annotations @Override Since POI 4.0

public CellType getCachedFormulaResultType()

Implements org.apache.poi.ss.usermodel.Cell.getCachedFormulaResultType.

Only valid for formula cells

Returns:CellType

one of (CellType#NUMERIC, CellType#STRING, CellType#BOOLEAN, CellType#ERROR) depending on the cached value of the formula

Annotations

@Override

Since

POI 4.0

getCellComment	back to summary
public HSSFComment getCellComment() Implements org.apache.poi.ss.usermodel.Cell.getCellComment. Returns comment associated with this cell Returns:HSSFComment comment associated with this cell Annotations @Override

getCellComment

back to summary

public HSSFComment getCellComment()

Implements org.apache.poi.ss.usermodel.Cell.getCellComment.

Returns comment associated with this cell

Returns:HSSFComment

comment associated with this cell

Annotations

@Override

getCellFormula back to summary

getCellFormula	back to summary
public String getCellFormula() Implements org.apache.poi.ss.usermodel.Cell.getCellFormula. Doc from org.apache.poi.ss.usermodel.Cell.getCellFormula. Return a formula for the cell, for example, `SUM(C4:E4)` Returns:String a formula for the cell Annotations @Override

public String getCellFormula()

Implements org.apache.poi.ss.usermodel.Cell.getCellFormula.

Doc from org.apache.poi.ss.usermodel.Cell.getCellFormula.

Return a formula for the cell, for example, SUM(C4:E4)

Returns:String

a formula for the cell

Annotations

@Override

getCellStyle back to summary

getCellStyle	back to summary
public HSSFCellStyle getCellStyle() Implements org.apache.poi.ss.usermodel.Cell.getCellStyle. get the style for the cell. This is a reference to a cell style contained in the workbook object. Returns:HSSFCellStyle Doc from org.apache.poi.ss.usermodel.Cell.getCellStyle. the cell's style. Always not-null. Default cell style has zero index and can be obtained as `workbook.getCellStyleAt(0)` Annotations @Override See Also `org.apache.poi.hssf.usermodel.HSSFWorkbook#getCellStyleAt(int)`

public HSSFCellStyle getCellStyle()

Implements org.apache.poi.ss.usermodel.Cell.getCellStyle.

get the style for the cell. This is a reference to a cell style contained in the workbook object.

Returns:HSSFCellStyle

Doc from org.apache.poi.ss.usermodel.Cell.getCellStyle.

the cell's style. Always not-null. Default cell style has zero index and can be obtained as workbook.getCellStyleAt(0)

Annotations

@Override

getCellType	back to summary
public CellType getCellType() Implements org.apache.poi.ss.usermodel.Cell.getCellType. get the cells type (numeric, formula or string) Returns:CellType Doc from org.apache.poi.ss.usermodel.Cell.getCellType. the cell type Annotations @Override

getCellType

back to summary

public CellType getCellType()

Implements org.apache.poi.ss.usermodel.Cell.getCellType.

get the cells type (numeric, formula or string)

Returns:CellType

Doc from org.apache.poi.ss.usermodel.Cell.getCellType.

the cell type

Annotations

@Override

getCellValueRecord	back to summary
protected CellValueRecordInterface getCellValueRecord() Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record Returns:CellValueRecordInterface CellValueRecordInterface representing the cell via the low level api.

getCellValueRecord

back to summary

protected CellValueRecordInterface getCellValueRecord()

Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record

Returns:CellValueRecordInterface: CellValueRecordInterface representing the cell via the low level api.

getColumnIndex	back to summary
public int getColumnIndex() Implements org.apache.poi.ss.usermodel.Cell.getColumnIndex. Doc from org.apache.poi.ss.usermodel.Cell.getColumnIndex. Returns column index of this cell Returns:int zero-based column index of a column in a sheet. Annotations @Override

getColumnIndex

back to summary

public int getColumnIndex()

Implements org.apache.poi.ss.usermodel.Cell.getColumnIndex.

Doc from org.apache.poi.ss.usermodel.Cell.getColumnIndex.

Returns column index of this cell

Returns:int

zero-based column index of a column in a sheet.

Annotations

@Override

getDateCellValue back to summary

getDateCellValue	back to summary
public Date getDateCellValue() Implements org.apache.poi.ss.usermodel.Cell.getDateCellValue. Get the value of the cell as a date. For strings we throw an exception. For blank cells we return a null. See `HSSFDataFormatter` for formatting this date into a string similar to how excel does. Returns:Date Doc from org.apache.poi.ss.usermodel.Cell.getDateCellValue. the value of the cell as a date Annotations @Override

public Date getDateCellValue()

Implements org.apache.poi.ss.usermodel.Cell.getDateCellValue.

Get the value of the cell as a date. For strings we throw an exception. For blank cells we return a null. See HSSFDataFormatter for formatting this date into a string similar to how excel does.

Returns:Date

Doc from org.apache.poi.ss.usermodel.Cell.getDateCellValue.

the value of the cell as a date

Annotations

@Override

getErrorCellValue	back to summary
public byte getErrorCellValue() Implements org.apache.poi.ss.usermodel.Cell.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:byte Doc from org.apache.poi.ss.usermodel.Cell.getErrorCellValue. the value of the cell as an error code Annotations @Override

getErrorCellValue

back to summary

public byte getErrorCellValue()

Implements org.apache.poi.ss.usermodel.Cell.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:byte

Doc from org.apache.poi.ss.usermodel.Cell.getErrorCellValue.

the value of the cell as an error code

Annotations

@Override

getHyperlink back to summary

getHyperlink	back to summary
public HSSFHyperlink getHyperlink() Implements org.apache.poi.ss.usermodel.Cell.getHyperlink. Returns:HSSFHyperlink hyperlink associated with this cell or `null` if not found Annotations @Override

public HSSFHyperlink getHyperlink()

Implements org.apache.poi.ss.usermodel.Cell.getHyperlink.

Returns:HSSFHyperlink

hyperlink associated with this cell or null if not found

Annotations

@Override

getLocalDateTimeCellValue back to summary

getLocalDateTimeCellValue	back to summary
public LocalDateTime getLocalDateTimeCellValue() Implements org.apache.poi.ss.usermodel.Cell.getLocalDateTimeCellValue. Get the value of the cell as a LocalDateTime. For strings we throw an exception. For blank cells we return a null. See `HSSFDataFormatter` for formatting this date into a string similar to how excel does. Returns:LocalDateTime Doc from org.apache.poi.ss.usermodel.Cell.getLocalDateTimeCellValue. the value of the cell as a LocalDateTime Annotations @Override

public LocalDateTime getLocalDateTimeCellValue()

Implements org.apache.poi.ss.usermodel.Cell.getLocalDateTimeCellValue.

Get the value of the cell as a LocalDateTime. For strings we throw an exception. For blank cells we return a null. See HSSFDataFormatter for formatting this date into a string similar to how excel does.

Returns:LocalDateTime

Doc from org.apache.poi.ss.usermodel.Cell.getLocalDateTimeCellValue.

the value of the cell as a LocalDateTime

Annotations

@Override

getNumericCellValue back to summary

getNumericCellValue	back to summary
public double getNumericCellValue() Implements org.apache.poi.ss.usermodel.Cell.getNumericCellValue. Get the value of the cell as a number. For strings we throw an exception. For blank cells we return a 0. See `HSSFDataFormatter` for turning this number into a string similar to that which Excel would render this number as. Returns:double Doc from org.apache.poi.ss.usermodel.Cell.getNumericCellValue. the value of the cell as a number Annotations @Override

public double getNumericCellValue()

Implements org.apache.poi.ss.usermodel.Cell.getNumericCellValue.

Get the value of the cell as a number. For strings we throw an exception. For blank cells we return a 0. See HSSFDataFormatter for turning this number into a string similar to that which Excel would render this number as.

Returns:double

Doc from org.apache.poi.ss.usermodel.Cell.getNumericCellValue.

the value of the cell as a number

Annotations

@Override

getRichStringCellValue	back to summary
public HSSFRichTextString getRichStringCellValue() Implements org.apache.poi.ss.usermodel.Cell.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:HSSFRichTextString Doc from org.apache.poi.ss.usermodel.Cell.getRichStringCellValue. the value of the cell as a XSSFRichTextString Annotations @Override

getRichStringCellValue

back to summary

public HSSFRichTextString getRichStringCellValue()

Implements org.apache.poi.ss.usermodel.Cell.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:HSSFRichTextString

Doc from org.apache.poi.ss.usermodel.Cell.getRichStringCellValue.

the value of the cell as a XSSFRichTextString

Annotations

@Override

getRow	back to summary
public HSSFRow getRow() Implements org.apache.poi.ss.usermodel.Cell.getRow. Returns the HSSFRow this cell belongs to Returns:HSSFRow the HSSFRow that owns this cell Annotations @Override

getRow

back to summary

public HSSFRow getRow()

Implements org.apache.poi.ss.usermodel.Cell.getRow.

Returns the HSSFRow this cell belongs to

Returns:HSSFRow

the HSSFRow that owns this cell

Annotations

@Override

getRowIndex	back to summary
public int getRowIndex() Implements org.apache.poi.ss.usermodel.Cell.getRowIndex. Doc from org.apache.poi.ss.usermodel.Cell.getRowIndex. Returns row index of a row in the sheet that contains this cell Returns:int the (zero based) index of the row containing this cell Annotations @Override

getRowIndex

back to summary

public int getRowIndex()

Implements org.apache.poi.ss.usermodel.Cell.getRowIndex.

Doc from org.apache.poi.ss.usermodel.Cell.getRowIndex.

Returns row index of a row in the sheet that contains this cell

Returns:int

the (zero based) index of the row containing this cell

Annotations

@Override

getSheet	back to summary
public HSSFSheet getSheet() Implements org.apache.poi.ss.usermodel.Cell.getSheet. Returns the HSSFSheet this cell belongs to Returns:HSSFSheet the HSSFSheet that owns this cell Annotations @Override

getSheet

back to summary

public HSSFSheet getSheet()

Implements org.apache.poi.ss.usermodel.Cell.getSheet.

Returns the HSSFSheet this cell belongs to

Returns:HSSFSheet

the HSSFSheet that owns this cell

Annotations

@Override

getSpreadsheetVersion	back to summary
protected SpreadsheetVersion getSpreadsheetVersion() Implements abstract org.apache.poi.ss.usermodel.CellBase.getSpreadsheetVersion. Doc from org.apache.poi.ss.usermodel.CellBase.getSpreadsheetVersion. Get the spreadsheet version for the given implementation. Returns:SpreadsheetVersion the spreadsheet version Annotations @Override

getSpreadsheetVersion

back to summary

protected SpreadsheetVersion getSpreadsheetVersion()

Implements abstract org.apache.poi.ss.usermodel.CellBase.getSpreadsheetVersion.

Doc from org.apache.poi.ss.usermodel.CellBase.getSpreadsheetVersion.

Get the spreadsheet version for the given implementation.

Returns:SpreadsheetVersion

the spreadsheet version

Annotations

@Override

getStringCellValue	back to summary
public String getStringCellValue() Implements org.apache.poi.ss.usermodel.Cell.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:String Doc from org.apache.poi.ss.usermodel.Cell.getStringCellValue. the value of the cell as a string Annotations @Override

getStringCellValue

back to summary

public String getStringCellValue()

Implements org.apache.poi.ss.usermodel.Cell.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:String

Doc from org.apache.poi.ss.usermodel.Cell.getStringCellValue.

the value of the cell as a string

Annotations

@Override

isPartOfArrayFormulaGroup back to summary

isPartOfArrayFormulaGroup	back to summary
public boolean isPartOfArrayFormulaGroup() Implements org.apache.poi.ss.usermodel.Cell.isPartOfArrayFormulaGroup. Returns:boolean Doc from org.apache.poi.ss.usermodel.Cell.isPartOfArrayFormulaGroup. `true` if this cell is part of group of cells having a common array formula. Annotations @Override

public boolean isPartOfArrayFormulaGroup()

Implements org.apache.poi.ss.usermodel.Cell.isPartOfArrayFormulaGroup.

Returns:boolean

Doc from org.apache.poi.ss.usermodel.Cell.isPartOfArrayFormulaGroup.

true if this cell is part of group of cells having a common array formula.

Annotations

@Override

notifyFormulaChanging	back to summary
private void notifyFormulaChanging() Should be called any time that a formula could potentially be deleted. Does nothing if this cell currently does not hold a formula

readValue	back to summary
private CellValue readValue()

removeCellComment	back to summary
public void removeCellComment() Implements org.apache.poi.ss.usermodel.Cell.removeCellComment. Removes the comment for this cell, if there is one. WARNING - some versions of excel will loose all comments after performing this action! Annotations @Override

removeCellComment

back to summary

public void removeCellComment()

Implements org.apache.poi.ss.usermodel.Cell.removeCellComment.

Removes the comment for this cell, if there is one. WARNING - some versions of excel will loose all comments after performing this action!

Annotations

@Override

removeFormulaImpl	back to summary
protected void removeFormulaImpl() Implements abstract org.apache.poi.ss.usermodel.CellBase.removeFormulaImpl. Doc from org.apache.poi.ss.usermodel.CellBase.removeFormulaImpl. Implementation-specific removal of the formula. The cell is guaranteed to have a regular formula set. Shall preserve the "cached" value. Annotations @Override

removeFormulaImpl

back to summary

protected void removeFormulaImpl()

Implements abstract org.apache.poi.ss.usermodel.CellBase.removeFormulaImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.removeFormulaImpl.

Implementation-specific removal of the formula. The cell is guaranteed to have a regular formula set. Shall preserve the "cached" value.

Annotations

@Override

removeHyperlink

back to summary

public void removeHyperlink()

Implements org.apache.poi.ss.usermodel.Cell.removeHyperlink.

Removes the hyperlink for this cell, if there is one.

Annotations

@Override

restoreValue	back to summary
private void restoreValue(CellValue value)

setAsActiveCell

back to summary

public void setAsActiveCell()

Implements org.apache.poi.ss.usermodel.Cell.setAsActiveCell.

Doc from org.apache.poi.ss.usermodel.Cell.setAsActiveCell.

Sets this cell as the active cell for the worksheet

Annotations

@Override

setCellArrayFormula	back to summary
pack-priv void setCellArrayFormula(CellRangeAddress range)

setCellComment

back to summary

public void setCellComment(Comment comment)

Implements org.apache.poi.ss.usermodel.Cell.setCellComment.

Assign a comment to this cell. If the supplied comment is null, the comment for this cell will be removed.

Parameters

comment:Comment: comment associated with this cell

Annotations

@Override

setCellErrorValue back to summary

public void setCellErrorValue(byte errorCode)

Implements org.apache.poi.ss.usermodel.Cell.setCellErrorValue.

Deprecated

3.15 beta 2. Use setCellErrorValue(FormulaError) instead.

set an error value for the cell

Parameters

errorCode:byte: 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, see FormulaError.

Annotations

@Override
@Deprecated

setCellErrorValue

back to summary

public void setCellErrorValue(FormulaError error)

set an error value for the cell

Parameters

error:FormulaError: 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.

Annotations

@SuppressWarnings:fallthrough

setCellFormulaImpl

back to summary

protected void setCellFormulaImpl(String formula)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellFormulaImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellFormulaImpl.

Implementation-specific setting the formula. Formula is not null. Shall not change the value.

Parameters

formula:String: The text of the formula to set.

Annotations

@Override

setCellStyle back to summary

public void setCellStyle(CellStyle style)

Implements org.apache.poi.ss.usermodel.Cell.setCellStyle.

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 org.apache.poi.ss.util.CellUtil#setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, java.util.Map)

Parameters

style:CellStyle: reference contained in the workbook

Annotations

@Override

setCellStyle	back to summary
public void setCellStyle(HSSFCellStyle style)

setCellType

back to summary

private void setCellType(CellType cellType, boolean setValue, int row, short col, short styleIndex)

sets the cell type. The setValue flag indicates whether to bother about trying to preserve the current value in the new record if one is created.

The @see #setCellValue method will call this method with false in setValue since it will overwrite the cell value later

setCellTypeImpl

back to summary

protected void setCellTypeImpl(CellType cellType)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellTypeImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellTypeImpl.

Implementation-specific logic

Parameters

cellType:CellType: new cell type. Guaranteed non-null, not _NONE.

Annotations

@Override

setCellValue

back to summary

public void setCellValue(boolean value)

Implements org.apache.poi.ss.usermodel.Cell.setCellValue.

set a boolean value for the cell

Parameters

value:boolean: 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.

Annotations

@Override
@SuppressWarnings:fallthrough

setCellValueImpl back to summary

protected void setCellValueImpl(double value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Implementation-specific way to set a numeric value. value is guaranteed to be a valid (non-NaN) double. The implementation is expected to adjust the cell type accordingly, so that after this call getCellType() or getCachedFormulaResultType() would return CellType#NUMERIC.

Parameters

value:double: the new value to set

Annotations

@Override
@SuppressWarnings:fallthrough

setCellValueImpl back to summary

protected void setCellValueImpl(Date value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Implementation-specific way to set a date value. value is guaranteed to be non-null. The implementation is expected to adjust the cell type accordingly, so that after this call getCellType() or getCachedFormulaResultType() would return CellType#NUMERIC.

In HSSF, only the number of days is stored. The fractional part is ignored.

Parameters

value:Date: the new date to set

Annotations

@Override

setCellValueImpl back to summary

protected void setCellValueImpl(LocalDateTime value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

In HSSF, only the number of days is stored. The fractional part is ignored.

Parameters

value:LocalDateTime: the new date to set

Annotations

@Override

setCellValueImpl back to summary

protected void setCellValueImpl(Calendar value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Implementation-specific way to set a calendar value. value is guaranteed to be non-null. The implementation is expected to adjust the cell type accordingly, so that after this call getCellType() or getCachedFormulaResultType() would return CellType#NUMERIC.

Parameters

value:Calendar: the new calendar value to set

Annotations

@Override

setCellValueImpl back to summary

protected void setCellValueImpl(String value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Implementation-specific way to set a string value. The value is guaranteed to be non-null and to satisfy the length limitation imposed by the spreadsheet version. The implementation is expected to adjust cell type accordingly, so that after this call getCellType() or getCachedFormulaResultType() (whichever appropriate) would return CellType#STRING.

Parameters

value:String: the new value to set.

Annotations

@Override

setCellValueImpl back to summary

protected void setCellValueImpl(RichTextString value)

Implements abstract org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Doc from org.apache.poi.ss.usermodel.CellBase.setCellValueImpl.

Implementation-specific way to set a RichTextString value. The value is guaranteed to be non-null, having non-null value, and to satisfy the length limitation imposed by the spreadsheet version. The implementation is expected to adjust cell type accordingly, so that after this call getCellType() or getCachedFormulaResultType() (whichever appropriate) would return CellType#STRING.

Parameters

value:RichTextString: the new value to set.

Annotations

@Override

setHyperlink

back to summary

public void setHyperlink(Hyperlink hyperlink)

Implements org.apache.poi.ss.usermodel.Cell.setHyperlink.

Assign a hyperlink to this cell. If the supplied hyperlink is null, the hyperlink for this cell will be removed.

Parameters

hyperlink:Hyperlink: hyperlink associated with this cell

Annotations

@Override

toString

back to summary

public String toString()

Overrides java.lang.Object.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>

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

typeMismatch	back to summary
private static RuntimeException typeMismatch(CellType expectedTypeCode, CellType actualTypeCode, boolean isFormulaCell)

updateCellNum

back to summary

protected void updateCellNum(short num)

Updates the cell record's idea of what column it belongs in (0 based)

Parameters

num:short: the new cell number

public Class HSSFCell

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail