*/ -public class HSSFCell implements Cell { +public class HSSFCell extends CellBase { private static final String FILE_FORMAT_NAME = "BIFF8"; /** * The maximum number of columns in BIFF8 @@ -255,17 +256,10 @@ public class HSSFCell implements Cell { return new CellAddress(this); } - /** - * Set the cells type (numeric, formula or string). - * If the cell currently contains a value, the value will - * be converted to match the new type, if possible. - */ @Override - public void setCellType(CellType cellType) { + protected void setCellTypeImpl(CellType cellType) { notifyFormulaChanging(); - if(isPartOfArrayFormulaGroup()){ - notifyArrayFormulaChanging(); - } + int row=_record.getRow(); short col=_record.getColumn(); short styleIndex=_record.getXFIndex(); @@ -594,26 +588,21 @@ public class HSSFCell implements Cell { _stringValue.setUnicodeString(_book.getWorkbook().getSSTString(index)); } - public void setCellFormula(String formula) { - if(isPartOfArrayFormulaGroup()){ - notifyArrayFormulaChanging(); - } + @Override + protected void setCellFormulaImpl(String formula) { + assert formula != null; int row=_record.getRow(); short col=_record.getColumn(); short styleIndex=_record.getXFIndex(); - if (formula==null) { - notifyFormulaChanging(); - setCellType(CellType.BLANK, false, row, col, styleIndex); - return; - } int sheetIndex = _book.getSheetIndex(_sheet); Ptg[] ptgs = HSSFFormulaParser.parse(formula, _book, FormulaType.CELL, sheetIndex); setCellType(CellType.FORMULA, false, row, col, styleIndex); FormulaRecordAggregate agg = (FormulaRecordAggregate) _record; FormulaRecord frec = agg.getFormulaRecord(); frec.setOptions((short) 2); + frec.setValue(0); //only set to default if there is no extended format index already set @@ -622,6 +611,42 @@ public class HSSFCell implements Cell { } agg.setParsedExpression(ptgs); } + + @Override + protected void removeFormulaImpl() { + assert getCellType() == CellType.FORMULA; + + notifyFormulaChanging(); + + switch (getCachedFormulaResultType()) { + case NUMERIC: + double numericValue = ((FormulaRecordAggregate)_record).getFormulaRecord().getValue(); + _record = new NumberRecord(); + ((NumberRecord)_record).setValue(numericValue); + _cellType = CellType.NUMERIC; + break; + case STRING: + _record = new NumberRecord(); + ((NumberRecord)_record).setValue(0); + _cellType = CellType.STRING; + break; + case BOOLEAN: + boolean booleanValue = ((FormulaRecordAggregate)_record).getFormulaRecord().getCachedBooleanValue(); + _record = new BoolErrRecord(); + ((BoolErrRecord)_record).setValue(booleanValue); + _cellType = CellType.BOOLEAN; + break; + case ERROR: + byte errorValue = (byte) ((FormulaRecordAggregate)_record).getFormulaRecord().getCachedErrorValue(); + _record = new BoolErrRecord(); + ((BoolErrRecord)_record).setValue(errorValue); + _cellType = CellType.ERROR; + break; + default: + throw new AssertionError(); + } + } + /** * Should be called any time that a formula could potentially be deleted. * Does nothing if this cell currently does not hold a formula @@ -1192,40 +1217,6 @@ public class HSSFCell implements Cell { return _cellType == CellType.FORMULA && ((FormulaRecordAggregate) _record).isPartOfArrayFormula(); } - /** - * The purpose of this method is to validate the cell state prior to modification - * - * @see #notifyArrayFormulaChanging() - */ - void notifyArrayFormulaChanging(String msg){ - CellRangeAddress cra = getArrayFormulaRange(); - if(cra.getNumberOfCells() > 1) { - throw new IllegalStateException(msg); - } - //un-register the single-cell array formula from the parent XSSFSheet - getRow().getSheet().removeArrayFormula(this); - } - - /** - * Called when this cell is modified. - *
- * The purpose of this method is to validate the cell state prior to modification. - *
- * - * @see #setCellFormula(String) - * @see HSSFRow#removeCell(org.apache.poi.ss.usermodel.Cell) - * @see org.apache.poi.hssf.usermodel.HSSFSheet#removeRow(org.apache.poi.ss.usermodel.Row) - * @see org.apache.poi.hssf.usermodel.HSSFSheet#shiftRows(int, int, int) - * @see org.apache.poi.hssf.usermodel.HSSFSheet#addMergedRegion(org.apache.poi.ss.util.CellRangeAddress) - * @throws IllegalStateException if modification is not allowed - */ - void notifyArrayFormulaChanging(){ - CellReference ref = new CellReference(this); - String msg = "Cell "+ref.formatAsString()+" is part of a multi-cell array formula. " + - "You cannot change part of an array."; - notifyArrayFormulaChanging(msg); - } - /** * 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. diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java index 845b58a009..9f5461cff3 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -164,7 +164,7 @@ public final class HSSFRow implements Row, ComparableIf the cell currently contains a value, the value will * be converted to match the new type, if possible. Formatting * is generally lost in the process however.
+ *Conversion rules:
+ *to NUMERIC: numeric value is left as is. True converts to 1.0, false converts to 0. otherwise, the + * value is set to 0. Formula is removed.
*If what you want to do is get a String value for your * numeric cell, stop!. This is not the way to do it. * Instead, for fetching the string value of a numeric or boolean - * or date cell, use {@link DataFormatter} instead.
- * - * @throws IllegalArgumentException if the specified cell type is invalid - * @throws IllegalStateException if the current value cannot be converted to the new type + * or date cell, use {@link DataFormatter} instead. + *If cell is a member of an array formula group containing more than 1 cell, an {@link IllegalStateException} + * is thrown. If the array formula group contains only this cell, it is removed
+ * @throws IllegalArgumentException if the specified cell type is invalid (null or _NONE) + * @throws IllegalStateException if the current value cannot be converted to the new type or + * if the cell is a part of an array formula group containing other cells */ void setCellType(CellType cellType); @@ -90,7 +95,7 @@ public interface Cell { * @return the cell type */ CellType getCellType(); - + /** * Return the cell type. * @@ -101,13 +106,13 @@ public interface Cell { @Deprecated @Removal(version="4.2") CellType getCellTypeEnum(); - + /** * Only valid for formula cells - * + * * Will return {@link CellType} in a future version of POI. * For forwards compatibility, do not hard-code cell type literals in your code. - * + * * @return one of ({@link CellType#NUMERIC}, {@link CellType#STRING}, * {@link CellType#BOOLEAN}, {@link CellType#ERROR}) depending * on the cached value of the formula @@ -138,7 +143,7 @@ public interface Cell { /** *Converts the supplied date to its equivalent Excel numeric value and sets * that into the cell.
- * + * *Note - There is actually no 'DATE' cell type in Excel. In many * cases (when entering date values), Excel automatically adjusts the * cell style to some date format, creating the illusion that the cell @@ -193,16 +198,33 @@ public interface Cell { /** * Sets formula for this cell. + * *
* Note, this method only sets the formula string and does not calculate the formula value. - * To set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)} + * To set the precalculated value use {@link #setCellValue} + *
+ * + *+ * If the cell was blank, sets value to 0. Otherwise, preserves the value as precalculated. *
* * @param formula the formula to set, e.g."SUM(C4:E4)".
- * If the argument is null then the current formula is removed.
+ * If the argument is null then the current formula is removed.
+ *
+ * @throws IllegalStateException if this cell is a part of an array formula group containing other cells
* @throws FormulaParseException if the formula has incorrect syntax or is otherwise invalid
*/
- void setCellFormula(String formula) throws FormulaParseException;
+ void setCellFormula(String formula) throws FormulaParseException, IllegalStateException;
+
+ /**
+ * Removes formula, if any.
+ *
+ * If cell was blank, leaves it as is.
+ * If it is a part of an array formula group, blanks the cell.
+ * If has a regular formula, removes the formula preserving the "cached" value.
+ * @throws IllegalStateException if cell is a part of an array formula group containing other cells
+ */
+ void removeFormula() throws IllegalStateException;
/**
* Return a formula for the cell, for example, SUM(C4:E4)
@@ -304,7 +326,7 @@ public interface Cell {
/**
* Set the style for the cell. The style should be an CellStyle created/retrieved from * the Workbook.
- * + * *To change the style of a cell without affecting other cells that use the same style, * use {@link org.apache.poi.ss.util.CellUtil#setCellStyleProperties(Cell, Map)}
* diff --git a/src/java/org/apache/poi/ss/usermodel/CellBase.java b/src/java/org/apache/poi/ss/usermodel/CellBase.java new file mode 100644 index 0000000000..5a7e1f282a --- /dev/null +++ b/src/java/org/apache/poi/ss/usermodel/CellBase.java @@ -0,0 +1,137 @@ +/* ==================================================================== + 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.usermodel; + +import org.apache.poi.ss.formula.FormulaParseException; +import org.apache.poi.ss.util.CellRangeAddress; +import org.apache.poi.ss.util.CellReference; + +/** + * Common implementation-independent logic shared by all implementations of {@link Cell}. + * @author Vladislav "gallon" Galas gallon at apache dot org + */ +public abstract class CellBase implements Cell { + /** + * {@inheritDoc} + */ + @Override + public final void setCellType(CellType cellType) { + if (cellType == null || cellType == CellType._NONE) { + throw new IllegalArgumentException("cellType shall not be null nor _NONE"); + } + + tryToDeleteArrayFormulaIfSet(); + + setCellTypeImpl(cellType); + } + + /** + * Implementation-specific logic + * @param cellType new cell type. Guaranteed non-null, not _NONE. + */ + protected abstract void setCellTypeImpl(CellType cellType); + + /** + * Called when this an array formula in this cell is deleted. + *The purpose of this method is to validate the cell state prior to modification.
+ * + * @param message a customized exception message for the case if deletion of the cell is impossible. If null, a + * default message will be generated + * @see #setCellType(CellType) + * @see #setCellFormula(String) + * @see Row#removeCell(org.apache.poi.ss.usermodel.Cell) + * @see org.apache.poi.ss.usermodel.Sheet#removeRow(org.apache.poi.ss.usermodel.Row) + * @see org.apache.poi.ss.usermodel.Sheet#shiftRows(int, int, int) + * @see org.apache.poi.ss.usermodel.Sheet#addMergedRegion(org.apache.poi.ss.util.CellRangeAddress) + * @throws IllegalStateException if modification is not allowed + * + * Note. Exposing this to public is ugly. Needed for methods like Sheet#shiftRows. + */ + public final void tryToDeleteArrayFormula(String message) { + assert isPartOfArrayFormulaGroup(); + + CellRangeAddress arrayFormulaRange = getArrayFormulaRange(); + if(arrayFormulaRange.getNumberOfCells() > 1) { + if (message == null) { + message = "Cell " + new CellReference(this).formatAsString() + " is part of a multi-cell array formula. " + + "You cannot change part of an array."; + } + throw new IllegalStateException(message); + } + //un-register the single-cell array formula from the parent sheet through public interface + getRow().getSheet().removeArrayFormula(this); + } + + /** + * {@inheritDoc} + */ + @Override + public final void setCellFormula(String formula) throws FormulaParseException, IllegalStateException { + if (formula == null) { + removeFormula(); + return; + } + + CellType previousValueType = getCellType() == CellType.FORMULA ? getCachedFormulaResultType() : getCellType(); + + tryToDeleteArrayFormulaIfSet(); + + setCellFormulaImpl(formula); + + if (previousValueType == CellType.BLANK) { + setCellValue(0); + } + } + + /** + * Implementation-specific setting the formula. + * Shall not change the value. + * @param formula + */ + protected abstract void setCellFormulaImpl(String formula); + + /** + * {@inheritDoc} + */ + @Override + public final void removeFormula() { + if (getCellType() == CellType.BLANK) { + return; + } + + if (isPartOfArrayFormulaGroup()) { + tryToDeleteArrayFormula(null); + return; + } + + removeFormulaImpl(); + } + + /** + * Implementation-specific removal of the formula. + * The cell is guaranteed to have a regular formula set. + * Shall preserve the "cached" value. + */ + protected abstract void removeFormulaImpl(); + + private void tryToDeleteArrayFormulaIfSet() { + if (isPartOfArrayFormulaGroup()) { + tryToDeleteArrayFormula(null); + } + } +} diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java index 8917e60105..29b4b2652b 100644 --- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java +++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java @@ -27,6 +27,7 @@ import org.apache.poi.ss.SpreadsheetVersion; import org.apache.poi.ss.formula.FormulaParseException; import org.apache.poi.ss.formula.eval.ErrorEval; import org.apache.poi.ss.usermodel.Cell; +import org.apache.poi.ss.usermodel.CellBase; import org.apache.poi.ss.usermodel.CellStyle; import org.apache.poi.ss.usermodel.CellType; import org.apache.poi.ss.usermodel.Comment; @@ -45,7 +46,7 @@ import org.apache.poi.xssf.usermodel.XSSFRichTextString; /** * Streaming version of XSSFCell implementing the "BigGridDemo" strategy. */ -public class SXSSFCell implements Cell { +public class SXSSFCell extends CellBase { private final SXSSFRow _row; private Value _value; private CellStyle _style; @@ -111,14 +112,8 @@ public class SXSSFCell implements Cell { return _row; } - /** - * Set the cells type (numeric, formula or string) - * - * @throws IllegalArgumentException if the specified cell type is invalid - */ @Override - public void setCellType(CellType cellType) - { + protected void setCellTypeImpl(CellType cellType) { ensureType(cellType); } @@ -331,7 +326,7 @@ public class SXSSFCell implements Cell { * @throws FormulaParseException if the formula has incorrect syntax or is otherwise invalid */ @Override - public void setCellFormula(String formula) throws FormulaParseException + public void setCellFormulaImpl(String formula) throws FormulaParseException { if(formula == null) { setType(CellType.BLANK); @@ -341,6 +336,36 @@ public class SXSSFCell implements Cell { ensureFormulaType(computeTypeFromFormula(formula)); ((FormulaValue)_value).setValue(formula); } + + @Override + protected void removeFormulaImpl() { + assert getCellType() == CellType.FORMULA; + switch (getCachedFormulaResultType()) { + case NUMERIC: + double numericValue = ((NumericFormulaValue)_value).getPreEvaluatedValue(); + _value = new NumericValue(); + ((NumericValue) _value).setValue(numericValue); + break; + case STRING: + String stringValue = ((StringFormulaValue)_value).getPreEvaluatedValue(); + _value = new PlainStringValue(); + ((PlainStringValue) _value).setValue(stringValue); + break; + case BOOLEAN: + boolean booleanValue = ((BooleanFormulaValue)_value).getPreEvaluatedValue(); + _value = new BooleanValue(); + ((BooleanValue) _value).setValue(booleanValue); + break; + case ERROR: + byte errorValue = ((ErrorFormulaValue)_value).getPreEvaluatedValue(); + _value = new ErrorValue(); + ((ErrorValue) _value).setValue(errorValue); + break; + default: + throw new AssertionError(); + } + } + /** * Return a formula for the cell, for example,SUM(C4:E4)
*
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
index 864b031729..e336ae458b 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
@@ -30,6 +30,7 @@ import org.apache.poi.ss.formula.SharedFormula;
import org.apache.poi.ss.formula.eval.ErrorEval;
import org.apache.poi.ss.formula.ptg.Ptg;
import org.apache.poi.ss.usermodel.Cell;
+import org.apache.poi.ss.usermodel.CellBase;
import org.apache.poi.ss.usermodel.CellCopyPolicy;
import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.CellType;
@@ -70,7 +71,7 @@ import org.openxmlformats.schemas.spreadsheetml.x2006.main.STCellType;
* cells that have values should be added.
*
*/
-public final class XSSFCell implements Cell {
+public final class XSSFCell extends CellBase {
private static final String FALSE_AS_STRING = "0";
private static final String TRUE_AS_STRING = "1";
@@ -549,10 +550,7 @@ public final class XSSFCell implements Cell {
* when the cell is a part of a multi-cell array formula
*/
@Override
- public void setCellFormula(String formula) {
- if(isPartOfArrayFormulaGroup()){
- notifyArrayFormulaChanging();
- }
+ protected void setCellFormulaImpl(String formula) {
setFormula(formula, FormulaType.CELL);
}
@@ -565,7 +563,7 @@ public final class XSSFCell implements Cell {
private void setFormula(String formula, FormulaType formulaType) {
XSSFWorkbook wb = _row.getSheet().getWorkbook();
- if (formula == null) {
+ if (formulaType == FormulaType.ARRAY && formula == null) {
wb.onDeleteFormula(this);
if (_cell.isSetF()) {
_row.getSheet().onDeleteFormula(this, null);
@@ -597,6 +595,15 @@ public final class XSSFCell implements Cell {
}
}
+ @Override
+ protected void removeFormulaImpl() {
+ _row.getSheet().getWorkbook().onDeleteFormula(this);
+ if (_cell.isSetF()) {
+ _row.getSheet().onDeleteFormula(this, null);
+ _cell.unsetF();
+ }
+ }
+
/**
* Returns column index of this cell
*
@@ -960,13 +967,8 @@ public final class XSSFCell implements Cell {
_cell.setR(ref);
}
- /**
- * Set the cells type (numeric, formula or string)
- *
- * @throws IllegalArgumentException if the specified cell type is invalid
- */
@Override
- public void setCellType(CellType cellType) {
+ protected void setCellTypeImpl(CellType cellType) {
setCellType(cellType, null);
}
@@ -978,10 +980,6 @@ public final class XSSFCell implements Cell {
*/
protected void setCellType(CellType cellType, BaseXSSFEvaluationWorkbook evalWb) {
CellType prevType = getCellType();
-
- if(isPartOfArrayFormulaGroup()){
- notifyArrayFormulaChanging();
- }
if(prevType == CellType.FORMULA && cellType != CellType.FORMULA) {
if (_cell.isSetF()) {
_row.getSheet().onDeleteFormula(this, evalWb);
@@ -1307,48 +1305,12 @@ public final class XSSFCell implements Cell {
return getSheet().isCellInArrayFormulaContext(this);
}
- /**
- * The purpose of this method is to validate the cell state prior to modification
- *
- * @see #notifyArrayFormulaChanging()
- */
- void notifyArrayFormulaChanging(String msg){
- if(isPartOfArrayFormulaGroup()){
- CellRangeAddress cra = getArrayFormulaRange();
- if(cra.getNumberOfCells() > 1) {
- throw new IllegalStateException(msg);
- }
- //un-register the single-cell array formula from the parent XSSFSheet
- getRow().getSheet().removeArrayFormula(this);
- }
- }
-
- /**
- * Called when this cell is modified.
- * - * The purpose of this method is to validate the cell state prior to modification. - *
- * - * @see #setCellType(CellType) - * @see #setCellFormula(String) - * @see XSSFRow#removeCell(org.apache.poi.ss.usermodel.Cell) - * @see org.apache.poi.xssf.usermodel.XSSFSheet#removeRow(org.apache.poi.ss.usermodel.Row) - * @see org.apache.poi.xssf.usermodel.XSSFSheet#shiftRows(int, int, int) - * @see org.apache.poi.xssf.usermodel.XSSFSheet#addMergedRegion(org.apache.poi.ss.util.CellRangeAddress) - * @throws IllegalStateException if modification is not allowed - */ - void notifyArrayFormulaChanging(){ - CellReference ref = new CellReference(this); - String msg = "Cell "+ref.formatAsString()+" is part of a multi-cell array formula. " + - "You cannot change part of an array."; - notifyArrayFormulaChanging(msg); - } - - - //Moved from XSSFRow.shift(). Not sure what is purpose. + //Moved from XSSFRow.shift(). Not sure what is purpose. public void updateCellReferencesForShifting(String msg){ - if(isPartOfArrayFormulaGroup()) - notifyArrayFormulaChanging(msg); + if(isPartOfArrayFormulaGroup()) { + tryToDeleteArrayFormula(msg); + } + CalculationChain calcChain = getSheet().getWorkbook().getCalculationChain(); int sheetId = (int)getSheet().sheet.getSheetId(); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java index 66307c206d..363fc5bd9b 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java @@ -480,7 +480,7 @@ public class XSSFRow implements Row, Comparable