aboutsummaryrefslogtreecommitdiffstats
path: root/src/ooxml
diff options
context:
space:
mode:
authorYegor Kozlov <yegor@apache.org>2009-12-29 19:47:38 +0000
committerYegor Kozlov <yegor@apache.org>2009-12-29 19:47:38 +0000
commit58fd7703351834fbe399724d3627681f0ce028fb (patch)
tree3e6283a115350db7eb88e2148ede46486959d998 /src/ooxml
parent5c08e67cd0055d09e267719098ffe73015ced326 (diff)
downloadpoi-58fd7703351834fbe399724d3627681f0ce028fb.tar.gz
poi-58fd7703351834fbe399724d3627681f0ce028fb.zip
improved usermodel to prevent data corruption when setting array formulas, mimic Excel behaviour and block changing cells included in multi-cell arrays
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@894469 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/ooxml')
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java46
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java15
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java48
-rw-r--r--src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheetUpdateArrayFormulas.java4
4 files changed, 105 insertions, 8 deletions
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 f2a4c497b0..9a6be02014 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
@@ -385,8 +385,13 @@ public final class XSSFCell implements Cell {
* @param formula the formula to set, e.g. <code>"SUM(C4:E4)"</code>.
* If the argument is <code>null</code> then the current formula is removed.
* @throws org.apache.poi.ss.formula.FormulaParseException if the formula has incorrect syntax or is otherwise invalid
+ * @throws IllegalStateException if the operation is not allowed, for example,
+ * when the cell is a part of a multi-cell array formula
*/
public void setCellFormula(String formula) {
+ if(isPartOfArrayFormulaGroup()){
+ notifyArrayFormulaChanging();
+ }
setFormula(formula, FormulaType.CELL);
}
@@ -694,6 +699,10 @@ public final class XSSFCell implements Cell {
* @see #CELL_TYPE_ERROR
*/
public void setCellType(int cellType) {
+ if(isPartOfArrayFormulaGroup()){
+ notifyArrayFormulaChanging();
+ }
+
int prevType = getCellType();
switch (cellType) {
case CELL_TYPE_BLANK:
@@ -982,4 +991,41 @@ public final class XSSFCell implements Cell {
public boolean isPartOfArrayFormulaGroup() {
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.
+ * <p>
+ * The purpose of this method is to validate the cell state prior to modification.
+ * </p>
+ *
+ * @see #setCellType(int)
+ * @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);
+ }
}
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 9e564023e9..61535c5cd3 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
@@ -361,7 +361,15 @@ public class XSSFRow implements Row, Comparable<XSSFRow> {
* @param cell the cell to remove
*/
public void removeCell(Cell cell) {
- _cells.remove(cell.getColumnIndex());
+ if (cell.getRow() != this) {
+ throw new IllegalArgumentException("Specified cell does not belong to this row");
+ }
+
+ XSSFCell xcell = (XSSFCell)cell;
+ if(xcell.isPartOfArrayFormulaGroup()){
+ xcell.notifyArrayFormulaChanging();
+ }
+ _cells.remove(cell.getColumnIndex());
}
/**
@@ -409,8 +417,13 @@ public class XSSFRow implements Row, Comparable<XSSFRow> {
int rownum = getRowNum() + n;
CalculationChain calcChain = _sheet.getWorkbook().getCalculationChain();
int sheetId = (int)_sheet.sheet.getSheetId();
+ String msg = "Row[rownum="+getRowNum()+"] contains cell(s) included in a multi-cell array formula. " +
+ "You cannot change part of an array.";
for(Cell c : this){
XSSFCell cell = (XSSFCell)c;
+ if(cell.isPartOfArrayFormulaGroup()){
+ cell.notifyArrayFormulaChanging(msg);
+ }
//remove the reference in the calculation chain
if(calcChain != null) calcChain.removeItem(sheetId, cell.getReference());
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 61b7d3fe10..08e5c95ea1 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -244,18 +244,50 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
/**
* Adds a merged region of cells (hence those cells form one).
*
- * @param cra (rowfrom/colfrom-rowto/colto) to merge
+ * @param region (rowfrom/colfrom-rowto/colto) to merge
* @return index of this region
*/
- public int addMergedRegion(CellRangeAddress cra) {
- cra.validate(SpreadsheetVersion.EXCEL2007);
+ public int addMergedRegion(CellRangeAddress region) {
+ region.validate(SpreadsheetVersion.EXCEL2007);
+
+ // throw IllegalStateException if the argument CellRangeAddress intersects with
+ // a multi-cell array formula defined in this sheet
+ validateArrayFormulas(region);
CTMergeCells ctMergeCells = worksheet.isSetMergeCells() ? worksheet.getMergeCells() : worksheet.addNewMergeCells();
CTMergeCell ctMergeCell = ctMergeCells.addNewMergeCell();
- ctMergeCell.setRef(cra.formatAsString());
+ ctMergeCell.setRef(region.formatAsString());
return ctMergeCells.sizeOfMergeCellArray();
}
+ private void validateArrayFormulas(CellRangeAddress region){
+ int firstRow = region.getFirstRow();
+ int firstColumn = region.getFirstColumn();
+ int lastRow = region.getLastRow();
+ int lastColumn = region.getLastColumn();
+ for (int rowIn = firstRow; rowIn <= lastRow; rowIn++) {
+ for (int colIn = firstColumn; colIn <= lastColumn; colIn++) {
+ XSSFRow row = getRow(rowIn);
+ if (row == null) continue;
+
+ XSSFCell cell = row.getCell(colIn);
+ if(cell == null) continue;
+
+ if(cell.isPartOfArrayFormulaGroup()){
+ CellRangeAddress arrayRange = cell.getArrayFormulaRange();
+ if (arrayRange.getNumberOfCells() > 1 &&
+ ( arrayRange.isInRange(region.getFirstRow(), region.getFirstColumn()) ||
+ arrayRange.isInRange(region.getFirstRow(), region.getFirstColumn())) ){
+ String msg = "The range " + region.formatAsString() + " intersects with a multi-cell array formula. " +
+ "You cannot merge cells of an array.";
+ throw new IllegalStateException(msg);
+ }
+ }
+ }
+ }
+
+ }
+
/**
* Adjusts the column width to fit the contents.
*
@@ -1279,7 +1311,13 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
if (row.getSheet() != this) {
throw new IllegalArgumentException("Specified row does not belong to this sheet");
}
-
+ for(Cell cell : row) {
+ XSSFCell xcell = (XSSFCell)cell;
+ String msg = "Row[rownum="+row.getRowNum()+"] contains cell(s) included in a multi-cell array formula. You cannot change part of an array.";
+ if(xcell.isPartOfArrayFormulaGroup()){
+ xcell.notifyArrayFormulaChanging(msg);
+ }
+ }
rows.remove(row.getRowNum());
}
diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheetUpdateArrayFormulas.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheetUpdateArrayFormulas.java
index b703c48cd0..fc55ffdebc 100644
--- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheetUpdateArrayFormulas.java
+++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFSheetUpdateArrayFormulas.java
@@ -19,8 +19,7 @@ package org.apache.poi.xssf.usermodel;
import junit.framework.AssertionFailedError;
-import org.apache.poi.ss.usermodel.BaseTestSheetUpdateArrayFormulas;
-import org.apache.poi.ss.usermodel.CellRange;
+import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.xssf.XSSFITestDataProvider;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCell;
@@ -106,4 +105,5 @@ public final class TestXSSFSheetUpdateArrayFormulas extends BaseTestSheetUpdateA
assertEquals(STCellFormulaType.ARRAY, f.getT());
}
}
+
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-03 19:53:44 +0000