123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196 |
- /* ====================================================================
- 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.tests.formula;
-
- import static org.junit.jupiter.api.Assertions.assertEquals;
- import static org.junit.jupiter.api.Assertions.assertFalse;
- import static org.junit.jupiter.api.Assertions.assertTrue;
-
- import org.apache.poi.ss.SpreadsheetVersion;
- import org.apache.poi.ss.usermodel.Cell;
- import org.apache.poi.ss.usermodel.CellType;
- import org.apache.poi.ss.usermodel.CellValue;
- import org.apache.poi.ss.usermodel.FormulaEvaluator;
- import org.apache.poi.ss.usermodel.Row;
- import org.apache.poi.ss.usermodel.Table;
- import org.apache.poi.ss.util.AreaReference;
- import org.apache.poi.ss.util.CellReference;
- import org.apache.poi.xssf.XSSFTestDataSamples;
- import org.apache.poi.xssf.usermodel.*;
- import org.junit.jupiter.api.Test;
-
- /**
- * Tests Excel Table expressions (structured references)
- * @see <a href="https://support.office.com/en-us/article/Using-structured-references-with-Excel-tables-F5ED2452-2337-4F71-BED3-C8AE6D2B276E">
- * Excel Structured Reference Syntax
- * </a>
- */
- class TestStructuredReferences {
-
- /**
- * Test the regular expression used in INDIRECT() evaluation to recognize structured references
- */
- @Test
- void testTableExpressionSyntax() {
- assertTrue(Table.isStructuredReference.matcher("abc[col1]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("_abc[col1]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("_[col1]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("\\[col1]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("\\[col1]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("\\[#This Row]").matches(), "Valid structured reference syntax didn't match expression");
- assertTrue(Table.isStructuredReference.matcher("\\[ [col1], [col2] ]").matches(), "Valid structured reference syntax didn't match expression");
-
- // can't have a space between the table name and open bracket
- assertFalse(Table.isStructuredReference.matcher("\\abc [ [col1], [col2] ]").matches(), "Invalid structured reference syntax didn't fail expression");
- }
-
- @Test
- void testTableFormulas() throws Exception {
- try (XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("StructuredReferences.xlsx")) {
-
- final FormulaEvaluator eval = new XSSFFormulaEvaluator(wb);
- final XSSFSheet tableSheet = wb.getSheet("Table");
- final XSSFSheet formulaSheet = wb.getSheet("Formulas");
-
- confirm(eval, tableSheet.getRow(5).getCell(0), 49);
- confirm(eval, formulaSheet.getRow(0).getCell(0), 209);
- confirm(eval, formulaSheet.getRow(1).getCell(0), "one");
-
- // test changing a table value, to see if the caches are properly cleared
- // Issue 59814
-
- // this test passes before the fix for 59814
- tableSheet.getRow(1).getCell(1).setCellValue("ONEA");
- confirm(eval, formulaSheet.getRow(1).getCell(0), "ONEA");
-
- // test adding a row to a table, issue 59814
- Row newRow = tableSheet.getRow(7);
- if (newRow == null) newRow = tableSheet.createRow(7);
- newRow.createCell(0, CellType.FORMULA).setCellFormula("\\_Prime.1[[#This Row],[@Number]]*\\_Prime.1[[#This Row],[@Number]]");
- newRow.createCell(1, CellType.STRING).setCellValue("thirteen");
- newRow.createCell(2, CellType.NUMERIC).setCellValue(13);
-
- // update Table
- final XSSFTable table = wb.getTable("\\_Prime.1");
- final AreaReference newArea = wb.getCreationHelper().createAreaReference(
- table.getStartCellReference(),
- new CellReference(table.getEndRowIndex() + 1, table.getEndColIndex()));
- String newAreaStr = newArea.formatAsString();
- table.getCTTable().setRef(newAreaStr);
- table.getCTTable().getAutoFilter().setRef(newAreaStr);
- table.updateHeaders();
- table.updateReferences();
-
- // these fail before the fix for 59814
- confirm(eval, tableSheet.getRow(7).getCell(0), 13 * 13);
- confirm(eval, formulaSheet.getRow(0).getCell(0), 209 + 13 * 13);
-
- }
- }
-
- @Test
- void testCellFormulaValidationFalse() throws Exception {
- //relates to https://bz.apache.org/bugzilla/show_bug.cgi?id=66039
- try (XSSFWorkbook workbook = new XSSFWorkbook()) {
- workbook.setCellFormulaValidation(false);
- XSSFSheet sheet = workbook.createSheet();
-
- //set sheet content
- sheet.createRow(0).createCell(0).setCellValue("Field1");
- sheet.getRow(0).createCell(1).setCellValue("Field2");
- sheet.createRow(1).createCell(0).setCellValue(123);
- sheet.getRow(1).createCell(1);
-
- //create the table
- String tableName = "Table1";
- CellReference topLeft = new CellReference(sheet.getRow(0).getCell(0));
- CellReference bottomRight = new CellReference(sheet.getRow(1).getCell(1));
- AreaReference tableArea = workbook.getCreationHelper().createAreaReference(topLeft, bottomRight);
- XSSFTable dataTable = sheet.createTable(tableArea);
- dataTable.setName(tableName);
- dataTable.setDisplayName(tableName);
-
- //set the formula in sheet - when setCellFormulaValidation=true (the default), the code tries to
- //tidy up this formula (but incorrectly, in this case) - gets adjusted to Sheet0!A2:A2
- XSSFCell formulaCell = sheet.getRow(1).getCell(1);
- formulaCell.setCellFormula(tableName + "[[#This Row],[Field1]]");
-
- assertEquals("Table1[[#This Row],[Field1]]", formulaCell.getCellFormula());
- }
- }
-
- @Test
- void testBug66215() throws Exception {
- //relates to https://bz.apache.org/bugzilla/show_bug.cgi?id=66215 (this does not work as it should)
- try (XSSFWorkbook workbook = XSSFTestDataSamples.openSampleWorkbook("bug66215.xlsx")) {
- XSSFSheet sheet = workbook.getSheetAt(0);
- XSSFRow row3 = sheet.getRow(3);
- XSSFRow row5 = sheet.getRow(5);
- assertEquals("Tabelle1[[#This Row],[Total]]/Tabelle1[[#Totals],[Total]]", row3.getCell(5).getCellFormula());
- assertEquals("Tabelle1[[#This Row],[Total]]/Tabelle1[[#Totals],[Total]]", row5.getCell(5).getCellFormula());
- XSSFTable table = sheet.getTables().get(0);
-
- int lastTableRow = table.getEndCellReference().getRow();
- int totalsRowCount = table.getTotalsRowCount();
- int lastTableDataRow = lastTableRow - totalsRowCount;
-
- // we will add one row in table data
- lastTableRow++;
- lastTableDataRow++;
-
- // new table area plus one row
- AreaReference newTableArea = new AreaReference(
- table.getStartCellReference(),
- new CellReference(
- lastTableRow,
- table.getEndCellReference().getCol()
- ),
- SpreadsheetVersion.EXCEL2007
- );
-
- if (totalsRowCount > 0) {
- workbook.setCellFormulaValidation(false);
- sheet.shiftRows(lastTableDataRow, lastTableRow++, 1);
- }
-
- // set new table area
- table.setArea(newTableArea);
-
- XSSFRow row4 = sheet.getRow(4);
- //the next formula has been adjusted more than it should but seems to return correct value
- assertEquals("Tabelle2!E5:E5/Tabelle2!E8:E8", row4.getCell(5).getCellFormula());
- XSSFRow row7 = sheet.getRow(7);
- //the next formula is completely wrong (should be the same as the value in the row4 assertion above)
- assertEquals("SUBTOTAL(109,Tabelle1[Percentage])", row7.getCell(5).getCellFormula());
- }
- }
-
- private static void confirm(FormulaEvaluator fe, Cell cell, double expectedResult) {
- fe.clearAllCachedResultValues();
- CellValue cv = fe.evaluate(cell);
- assertEquals(CellType.NUMERIC, cv.getCellType(), "expected numeric cell type but got " + cv.formatAsString());
- assertEquals(expectedResult, cv.getNumberValue(), 0.0);
- }
-
- private static void confirm(FormulaEvaluator fe, Cell cell, String expectedResult) {
- fe.clearAllCachedResultValues();
- CellValue cv = fe.evaluate(cell);
- assertEquals(CellType.STRING, cv.getCellType(), "expected String cell type but got " + cv.formatAsString());
- assertEquals(expectedResult, cv.getStringValue());
- }
- }
|