463 lines
17 KiB
Java
463 lines
17 KiB
Java
/* ====================================================================
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
(the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
==================================================================== */
|
|
|
|
package org.apache.poi.ss.util;
|
|
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.Locale;
|
|
import java.util.Map;
|
|
|
|
import org.apache.poi.ss.usermodel.BorderStyle;
|
|
import org.apache.poi.ss.usermodel.Cell;
|
|
import org.apache.poi.ss.usermodel.CellStyle;
|
|
import org.apache.poi.ss.usermodel.Font;
|
|
import org.apache.poi.ss.usermodel.Row;
|
|
import org.apache.poi.ss.usermodel.Sheet;
|
|
import org.apache.poi.ss.usermodel.Workbook;
|
|
|
|
/**
|
|
* Various utility functions that make working with a cells and rows easier. The various methods
|
|
* that deal with style's allow you to create your CellStyles as you need them. When you apply a
|
|
* style change to a cell, the code will attempt to see if a style already exists that meets your
|
|
* needs. If not, then it will create a new style. This is to prevent creating too many styles.
|
|
* there is an upper limit in Excel on the number of styles that can be supported.
|
|
*
|
|
*@author Eric Pugh epugh@upstate.com
|
|
*@author (secondary) Avinash Kewalramani akewalramani@accelrys.com
|
|
*/
|
|
public final class CellUtil {
|
|
|
|
public static final String ALIGNMENT = "alignment";
|
|
public static final String BORDER_BOTTOM = "borderBottom";
|
|
public static final String BORDER_LEFT = "borderLeft";
|
|
public static final String BORDER_RIGHT = "borderRight";
|
|
public static final String BORDER_TOP = "borderTop";
|
|
public static final String BOTTOM_BORDER_COLOR = "bottomBorderColor";
|
|
public static final String DATA_FORMAT = "dataFormat";
|
|
public static final String FILL_BACKGROUND_COLOR = "fillBackgroundColor";
|
|
public static final String FILL_FOREGROUND_COLOR = "fillForegroundColor";
|
|
public static final String FILL_PATTERN = "fillPattern";
|
|
public static final String FONT = "font";
|
|
public static final String HIDDEN = "hidden";
|
|
public static final String INDENTION = "indention";
|
|
public static final String LEFT_BORDER_COLOR = "leftBorderColor";
|
|
public static final String LOCKED = "locked";
|
|
public static final String RIGHT_BORDER_COLOR = "rightBorderColor";
|
|
public static final String ROTATION = "rotation";
|
|
public static final String TOP_BORDER_COLOR = "topBorderColor";
|
|
public static final String VERTICAL_ALIGNMENT = "verticalAlignment";
|
|
public static final String WRAP_TEXT = "wrapText";
|
|
|
|
private static UnicodeMapping unicodeMappings[];
|
|
|
|
private static final class UnicodeMapping {
|
|
|
|
public final String entityName;
|
|
public final String resolvedValue;
|
|
|
|
public UnicodeMapping(String pEntityName, String pResolvedValue) {
|
|
entityName = "&" + pEntityName + ";";
|
|
resolvedValue = pResolvedValue;
|
|
}
|
|
}
|
|
|
|
private CellUtil() {
|
|
// no instances of this class
|
|
}
|
|
|
|
/**
|
|
* Get a row from the spreadsheet, and create it if it doesn't exist.
|
|
*
|
|
*@param rowIndex The 0 based row number
|
|
*@param sheet The sheet that the row is part of.
|
|
*@return The row indicated by the rowCounter
|
|
*/
|
|
public static Row getRow(int rowIndex, Sheet sheet) {
|
|
Row row = sheet.getRow(rowIndex);
|
|
if (row == null) {
|
|
row = sheet.createRow(rowIndex);
|
|
}
|
|
return row;
|
|
}
|
|
|
|
|
|
/**
|
|
* Get a specific cell from a row. If the cell doesn't exist, then create it.
|
|
*
|
|
*@param row The row that the cell is part of
|
|
*@param columnIndex The column index that the cell is in.
|
|
*@return The cell indicated by the column.
|
|
*/
|
|
public static Cell getCell(Row row, int columnIndex) {
|
|
Cell cell = row.getCell(columnIndex);
|
|
|
|
if (cell == null) {
|
|
cell = row.createCell(columnIndex);
|
|
}
|
|
return cell;
|
|
}
|
|
|
|
|
|
/**
|
|
* Creates a cell, gives it a value, and applies a style if provided
|
|
*
|
|
* @param row the row to create the cell in
|
|
* @param column the column index to create the cell in
|
|
* @param value The value of the cell
|
|
* @param style If the style is not null, then set
|
|
* @return A new Cell
|
|
*/
|
|
public static Cell createCell(Row row, int column, String value, CellStyle style) {
|
|
Cell cell = getCell(row, column);
|
|
|
|
cell.setCellValue(cell.getRow().getSheet().getWorkbook().getCreationHelper()
|
|
.createRichTextString(value));
|
|
if (style != null) {
|
|
cell.setCellStyle(style);
|
|
}
|
|
return cell;
|
|
}
|
|
|
|
|
|
/**
|
|
* Create a cell, and give it a value.
|
|
*
|
|
*@param row the row to create the cell in
|
|
*@param column the column index to create the cell in
|
|
*@param value The value of the cell
|
|
*@return A new Cell.
|
|
*/
|
|
public static Cell createCell(Row row, int column, String value) {
|
|
return createCell(row, column, value, null);
|
|
}
|
|
|
|
|
|
/**
|
|
* Take a cell, and align it.
|
|
*
|
|
*@param cell the cell to set the alignment for
|
|
*@param workbook The workbook that is being worked with.
|
|
*@param align the column alignment to use.
|
|
*
|
|
* @see CellStyle for alignment options
|
|
*/
|
|
public static void setAlignment(Cell cell, Workbook workbook, short align) {
|
|
setCellStyleProperty(cell, workbook, ALIGNMENT, Short.valueOf(align));
|
|
}
|
|
|
|
/**
|
|
* Take a cell, and apply a font to it
|
|
*
|
|
*@param cell the cell to set the alignment for
|
|
*@param workbook The workbook that is being worked with.
|
|
*@param font The Font that you want to set...
|
|
*/
|
|
public static void setFont(Cell cell, Workbook workbook, Font font) {
|
|
// Check if font belongs to workbook
|
|
final short fontIndex = font.getIndex();
|
|
if (!workbook.getFontAt(fontIndex).equals(font)) {
|
|
throw new IllegalArgumentException("Font does not belong to this workbook");
|
|
}
|
|
|
|
// Check if cell belongs to workbook
|
|
// (checked in setCellStyleProperty)
|
|
|
|
setCellStyleProperty(cell, workbook, FONT, fontIndex);
|
|
}
|
|
|
|
/**
|
|
* <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
|
|
* current style plus styles properties in <code>properties</code>. A new style is created if the
|
|
* workbook does not contain a matching style.</p>
|
|
*
|
|
* <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
|
|
* same style.</p>
|
|
*
|
|
* <p>This is necessary because Excel has an upper limit on the number of styles that it supports.</p>
|
|
*
|
|
* <p>This function is more efficient than multiple calls to
|
|
* {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)}
|
|
* if adding multiple cell styles.</p>
|
|
*
|
|
* <p>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.
|
|
* <!-- NOT IMPLEMENTED: Unused styles should be
|
|
* pruned from the workbook with [@link #removeUnusedCellStyles(Workbook)] or
|
|
* [@link #removeStyleFromWorkbookIfUnused(CellStyle, Workbook)]. -->
|
|
* </p>
|
|
*
|
|
* @param cell The cell to change the style of
|
|
* @param properties The properties to be added to a cell style, as {propertyName: propertyValue}.
|
|
* @since POI 3.14 beta 2
|
|
*/
|
|
public static void setCellStyleProperties(Cell cell, Map<String, Object> properties) {
|
|
@SuppressWarnings("resource")
|
|
Workbook workbook = cell.getSheet().getWorkbook();
|
|
CellStyle originalStyle = cell.getCellStyle();
|
|
CellStyle newStyle = null;
|
|
Map<String, Object> values = getFormatProperties(originalStyle);
|
|
values.putAll(properties);
|
|
|
|
// index seems like what index the cellstyle is in the list of styles for a workbook.
|
|
// not good to compare on!
|
|
int numberCellStyles = workbook.getNumCellStyles();
|
|
|
|
for (int i = 0; i < numberCellStyles; i++) {
|
|
CellStyle wbStyle = workbook.getCellStyleAt(i);
|
|
Map<String, Object> wbStyleMap = getFormatProperties(wbStyle);
|
|
|
|
// the desired style already exists in the workbook. Use the existing style.
|
|
if (wbStyleMap.equals(values)) {
|
|
newStyle = wbStyle;
|
|
break;
|
|
}
|
|
}
|
|
|
|
// the desired style does not exist in the workbook. Create a new style with desired properties.
|
|
if (newStyle == null) {
|
|
newStyle = workbook.createCellStyle();
|
|
setFormatProperties(newStyle, workbook, values);
|
|
}
|
|
|
|
cell.setCellStyle(newStyle);
|
|
}
|
|
|
|
/**
|
|
* <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
|
|
* current style plus a single style property <code>propertyName</code> with value
|
|
* <code>propertyValue<code>.
|
|
* A new style is created if the workbook does not contain a matching style.</p>
|
|
*
|
|
* <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
|
|
* same style.</p>
|
|
*
|
|
* <p>If setting more than one cell style property on a cell, use
|
|
* {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)},
|
|
* which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
|
|
*
|
|
* @param workbook The workbook that is being worked with.
|
|
* @param propertyName The name of the property that is to be changed.
|
|
* @param propertyValue The value of the property that is to be changed.
|
|
* @param cell The cell that needs it's style changes
|
|
*/
|
|
public static void setCellStyleProperty(Cell cell, Workbook workbook, String propertyName,
|
|
Object propertyValue) {
|
|
if (cell.getSheet().getWorkbook() != workbook) {
|
|
throw new IllegalArgumentException("Cannot set cell style property. Cell does not belong to workbook.");
|
|
}
|
|
|
|
Map<String, Object> values = Collections.singletonMap(propertyName, propertyValue);
|
|
setCellStyleProperties(cell, values);
|
|
}
|
|
|
|
/**
|
|
* Returns a map containing the format properties of the given cell style.
|
|
* The returned map is not tied to <code>style</code>, so subsequent changes
|
|
* to <code>style</code> will not modify the map, and changes to the returned
|
|
* map will not modify the cell style. The returned map is mutable.
|
|
*
|
|
* @param style cell style
|
|
* @return map of format properties (String -> Object)
|
|
* @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
|
|
*/
|
|
private static Map<String, Object> getFormatProperties(CellStyle style) {
|
|
Map<String, Object> properties = new HashMap<String, Object>();
|
|
putShort(properties, ALIGNMENT, style.getAlignment());
|
|
putBorderStyle(properties, BORDER_BOTTOM, style.getBorderBottom());
|
|
putBorderStyle(properties, BORDER_LEFT, style.getBorderLeft());
|
|
putBorderStyle(properties, BORDER_RIGHT, style.getBorderRight());
|
|
putBorderStyle(properties, BORDER_TOP, style.getBorderTop());
|
|
putShort(properties, BOTTOM_BORDER_COLOR, style.getBottomBorderColor());
|
|
putShort(properties, DATA_FORMAT, style.getDataFormat());
|
|
putShort(properties, FILL_BACKGROUND_COLOR, style.getFillBackgroundColor());
|
|
putShort(properties, FILL_FOREGROUND_COLOR, style.getFillForegroundColor());
|
|
putShort(properties, FILL_PATTERN, style.getFillPattern());
|
|
putShort(properties, FONT, style.getFontIndex());
|
|
putBoolean(properties, HIDDEN, style.getHidden());
|
|
putShort(properties, INDENTION, style.getIndention());
|
|
putShort(properties, LEFT_BORDER_COLOR, style.getLeftBorderColor());
|
|
putBoolean(properties, LOCKED, style.getLocked());
|
|
putShort(properties, RIGHT_BORDER_COLOR, style.getRightBorderColor());
|
|
putShort(properties, ROTATION, style.getRotation());
|
|
putShort(properties, TOP_BORDER_COLOR, style.getTopBorderColor());
|
|
putShort(properties, VERTICAL_ALIGNMENT, style.getVerticalAlignment());
|
|
putBoolean(properties, WRAP_TEXT, style.getWrapText());
|
|
return properties;
|
|
}
|
|
|
|
/**
|
|
* Sets the format properties of the given style based on the given map.
|
|
*
|
|
* @param style cell style
|
|
* @param workbook parent workbook
|
|
* @param properties map of format properties (String -> Object)
|
|
* @see #getFormatProperties(CellStyle)
|
|
*/
|
|
private static void setFormatProperties(CellStyle style, Workbook workbook, Map<String, Object> properties) {
|
|
style.setAlignment(getShort(properties, ALIGNMENT));
|
|
style.setBorderBottom(getBorderStyle(properties, BORDER_BOTTOM));
|
|
style.setBorderLeft(getBorderStyle(properties, BORDER_LEFT));
|
|
style.setBorderRight(getBorderStyle(properties, BORDER_RIGHT));
|
|
style.setBorderTop(getBorderStyle(properties, BORDER_TOP));
|
|
style.setBottomBorderColor(getShort(properties, BOTTOM_BORDER_COLOR));
|
|
style.setDataFormat(getShort(properties, DATA_FORMAT));
|
|
style.setFillBackgroundColor(getShort(properties, FILL_BACKGROUND_COLOR));
|
|
style.setFillForegroundColor(getShort(properties, FILL_FOREGROUND_COLOR));
|
|
style.setFillPattern(getShort(properties, FILL_PATTERN));
|
|
style.setFont(workbook.getFontAt(getShort(properties, FONT)));
|
|
style.setHidden(getBoolean(properties, HIDDEN));
|
|
style.setIndention(getShort(properties, INDENTION));
|
|
style.setLeftBorderColor(getShort(properties, LEFT_BORDER_COLOR));
|
|
style.setLocked(getBoolean(properties, LOCKED));
|
|
style.setRightBorderColor(getShort(properties, RIGHT_BORDER_COLOR));
|
|
style.setRotation(getShort(properties, ROTATION));
|
|
style.setTopBorderColor(getShort(properties, TOP_BORDER_COLOR));
|
|
style.setVerticalAlignment(getShort(properties, VERTICAL_ALIGNMENT));
|
|
style.setWrapText(getBoolean(properties, WRAP_TEXT));
|
|
}
|
|
|
|
/**
|
|
* Utility method that returns the named short value form the given map.
|
|
*
|
|
* @param properties map of named properties (String -> Object)
|
|
* @param name property name
|
|
* @return zero if the property does not exist, or is not a {@link Short}
|
|
* otherwise the property value
|
|
*/
|
|
private static short getShort(Map<String, Object> properties, String name) {
|
|
Object value = properties.get(name);
|
|
if (value instanceof Short) {
|
|
return ((Short) value).shortValue();
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Utility method that returns the named BorderStyle value form the given map.
|
|
*
|
|
* @param properties map of named properties (String -> Object)
|
|
* @param name property name
|
|
* @return Border style if set, otherwise {@link BorderStyle#NONE}
|
|
*/
|
|
private static BorderStyle getBorderStyle(Map<String, Object> properties, String name) {
|
|
BorderStyle value = (BorderStyle) properties.get(name);
|
|
return (value != null) ? value : BorderStyle.NONE;
|
|
}
|
|
|
|
/**
|
|
* Utility method that returns the named boolean value form the given map.
|
|
*
|
|
* @param properties map of properties (String -> Object)
|
|
* @param name property name
|
|
* @return false if the property does not exist, or is not a {@link Boolean},
|
|
* true otherwise
|
|
*/
|
|
private static boolean getBoolean(Map<String, Object> properties, String name) {
|
|
Object value = properties.get(name);
|
|
//noinspection SimplifiableIfStatement
|
|
if (value instanceof Boolean) {
|
|
return ((Boolean) value).booleanValue();
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Utility method that puts the named short value to the given map.
|
|
*
|
|
* @param properties map of properties (String -> Object)
|
|
* @param name property name
|
|
* @param value property value
|
|
*/
|
|
private static void putShort(Map<String, Object> properties, String name, short value) {
|
|
properties.put(name, Short.valueOf(value));
|
|
}
|
|
|
|
/**
|
|
* Utility method that puts the named short value to the given map.
|
|
*
|
|
* @param properties map of properties (String -> Object)
|
|
* @param name property name
|
|
* @param value property value
|
|
*/
|
|
private static void putBorderStyle(Map<String, Object> properties, String name, BorderStyle border) {
|
|
properties.put(name, border);
|
|
}
|
|
|
|
/**
|
|
* Utility method that puts the named boolean value to the given map.
|
|
*
|
|
* @param properties map of properties (String -> Object)
|
|
* @param name property name
|
|
* @param value property value
|
|
*/
|
|
private static void putBoolean(Map<String, Object> properties, String name, boolean value) {
|
|
properties.put(name, Boolean.valueOf(value));
|
|
}
|
|
|
|
/**
|
|
* Looks for text in the cell that should be unicode, like α and provides the
|
|
* unicode version of it.
|
|
*
|
|
*@param cell The cell to check for unicode values
|
|
*@return translated to unicode
|
|
*/
|
|
public static Cell translateUnicodeValues(Cell cell) {
|
|
|
|
String s = cell.getRichStringCellValue().getString();
|
|
boolean foundUnicode = false;
|
|
String lowerCaseStr = s.toLowerCase(Locale.ROOT);
|
|
|
|
for (UnicodeMapping entry : unicodeMappings) {
|
|
String key = entry.entityName;
|
|
if (lowerCaseStr.contains(key)) {
|
|
s = s.replaceAll(key, entry.resolvedValue);
|
|
foundUnicode = true;
|
|
}
|
|
}
|
|
if (foundUnicode) {
|
|
cell.setCellValue(cell.getRow().getSheet().getWorkbook().getCreationHelper()
|
|
.createRichTextString(s));
|
|
}
|
|
return cell;
|
|
}
|
|
|
|
static {
|
|
unicodeMappings = new UnicodeMapping[] {
|
|
um("alpha", "\u03B1" ),
|
|
um("beta", "\u03B2" ),
|
|
um("gamma", "\u03B3" ),
|
|
um("delta", "\u03B4" ),
|
|
um("epsilon", "\u03B5" ),
|
|
um("zeta", "\u03B6" ),
|
|
um("eta", "\u03B7" ),
|
|
um("theta", "\u03B8" ),
|
|
um("iota", "\u03B9" ),
|
|
um("kappa", "\u03BA" ),
|
|
um("lambda", "\u03BB" ),
|
|
um("mu", "\u03BC" ),
|
|
um("nu", "\u03BD" ),
|
|
um("xi", "\u03BE" ),
|
|
um("omicron", "\u03BF" ),
|
|
};
|
|
}
|
|
|
|
private static UnicodeMapping um(String entityName, String resolvedValue) {
|
|
return new UnicodeMapping(entityName, resolvedValue);
|
|
}
|
|
}
|