Package org.xlsx4j.model

Class CellUtils

java.lang.Object

org.xlsx4j.model.CellUtils

public class CellUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CELL_TYPE_BLANK	Blank Cell type (3)
static final int	CELL_TYPE_BOOLEAN	Boolean Cell type (4)
static final int	CELL_TYPE_ERROR	Error Cell type (5)
static final int	CELL_TYPE_FORMULA	Formula Cell type (2)
static final int	CELL_TYPE_NUMERIC	Numeric Cell type (0)
static final int	CELL_TYPE_STRING	String Cell type (1)
private static final String	FALSE_AS_STRING
protected static org.slf4j.Logger	log
private static final String	TRUE_AS_STRING

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CellUtils()

Method Summary

Modifier and Type	Method	Description
private static int	getBaseCellType(Cell _cell, boolean blankCells)	Detect cell type based on the "t" attribute of the CTCell bean
static boolean	getBooleanCellValue(Cell _cell)	Get the value of the cell as a boolean.
static CTCellStyle	getCellStyle(Cell _cell)	Return the cell's style.
static int	getCellType(Cell _cell)	Return the cell type.
private static String	getCellTypeName(int cellTypeCode)	Used to help format error messages
static Date	getDateCellValue(Cell _cell)	Get the value of the cell as a date.
private static String	getFormat(int index)	get the format string that matches the given format index
static long	getNumberFormatIndex(Cell _cell)	Get the index of the number format (numFmt) record used by this cell format.
static String	getNumberFormatString(Cell _cell)	Get the contents of the format string, by looking up the StylesSource
static double	getNumericCellValue(Cell _cell)	Get the value of the cell as a number.
static RuntimeException	typeMismatch(int expectedTypeCode, int actualTypeCode, boolean isFormulaCell)	Used to help format error messages

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

protected static org.slf4j.Logger log

CELL_TYPE_NUMERIC

public static final int CELL_TYPE_NUMERIC

Numeric Cell type (0)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

CELL_TYPE_STRING

public static final int CELL_TYPE_STRING

String Cell type (1)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

CELL_TYPE_FORMULA

public static final int CELL_TYPE_FORMULA

Formula Cell type (2)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

CELL_TYPE_BLANK

public static final int CELL_TYPE_BLANK

Blank Cell type (3)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

CELL_TYPE_BOOLEAN

public static final int CELL_TYPE_BOOLEAN

Boolean Cell type (4)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

CELL_TYPE_ERROR

public static final int CELL_TYPE_ERROR

Error Cell type (5)

See Also:

• #setCellType(int)
• #getCellType()
• Constant Field Values

FALSE_AS_STRING

private static final String FALSE_AS_STRING

See Also:

• Constant Field Values

TRUE_AS_STRING

private static final String TRUE_AS_STRING

See Also:

• Constant Field Values

Constructor Details

CellUtils

protected CellUtils()

Method Details

getNumericCellValue

public static double getNumericCellValue(Cell _cell)

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:

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.

getCellTypeName

private static String getCellTypeName(int cellTypeCode)

Used to help format error messages

typeMismatch

public static RuntimeException typeMismatch(int expectedTypeCode,
 int actualTypeCode,
 boolean isFormulaCell)

Used to help format error messages

getCellType

public static int getCellType(Cell _cell)

Return the cell type.

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

getBaseCellType

private static int getBaseCellType(Cell _cell,
 boolean blankCells)

Detect cell type based on the "t" attribute of the CTCell bean

getCellStyle

public static CTCellStyle getCellStyle(Cell _cell)

Return the cell's style.

Returns:

the cell's style.

getNumberFormatIndex

public static long getNumberFormatIndex(Cell _cell)

Get the index of the number format (numFmt) record used by this cell format.

Returns:

the index of the number format

getNumberFormatString

public static String getNumberFormatString(Cell _cell)

Get the contents of the format string, by looking up the StylesSource

Returns:

the number format string

getFormat

private static String getFormat(int index)

get the format string that matches the given format index

Parameters:

index - of a format

Returns:

string represented at index of format or null if there is not a format at that index

getDateCellValue

public static Date getDateCellValue(Cell _cell)

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:

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.

getBooleanCellValue

public static boolean getBooleanCellValue(Cell _cell)

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:

IllegalStateException - if the cell type returned by #getCellType() is not CELL_TYPE_BOOLEAN, CELL_TYPE_BLANK or CELL_TYPE_FORMULA