mirror of
https://github.com/apache/poi.git
synced 2026-02-27 20:40:08 +08:00
a4ed4359cc
JUnit5 test classes and methods should have default package visibility git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1885308 13f79535-47bb-0310-9956-ffa450edef68
402 lines
16 KiB
Java
402 lines
16 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.usermodel;
|
|
|
|
import static org.junit.jupiter.api.Assertions.assertEquals;
|
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
|
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
|
import static org.junit.jupiter.api.Assertions.assertThrows;
|
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
|
|
|
import java.io.IOException;
|
|
|
|
import org.apache.poi.common.usermodel.HyperlinkType;
|
|
import org.apache.poi.ss.ITestDataProvider;
|
|
import org.apache.poi.ss.util.CellAddress;
|
|
import org.apache.poi.ss.util.CellRangeAddress;
|
|
import org.apache.poi.ss.util.CellUtil;
|
|
import org.junit.jupiter.api.BeforeEach;
|
|
import org.junit.jupiter.api.Test;
|
|
|
|
public abstract class BaseTestSheetShiftColumns {
|
|
protected Sheet sheet1;
|
|
protected Sheet sheet2;
|
|
protected Workbook workbook;
|
|
|
|
protected ITestDataProvider _testDataProvider;
|
|
|
|
@BeforeEach
|
|
void init() {
|
|
int rowIndex = 0;
|
|
sheet1 = workbook.createSheet("sheet1");
|
|
Row row = sheet1.createRow(rowIndex++);
|
|
row.createCell(0, CellType.NUMERIC).setCellValue(0);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(1);
|
|
row.createCell(2, CellType.NUMERIC).setCellValue(2);
|
|
|
|
row = sheet1.createRow(rowIndex++);
|
|
row.createCell(0, CellType.NUMERIC).setCellValue(0.1);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(1.1);
|
|
row.createCell(2, CellType.NUMERIC).setCellValue(2.1);
|
|
row = sheet1.createRow(rowIndex++);
|
|
row.createCell(0, CellType.NUMERIC).setCellValue(0.2);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(1.2);
|
|
row.createCell(2, CellType.NUMERIC).setCellValue(2.2);
|
|
row = sheet1.createRow(rowIndex++);
|
|
row.createCell(0, CellType.FORMULA).setCellFormula("A2*B3");
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(1.3);
|
|
row.createCell(2, CellType.FORMULA).setCellFormula("B1-B3");
|
|
row = sheet1.createRow(rowIndex++);
|
|
row.createCell(0, CellType.FORMULA).setCellFormula("SUM(C1:C4)");
|
|
row.createCell(1, CellType.FORMULA).setCellFormula("SUM(A3:C3)");
|
|
row.createCell(2, CellType.FORMULA).setCellFormula("$C1+C$2");
|
|
row = sheet1.createRow(rowIndex++);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(1.5);
|
|
row = sheet1.createRow(rowIndex);
|
|
row.createCell(1, CellType.BOOLEAN).setCellValue(false);
|
|
Cell textCell = row.createCell(2, CellType.STRING);
|
|
textCell.setCellValue("TEXT");
|
|
textCell.setCellStyle(newCenterBottomStyle());
|
|
|
|
sheet2 = workbook.createSheet("sheet2");
|
|
row = sheet2.createRow(0); row.createCell(0, CellType.NUMERIC).setCellValue(10);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(11);
|
|
row.createCell(2, CellType.FORMULA).setCellFormula("SUM(sheet1!B3:C3)");
|
|
row = sheet2.createRow(1);
|
|
row.createCell(0, CellType.NUMERIC).setCellValue(21);
|
|
row.createCell(1, CellType.NUMERIC).setCellValue(22);
|
|
row.createCell(2, CellType.NUMERIC).setCellValue(23);
|
|
row = sheet2.createRow(2);
|
|
row.createCell(0, CellType.FORMULA).setCellFormula("sheet1!A4+sheet1!C2+A2");
|
|
row.createCell(1, CellType.FORMULA).setCellFormula("SUM(sheet1!A3:$C3)");
|
|
row = sheet2.createRow(3);
|
|
row.createCell(0, CellType.STRING).setCellValue("dummy");
|
|
}
|
|
|
|
private CellStyle newCenterBottomStyle() {
|
|
CellStyle style = workbook.createCellStyle();
|
|
style.setAlignment(HorizontalAlignment.CENTER);
|
|
style.setVerticalAlignment(VerticalAlignment.BOTTOM);
|
|
return style;
|
|
}
|
|
|
|
@Test
|
|
void testShiftOneColumnRight() {
|
|
sheet1.shiftColumns(1, 2, 1);
|
|
double c1Value = sheet1.getRow(0).getCell(2).getNumericCellValue();
|
|
assertEquals(1d, c1Value, 0.01);
|
|
String formulaA4 = sheet1.getRow(3).getCell(0).getCellFormula();
|
|
assertEquals("A2*C3", formulaA4);
|
|
String formulaC4 = sheet1.getRow(3).getCell(3).getCellFormula();
|
|
assertEquals("C1-C3", formulaC4);
|
|
String formulaB5 = sheet1.getRow(4).getCell(2).getCellFormula();
|
|
assertEquals("SUM(A3:D3)", formulaB5);
|
|
String formulaD5 = sheet1.getRow(4).getCell(3).getCellFormula(); // $C1+C$2
|
|
assertEquals("$D1+D$2", formulaD5);
|
|
|
|
Cell newb5Null = sheet1.getRow(4).getCell(1);
|
|
assertNull(newb5Null);
|
|
boolean logicalValue = sheet1.getRow(6).getCell(2).getBooleanCellValue();
|
|
assertFalse(logicalValue);
|
|
Cell textCell = sheet1.getRow(6).getCell(3);
|
|
assertEquals(textCell.getStringCellValue(), "TEXT");
|
|
assertEquals(textCell.getCellStyle().getAlignment(), HorizontalAlignment.CENTER);
|
|
|
|
// other sheet
|
|
String formulaC1 = sheet2.getRow(0).getCell(2).getCellFormula(); // SUM(sheet1!B3:C3)
|
|
assertEquals("SUM(sheet1!C3:D3)", formulaC1);
|
|
String formulaA3 = sheet2.getRow(2).getCell(0).getCellFormula(); // sheet1!A4+sheet1!C2+A2
|
|
assertEquals("sheet1!A4+sheet1!D2+A2", formulaA3);
|
|
}
|
|
|
|
@Test
|
|
void testShiftTwoColumnsRight() {
|
|
sheet1.shiftColumns(1, 2, 2);
|
|
String formulaA4 = sheet1.getRow(3).getCell(0).getCellFormula();
|
|
assertEquals("A2*D3", formulaA4);
|
|
String formulaD4 = sheet1.getRow(3).getCell(4).getCellFormula();
|
|
assertEquals("D1-D3", formulaD4);
|
|
String formulaD5 = sheet1.getRow(4).getCell(3).getCellFormula();
|
|
assertEquals("SUM(A3:E3)", formulaD5);
|
|
|
|
Cell b5Null = sheet1.getRow(4).getCell(1);
|
|
assertNull(b5Null);
|
|
Object c6Null = sheet1.getRow(5).getCell(2); // null cell A5 is shifted
|
|
// for 2 columns, so now
|
|
// c5 should be null
|
|
assertNull(c6Null);
|
|
}
|
|
|
|
@Test
|
|
void testShiftOneColumnLeft() {
|
|
sheet1.shiftColumns(1, 2, -1);
|
|
|
|
String formulaA5 = sheet1.getRow(4).getCell(0).getCellFormula();
|
|
assertEquals("SUM(A3:B3)", formulaA5);
|
|
String formulaB4 = sheet1.getRow(3).getCell(1).getCellFormula();
|
|
assertEquals("A1-A3", formulaB4);
|
|
String formulaB5 = sheet1.getRow(4).getCell(1).getCellFormula();
|
|
assertEquals("$B1+B$2", formulaB5);
|
|
Cell newb6Null = sheet1.getRow(5).getCell(1);
|
|
assertNull(newb6Null);
|
|
}
|
|
|
|
@Test
|
|
void testShiftTwoColumnsLeft() {
|
|
assertThrows(IllegalStateException.class, () -> sheet1.shiftColumns(1, 2, -2));
|
|
}
|
|
|
|
@Test
|
|
protected void testShiftHyperlinks() throws IOException {
|
|
Workbook wb = _testDataProvider.createWorkbook();
|
|
Sheet sheet = wb.createSheet("test");
|
|
Row row = sheet.createRow(0);
|
|
|
|
// How to create hyperlinks
|
|
// https://poi.apache.org/spreadsheet/quick-guide.html#Hyperlinks
|
|
CreationHelper helper = wb.getCreationHelper();
|
|
CellStyle hlinkStyle = wb.createCellStyle();
|
|
Font hlinkFont = wb.createFont();
|
|
hlinkFont.setUnderline(Font.U_SINGLE);
|
|
hlinkFont.setColor(IndexedColors.BLUE.getIndex());
|
|
hlinkStyle.setFont(hlinkFont);
|
|
|
|
// 3D relative document link
|
|
// CellAddress=A1, shifted to A4
|
|
Cell cell = row.createCell(0);
|
|
cell.setCellStyle(hlinkStyle);
|
|
createHyperlink(helper, cell, HyperlinkType.DOCUMENT, "test!E1");
|
|
|
|
// URL
|
|
cell = row.createCell(1);
|
|
// CellAddress=B1, shifted to B4
|
|
cell.setCellStyle(hlinkStyle);
|
|
createHyperlink(helper, cell, HyperlinkType.URL, "https://poi.apache.org/");
|
|
|
|
// row0 will be shifted on top of row1, so this URL should be removed
|
|
// from the workbook
|
|
Row overwrittenRow = sheet.createRow(3);
|
|
cell = overwrittenRow.createCell(2);
|
|
// CellAddress=C4, will be overwritten (deleted)
|
|
cell.setCellStyle(hlinkStyle);
|
|
createHyperlink(helper, cell, HyperlinkType.EMAIL, "mailto:poi@apache.org");
|
|
|
|
Row unaffectedRow = sheet.createRow(20);
|
|
cell = unaffectedRow.createCell(3);
|
|
// CellAddress=D21, will be unaffected
|
|
cell.setCellStyle(hlinkStyle);
|
|
createHyperlink(helper, cell, HyperlinkType.FILE, "54524.xlsx");
|
|
|
|
cell = wb.createSheet("other").createRow(0).createCell(0);
|
|
// CellAddress=Other!A1, will be unaffected
|
|
cell.setCellStyle(hlinkStyle);
|
|
createHyperlink(helper, cell, HyperlinkType.URL, "http://apache.org/");
|
|
|
|
int startRow = 0;
|
|
int endRow = 4;
|
|
int n = 3;
|
|
sheet.shiftColumns(startRow, endRow, n);
|
|
|
|
Workbook read = _testDataProvider.writeOutAndReadBack(wb);
|
|
wb.close();
|
|
|
|
Sheet sh = read.getSheet("test");
|
|
|
|
Row shiftedRow = sh.getRow(0);
|
|
|
|
// document link anchored on a shifted cell should be moved
|
|
// Note that hyperlinks do not track what they point to, so this
|
|
// hyperlink should still refer to test!E1
|
|
verifyHyperlink(shiftedRow.getCell(3), HyperlinkType.DOCUMENT, "test!E1");
|
|
|
|
// URL, EMAIL, and FILE links anchored on a shifted cell should be moved
|
|
verifyHyperlink(shiftedRow.getCell(4), HyperlinkType.URL, "https://poi.apache.org/");
|
|
|
|
// Make sure hyperlinks were moved and not copied
|
|
assertNull(sh.getHyperlink(0, 0), "Document hyperlink should be moved, not copied");
|
|
assertNull(sh.getHyperlink(1, 0), "URL hyperlink should be moved, not copied");
|
|
|
|
assertEquals(4, sh.getHyperlinkList().size());
|
|
read.close();
|
|
}
|
|
|
|
private void createHyperlink(CreationHelper helper, Cell cell, HyperlinkType linkType, String ref) {
|
|
cell.setCellValue(ref);
|
|
Hyperlink link = helper.createHyperlink(linkType);
|
|
link.setAddress(ref);
|
|
cell.setHyperlink(link);
|
|
}
|
|
|
|
private void verifyHyperlink(Cell cell, HyperlinkType linkType, String ref) {
|
|
assertTrue(cellHasHyperlink(cell));
|
|
assertNotNull(cell);
|
|
Hyperlink link = cell.getHyperlink();
|
|
assertEquals(linkType, link.getType());
|
|
assertEquals(ref, link.getAddress());
|
|
}
|
|
|
|
private boolean cellHasHyperlink(Cell cell) {
|
|
return (cell != null) && (cell.getHyperlink() != null);
|
|
}
|
|
|
|
@Test
|
|
protected void shiftMergedColumnsToMergedColumnsRight() throws IOException {
|
|
Workbook wb = _testDataProvider.createWorkbook();
|
|
Sheet sheet = wb.createSheet("test");
|
|
|
|
// populate sheet cells
|
|
populateSheetCells(sheet);
|
|
CellRangeAddress A1_A5 = new CellRangeAddress(0, 4, 0, 0); // NOSONAR, it's more readable this way
|
|
CellRangeAddress B1_B3 = new CellRangeAddress(0, 2, 1, 1); // NOSONAR, it's more readable this way
|
|
|
|
assertEquals(0, sheet.addMergedRegion(B1_B3));
|
|
assertEquals(1, sheet.addMergedRegion(A1_A5));
|
|
|
|
// A1:A5 should be moved to B1:B5
|
|
// B1:B3 will be removed
|
|
sheet.shiftColumns(0, 0, 1);
|
|
assertEquals(1, sheet.getNumMergedRegions());
|
|
assertEquals(CellRangeAddress.valueOf("B1:B5"), sheet.getMergedRegion(0));
|
|
|
|
wb.close();
|
|
}
|
|
|
|
@Test
|
|
protected void shiftMergedColumnsToMergedColumnsLeft() throws IOException {
|
|
Workbook wb = _testDataProvider.createWorkbook();
|
|
Sheet sheet = wb.createSheet("test");
|
|
populateSheetCells(sheet);
|
|
|
|
CellRangeAddress A1_A5 = new CellRangeAddress(0, 4, 0, 0); // NOSONAR, it's more readable this way
|
|
CellRangeAddress B1_B3 = new CellRangeAddress(0, 2, 1, 1); // NOSONAR, it's more readable this way
|
|
|
|
assertEquals(0, sheet.addMergedRegion(A1_A5));
|
|
assertEquals(1, sheet.addMergedRegion(B1_B3));
|
|
|
|
// A1:E1 should be removed
|
|
// B1:B3 will be A1:A3
|
|
sheet.shiftColumns(1, 5, -1);
|
|
|
|
assertEquals(1, sheet.getNumMergedRegions());
|
|
assertEquals(CellRangeAddress.valueOf("A1:A3"), sheet.getMergedRegion(0));
|
|
|
|
wb.close();
|
|
}
|
|
|
|
private void populateSheetCells(Sheet sheet) {
|
|
// populate sheet cells
|
|
for (int i = 0; i < 2; i++) {
|
|
Row row = sheet.createRow(i);
|
|
for (int j = 0; j < 5; j++) {
|
|
Cell cell = row.createCell(j);
|
|
cell.setCellValue(i + "x" + j);
|
|
}
|
|
}
|
|
}
|
|
|
|
@Test
|
|
protected void testShiftWithMergedRegions() throws IOException {
|
|
Workbook wb = _testDataProvider.createWorkbook();
|
|
Sheet sheet = wb.createSheet();
|
|
Row row = sheet.createRow(0);
|
|
row.createCell(0).setCellValue(1.1);
|
|
row = sheet.createRow(1);
|
|
row.createCell(0).setCellValue(2.2);
|
|
CellRangeAddress region = new CellRangeAddress(0, 2, 0, 0);
|
|
assertEquals("A1:A3", region.formatAsString());
|
|
|
|
assertEquals(0, sheet.addMergedRegion(region));
|
|
|
|
sheet.shiftColumns(0, 1, 2);
|
|
region = sheet.getMergedRegion(0);
|
|
assertEquals("C1:C3", region.formatAsString());
|
|
wb.close();
|
|
}
|
|
|
|
protected abstract Workbook openWorkbook(String spreadsheetFileName) throws IOException;
|
|
protected abstract Workbook getReadBackWorkbook(Workbook wb) throws IOException;
|
|
|
|
protected static final String AMDOCS = "Amdocs";
|
|
protected static final String AMDOCS_TEST = "Amdocs:\ntest\n";
|
|
|
|
@Test
|
|
protected void testCommentsShifting() throws IOException {
|
|
Workbook inputWb = openWorkbook("56017.xlsx");
|
|
|
|
Sheet sheet = inputWb.getSheetAt(0);
|
|
Comment comment = sheet.getCellComment(new CellAddress(0, 0));
|
|
assertNotNull(comment);
|
|
assertEquals(AMDOCS, comment.getAuthor());
|
|
assertEquals(AMDOCS_TEST, comment.getString().getString());
|
|
|
|
sheet.shiftColumns(0, 1, 1);
|
|
|
|
// comment in column 0 is gone
|
|
comment = sheet.getCellComment(new CellAddress(0, 0));
|
|
assertNull(comment);
|
|
|
|
// comment is column in column 1
|
|
comment = sheet.getCellComment(new CellAddress(0, 1));
|
|
assertNotNull(comment);
|
|
assertEquals(AMDOCS, comment.getAuthor());
|
|
assertEquals(AMDOCS_TEST, comment.getString().getString());
|
|
|
|
Workbook wbBack = getReadBackWorkbook(inputWb);
|
|
inputWb.close();
|
|
assertNotNull(wbBack);
|
|
|
|
Sheet sheetBack = wbBack.getSheetAt(0);
|
|
|
|
// comment in column 0 is gone
|
|
comment = sheetBack.getCellComment(new CellAddress(0, 0));
|
|
assertNull(comment);
|
|
|
|
// comment is now in column 1
|
|
comment = sheetBack.getCellComment(new CellAddress(0, 1));
|
|
assertNotNull(comment);
|
|
assertEquals(AMDOCS, comment.getAuthor());
|
|
assertEquals(AMDOCS_TEST, comment.getString().getString());
|
|
wbBack.close();
|
|
}
|
|
|
|
// transposed version of TestXSSFSheetShiftRows.testBug54524()
|
|
@Test
|
|
protected void testBug54524() throws IOException {
|
|
Workbook wb = _testDataProvider.createWorkbook();
|
|
Sheet sheet = wb.createSheet();
|
|
Row firstRow = sheet.createRow(0);
|
|
firstRow.createCell(0).setCellValue("");
|
|
firstRow.createCell(1).setCellValue(1);
|
|
firstRow.createCell(2).setCellValue(2);
|
|
firstRow.createCell(3).setCellFormula("SUM(B1:C1)");
|
|
firstRow.createCell(4).setCellValue("X");
|
|
|
|
sheet.shiftColumns(3, 5, -1);
|
|
|
|
Cell cell = CellUtil.getCell(sheet.getRow(0), 1);
|
|
assertEquals(1.0, cell.getNumericCellValue(), 0);
|
|
cell = CellUtil.getCell(sheet.getRow(0), 2);
|
|
assertEquals("SUM(B1:B1)", cell.getCellFormula());
|
|
cell = CellUtil.getCell(sheet.getRow(0), 3);
|
|
assertEquals("X", cell.getStringCellValue());
|
|
wb.close();
|
|
}
|
|
}
|