Apache POI - Common 5.3.0 · org.apache.poi.ss.util.CellUtil

Modifier and Type	Class and Description
private static class	CellUtil.UnicodeMapping

Modifier and Type	Field and Description
public static final String	ALIGNMENT
private static final Set<String>	booleanValues
public static final String	BORDER_BOTTOM
public static final String	BORDER_LEFT
public static final String	BORDER_RIGHT
public static final String	BORDER_TOP
private static final Set<String>	borderTypeValues
public static final String	BOTTOM_BORDER_COLOR
private static final Set<String>	colorValues
public static final String	DATA_FORMAT
public static final String	FILL_BACKGROUND_COLOR
public static final String	FILL_BACKGROUND_COLOR_COLOR
public static final String	FILL_FOREGROUND_COLOR
public static final String	FILL_FOREGROUND_COLOR_COLOR
public static final String	FILL_PATTERN
public static final String	FONT
public static final String	HIDDEN
public static final String	INDENTION
private static final Set<String>	intValues
public static final String	LEFT_BORDER_COLOR
public static final String	LOCKED
private static final Logger	LOGGER
public static final String	QUOTE_PREFIXED
public static final String	RIGHT_BORDER_COLOR
public static final String	ROTATION
private static final Set<String>	shortValues
public static final String	SHRINK_TO_FIT
public static final String	TOP_BORDER_COLOR
private static final CellUtil.UnicodeMapping[]	unicodeMappings
public static final String	VERTICAL_ALIGNMENT
public static final String	WRAP_TEXT

Access	Constructor and Description
private	CellUtil()

Method Summary

Modifier and Type	Method and Description
public static void	copyCell(Cell The cell to take value, formula and style from srcCell, Cell The cell to copy to destCell, CellCopyPolicy The policy for copying the information, see `CellCopyPolicy` policy, CellCopyContext The context for copying, see `CellCopyContext` context) 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.
public static Cell	Returns: A new Cell createCell(Row the row to create the cell in row, int the column index to create the cell in column, String The value of the cell value, CellStyle If the style is not null, then set style) Creates a cell, gives it a value, and applies a style if provided
public static Cell	Returns: A new Cell. createCell(Row the row to create the cell in row, int the column index to create the cell in column, String The value of the cell value) Create a cell, and give it a value.
private static boolean	Returns: false if the property does not exist, or is not a `Boolean`, true otherwise getBoolean(Map<String, Object> map of properties (String -> Object) properties, String property name name) Utility method that returns the named boolean value from the given map.
private static BorderStyle	Returns: Border style if set, otherwise `BorderStyle#NONE` getBorderStyle(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named BorderStyle value from the given map.
public static Cell	Returns: The cell indicated by the column. getCell(Row The row that the cell is part of row, int The column index that the cell is in. columnIndex) Get a specific cell from a row.
private static Color	Returns: null if the property does not exist, or is not a `Color` otherwise the property value getColor(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named Color value from the given map.
private static FillPatternType	Returns: FillPatternType style if set, otherwise `FillPatternType#NO_FILL` getFillPattern(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named FillPatternType value from the given map.
private static Map<String, Object>	Returns: map of format properties (String -> Object) getFormatProperties(CellStyle cell style style) Returns a map containing the format properties of the given cell style.
private static HorizontalAlignment	Returns: HorizontalAlignment style if set, otherwise `HorizontalAlignment#GENERAL` getHorizontalAlignment(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named HorizontalAlignment value from the given map.
private static int	Returns: zero if the property does not exist, or is not a `Integer` otherwise the property value getInt(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named int value from the given map.
public static Row	Returns: The row indicated by the rowCounter getRow(int The 0 based row number rowIndex, Sheet The sheet that the row is part of. sheet) Get a row from the spreadsheet, and create it if it doesn't exist.
private static short	Returns: zero if the property does not exist, or is not a `Short` otherwise the property value getShort(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named short value from the given map.
private static VerticalAlignment	Returns: VerticalAlignment style if set, otherwise `VerticalAlignment#BOTTOM` getVerticalAlignment(Map<String, Object> map of named properties (String -> Object) properties, String property name name) Utility method that returns the named VerticalAlignment value from the given map.
private static Short	nullableShort(Map<String, Object> properties, String name)
private static void	put(Map<String, Object> map of properties (String -> Object) properties, String property name name, Object property value value) Utility method that puts the given value to the given map.
private static void	putAll(final Map<String, Object> the property map to copy from (read-only) src, Map<String, Object> the property map to copy into dest) Copies the entries in src to dest, using the preferential data type so that maps can be compared for equality
public static void	setAlignment(Cell the cell to set the alignment for cell, HorizontalAlignment the horizontal alignment to use. align) Take a cell, and align it.
public static void	setCellStyleProperties(Cell The cell to change the style of cell, Map<String, Object> The properties to be added to a cell style, as {propertyName: propertyValue}. properties) This method attempts to find an existing CellStyle that matches the `cell`'s current style plus styles properties in `properties`.
private static void	setCellStyleProperties(final Cell cell, final Map<String, Object> properties, final boolean disableNullColorCheck)
public static void	setCellStyleProperty(Cell The cell that is to be changed. cell, String The name of the property that is to be changed. propertyName, Object The value of the property that is to be changed. propertyValue) This method attempts to find an existing CellStyle that matches the `cell`'s current style plus a single style property `propertyName` with value `propertyValue`.
public static void	setFont(Cell the cell to set the alignment for cell, Font The Font that you want to set. font) Take a cell, and apply a font to it
private static void	setFormatProperties(CellStyle cell style style, Workbook parent workbook workbook, Map<String, Object> map of format properties (String -> Object) properties) Sets the format properties of the given style based on the given map.
public static void	setVerticalAlignment(Cell the cell to set the alignment for cell, VerticalAlignment the vertical alignment to use. align) Take a cell, and vertically align it.
private static boolean	styleMapsMatch(final Map<String, Object> newProps, final Map<String, Object> storedProps, final boolean disableNullColorCheck)
public static Cell	Returns: translated to unicode translateUnicodeValues(Cell The cell to check for unicode values cell) Looks for text in the cell that should be unicode, like α and provides the unicode version of it.
private static CellUtil.UnicodeMapping	um(String entityName, String resolvedValue)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ALIGNMENT	back to summary
public static final String ALIGNMENT

booleanValues	back to summary
private static final Set<String> booleanValues

BORDER_BOTTOM	back to summary
public static final String BORDER_BOTTOM

BORDER_LEFT	back to summary
public static final String BORDER_LEFT

BORDER_RIGHT	back to summary
public static final String BORDER_RIGHT

BORDER_TOP	back to summary
public static final String BORDER_TOP

borderTypeValues	back to summary
private static final Set<String> borderTypeValues

BOTTOM_BORDER_COLOR	back to summary
public static final String BOTTOM_BORDER_COLOR

colorValues	back to summary
private static final Set<String> colorValues

DATA_FORMAT	back to summary
public static final String DATA_FORMAT

FILL_BACKGROUND_COLOR	back to summary
public static final String FILL_BACKGROUND_COLOR

FILL_BACKGROUND_COLOR_COLOR	back to summary
public static final String FILL_BACKGROUND_COLOR_COLOR

FILL_FOREGROUND_COLOR	back to summary
public static final String FILL_FOREGROUND_COLOR

FILL_FOREGROUND_COLOR_COLOR	back to summary
public static final String FILL_FOREGROUND_COLOR_COLOR

FILL_PATTERN	back to summary
public static final String FILL_PATTERN

FONT	back to summary
public static final String FONT

HIDDEN	back to summary
public static final String HIDDEN

INDENTION	back to summary
public static final String INDENTION

intValues	back to summary
private static final Set<String> intValues

LEFT_BORDER_COLOR	back to summary
public static final String LEFT_BORDER_COLOR

LOCKED	back to summary
public static final String LOCKED

LOGGER	back to summary
private static final Logger LOGGER

QUOTE_PREFIXED	back to summary
public static final String QUOTE_PREFIXED

RIGHT_BORDER_COLOR	back to summary
public static final String RIGHT_BORDER_COLOR

ROTATION	back to summary
public static final String ROTATION

shortValues	back to summary
private static final Set<String> shortValues

SHRINK_TO_FIT	back to summary
public static final String SHRINK_TO_FIT

TOP_BORDER_COLOR	back to summary
public static final String TOP_BORDER_COLOR

unicodeMappings	back to summary
private static final CellUtil.UnicodeMapping[] unicodeMappings

VERTICAL_ALIGNMENT	back to summary
public static final String VERTICAL_ALIGNMENT

WRAP_TEXT	back to summary
public static final String WRAP_TEXT

CellUtil	back to summary
private CellUtil()

Method Detail

copyCell back to summary

copyCell	back to summary
public static void copyCell(Cell srcCell, Cell destCell, CellCopyPolicy policy, CellCopyContext context) 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. Note that if you are copying from a source cell from a different type of then you may need to disable style copying in the `CellCopyPolicy` (HSSF styles are not compatible with XSSF styles, for instance). This does not shift references in formulas. The `copyRowFrom` method on `XSSFRow` and `HSSFRow` does attempt to shift references in formulas. Parameters srcCell:Cell The cell to take value, formula and style from destCell:Cell The cell to copy to policy:CellCopyPolicy The policy for copying the information, see `CellCopyPolicy` context:CellCopyContext The context for copying, see `CellCopyContext` Annotations @Beta Exceptions IllegalArgumentException: if copy cell style and srcCell is from a different workbook IllegalStateException: if srcCell hyperlink is not an instance of `Duplicatable` Since POI 5.2.0

public static void copyCell(Cell srcCell, Cell destCell, CellCopyPolicy policy, CellCopyContext context)

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. Note that if you are copying from a source cell from a different type of then you may need to disable style copying in the CellCopyPolicy (HSSF styles are not compatible with XSSF styles, for instance). This does not shift references in formulas. The copyRowFrom method on XSSFRow and HSSFRow does attempt to shift references in formulas.

Parameters

srcCell:Cell: The cell to take value, formula and style from
destCell:Cell: The cell to copy to
policy:CellCopyPolicy: The policy for copying the information, see CellCopyPolicy
context:CellCopyContext: The context for copying, see CellCopyContext

Annotations

@Beta

Exceptions

IllegalArgumentException:: if copy cell style and srcCell is from a different workbook
IllegalStateException:: if srcCell hyperlink is not an instance of Duplicatable

Since

POI 5.2.0

createCell	back to summary
public static Cell createCell(Row row, int column, String value, CellStyle style) Creates a cell, gives it a value, and applies a style if provided Parameters row:Row the row to create the cell in column:int the column index to create the cell in value:String The value of the cell style:CellStyle If the style is not null, then set Returns:Cell A new Cell

createCell

back to summary

public static Cell createCell(Row row, int column, String value, CellStyle style)

Creates a cell, gives it a value, and applies a style if provided

Parameters

row:Row: the row to create the cell in
column:int: the column index to create the cell in
value:String: The value of the cell
style:CellStyle: If the style is not null, then set

Returns:Cell

A new Cell

createCell	back to summary
public static Cell createCell(Row row, int column, String value) Create a cell, and give it a value. Parameters row:Row the row to create the cell in column:int the column index to create the cell in value:String The value of the cell Returns:Cell A new Cell.

createCell

back to summary

public static Cell createCell(Row row, int column, String value)

Create a cell, and give it a value.

Parameters

row:Row: the row to create the cell in
column:int: the column index to create the cell in
value:String: The value of the cell

Returns:Cell

A new Cell.

getBoolean back to summary

getBoolean	back to summary
private static boolean getBoolean(Map<String, Object> properties, String name) Utility method that returns the named boolean value from the given map. Parameters properties:Map<String, Object> map of properties (String -> Object) name:String property name Returns:boolean false if the property does not exist, or is not a `Boolean`, true otherwise

private static boolean getBoolean(Map<String, Object> properties, String name)

Utility method that returns the named boolean value from the given map.

Parameters

properties:Map<String, Object>: map of properties (String -> Object)
name:String: property name

Returns:boolean

false if the property does not exist, or is not a Boolean, true otherwise

getBorderStyle back to summary

getBorderStyle	back to summary
private static BorderStyle getBorderStyle(Map<String, Object> properties, String name) Utility method that returns the named BorderStyle value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:BorderStyle Border style if set, otherwise `BorderStyle#NONE`

private static BorderStyle getBorderStyle(Map<String, Object> properties, String name)

Utility method that returns the named BorderStyle value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:BorderStyle

Border style if set, otherwise BorderStyle#NONE

getCell	back to summary
public static Cell getCell(Row row, int columnIndex) Get a specific cell from a row. If the cell doesn't exist, then create it. Parameters row:Row The row that the cell is part of columnIndex:int The column index that the cell is in. Returns:Cell The cell indicated by the column.

getCell

back to summary

public static Cell getCell(Row row, int columnIndex)

Get a specific cell from a row. If the cell doesn't exist, then create it.

Parameters

row:Row: The row that the cell is part of
columnIndex:int: The column index that the cell is in.

Returns:Cell

The cell indicated by the column.

getColor back to summary

getColor	back to summary
private static Color getColor(Map<String, Object> properties, String name) Utility method that returns the named Color value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:Color null if the property does not exist, or is not a `Color` otherwise the property value

private static Color getColor(Map<String, Object> properties, String name)

Utility method that returns the named Color value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:Color

null if the property does not exist, or is not a Color otherwise the property value

getFillPattern back to summary

getFillPattern	back to summary
private static FillPatternType getFillPattern(Map<String, Object> properties, String name) Utility method that returns the named FillPatternType value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:FillPatternType FillPatternType style if set, otherwise `FillPatternType#NO_FILL` Since POI 3.15 beta 3

private static FillPatternType getFillPattern(Map<String, Object> properties, String name)

Utility method that returns the named FillPatternType value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:FillPatternType

FillPatternType style if set, otherwise FillPatternType#NO_FILL

Since

POI 3.15 beta 3

getFormatProperties back to summary

getFormatProperties	back to summary
private static Map<String, Object> getFormatProperties(CellStyle style) Returns a map containing the format properties of the given cell style. The returned map is not tied to `style`, so subsequent changes to `style` will not modify the map, and changes to the returned map will not modify the cell style. The returned map is mutable. Parameters style:CellStyle cell style Returns:Map<String, Object> map of format properties (String -> Object) See Also `setFormatProperties(CellStyle, Workbook, Map)`

private static Map<String, Object> getFormatProperties(CellStyle style)

Returns a map containing the format properties of the given cell style. The returned map is not tied to style, so subsequent changes to style will not modify the map, and changes to the returned map will not modify the cell style. The returned map is mutable.

Parameters

style:CellStyle: cell style

Returns:Map<String, Object>

map of format properties (String -> Object)

getHorizontalAlignment back to summary

getHorizontalAlignment	back to summary
private static HorizontalAlignment getHorizontalAlignment(Map<String, Object> properties, String name) Utility method that returns the named HorizontalAlignment value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:HorizontalAlignment HorizontalAlignment style if set, otherwise `HorizontalAlignment#GENERAL` Since POI 3.15 beta 3

private static HorizontalAlignment getHorizontalAlignment(Map<String, Object> properties, String name)

Utility method that returns the named HorizontalAlignment value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:HorizontalAlignment

HorizontalAlignment style if set, otherwise HorizontalAlignment#GENERAL

Since

POI 3.15 beta 3

getInt back to summary

getInt	back to summary
private static int getInt(Map<String, Object> properties, String name) Utility method that returns the named int value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:int zero if the property does not exist, or is not a `Integer` otherwise the property value

private static int getInt(Map<String, Object> properties, String name)

Utility method that returns the named int value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:int

zero if the property does not exist, or is not a Integer otherwise the property value

getRow	back to summary
public static Row getRow(int rowIndex, Sheet sheet) Get a row from the spreadsheet, and create it if it doesn't exist. Parameters rowIndex:int The 0 based row number sheet:Sheet The sheet that the row is part of. Returns:Row The row indicated by the rowCounter

getRow

back to summary

public static Row getRow(int rowIndex, Sheet sheet)

Get a row from the spreadsheet, and create it if it doesn't exist.

Parameters

rowIndex:int: The 0 based row number
sheet:Sheet: The sheet that the row is part of.

Returns:Row

The row indicated by the rowCounter

getShort back to summary

getShort	back to summary
private static short getShort(Map<String, Object> properties, String name) Utility method that returns the named short value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:short zero if the property does not exist, or is not a `Short` otherwise the property value

private static short getShort(Map<String, Object> properties, String name)

Utility method that returns the named short value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:short

zero if the property does not exist, or is not a Short otherwise the property value

getVerticalAlignment back to summary

getVerticalAlignment	back to summary
private static VerticalAlignment getVerticalAlignment(Map<String, Object> properties, String name) Utility method that returns the named VerticalAlignment value from the given map. Parameters properties:Map<String, Object> map of named properties (String -> Object) name:String property name Returns:VerticalAlignment VerticalAlignment style if set, otherwise `VerticalAlignment#BOTTOM` Since POI 3.15 beta 3

private static VerticalAlignment getVerticalAlignment(Map<String, Object> properties, String name)

Utility method that returns the named VerticalAlignment value from the given map.

Parameters

properties:Map<String, Object>: map of named properties (String -> Object)
name:String: property name

Returns:VerticalAlignment

VerticalAlignment style if set, otherwise VerticalAlignment#BOTTOM

Since

POI 3.15 beta 3

nullableShort	back to summary
private static Short nullableShort(Map<String, Object> properties, String name)

put

back to summary

private static void put(Map<String, Object> properties, String name, Object value)

Utility method that puts the given value to the given map.

Parameters

properties:Map<String, Object>: map of properties (String -> Object)
name:String: property name
value:Object: property value

putAll

back to summary

private static void putAll(final Map<String, Object> src, Map<String, Object> dest)

Copies the entries in src to dest, using the preferential data type so that maps can be compared for equality

Parameters

src:Map<String, Object>: the property map to copy from (read-only)
dest:Map<String, Object>: the property map to copy into

Since

POI 3.15 beta 3

setAlignment

back to summary

public static void setAlignment(Cell cell, HorizontalAlignment align)

Take a cell, and align it. This is superior to cell.getCellStyle().setAlignment(align) because this method will not modify the CellStyle object that may be referenced by multiple cells. Instead, this method will search for existing CellStyles that match the desired CellStyle, creating a new CellStyle with the desired style if no match exists.

Parameters

cell:Cell: the cell to set the alignment for
align:HorizontalAlignment: the horizontal alignment to use.

Since

POI 3.15 beta 3

See Also

{@link HorizontalAlignment} for alignment options

setCellStyleProperties back to summary

public static void setCellStyleProperties(Cell cell, Map<String, Object> properties)

This method attempts to find an existing CellStyle that matches the cell's current style plus styles properties in properties. A new style is created if the workbook does not contain a matching style.

Modifies the cell style of cell without affecting other cells that use the same style.

This is necessary because Excel has an upper limit on the number of styles that it supports.

This function is more efficient than multiple calls to setCellStyleProperty(Cell, String, Object) if adding multiple cell styles.

For performance reasons, if this is the only cell in a workbook that uses a cell style, this method does NOT remove the old style from the workbook.

Parameters

cell:Cell: The cell to change the style of
properties:Map<String, Object>: The properties to be added to a cell style, as {propertyName: propertyValue}.

Since

POI 3.14 beta 2

setCellStyleProperties	back to summary
private static void setCellStyleProperties(final Cell cell, final Map<String, Object> properties, final boolean disableNullColorCheck)

setCellStyleProperty back to summary

public static void setCellStyleProperty(Cell cell, String propertyName, Object propertyValue)

This method attempts to find an existing CellStyle that matches the cell's current style plus a single style property propertyName with value propertyValue. A new style is created if the workbook does not contain a matching style.

Modifies the cell style of cell without affecting other cells that use the same style.

If setting more than one cell style property on a cell, use setCellStyleProperties(Cell, Map), which is faster and does not add unnecessary intermediate CellStyles to the workbook.

Parameters

cell:Cell: The cell that is to be changed.
propertyName:String: The name of the property that is to be changed.
propertyValue:Object: The value of the property that is to be changed.

setFont back to summary

public static void setFont(Cell cell, Font font)

Take a cell, and apply a font to it

Parameters

cell:Cell: the cell to set the alignment for
font:Font: The Font that you want to set.

Exceptions

IllegalArgumentException:: if font and cell do not belong to the same workbook

setFormatProperties back to summary

private static void setFormatProperties(CellStyle style, Workbook workbook, Map<String, Object> properties)

Sets the format properties of the given style based on the given map.

Parameters

style:CellStyle: cell style
workbook:Workbook: parent workbook
properties:Map<String, Object>: map of format properties (String -> Object)

See Also

getFormatProperties(CellStyle)

setVerticalAlignment

back to summary

public static void setVerticalAlignment(Cell cell, VerticalAlignment align)

Take a cell, and vertically align it. This is superior to cell.getCellStyle().setVerticalAlignment(align) because this method will not modify the CellStyle object that may be referenced by multiple cells. Instead, this method will search for existing CellStyles that match the desired CellStyle, creating a new CellStyle with the desired style if no match exists.

Parameters

cell:Cell: the cell to set the alignment for
align:VerticalAlignment: the vertical alignment to use.

Since

POI 3.15 beta 3

See Also

{@link VerticalAlignment} for alignment options

styleMapsMatch	back to summary
private static boolean styleMapsMatch(final Map<String, Object> newProps, final Map<String, Object> storedProps, final boolean disableNullColorCheck)

translateUnicodeValues

back to summary

public static Cell translateUnicodeValues(Cell cell)

Looks for text in the cell that should be unicode, like α and provides the unicode version of it.

Parameters

cell:Cell: The cell to check for unicode values

Returns:Cell

translated to unicode

um	back to summary
private static CellUtil.UnicodeMapping um(String entityName, String resolvedValue)

public final Class CellUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CellUtil.UnicodeMapping

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
public final String	entityName
public final String	resolvedValue