1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
|
/* ====================================================================
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.assertArrayEquals;
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.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ConcurrentModificationException;
import java.util.Iterator;
import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.ss.ITestDataProvider;
import org.apache.poi.ss.usermodel.ClientAnchor.AnchorType;
import org.apache.poi.ss.util.CellAddress;
import org.apache.poi.ss.util.CellRangeAddress;
import org.apache.poi.util.NullOutputStream;
import org.junit.jupiter.api.Test;
public abstract class BaseTestWorkbook {
protected final ITestDataProvider _testDataProvider;
protected BaseTestWorkbook(ITestDataProvider testDataProvider) {
_testDataProvider = testDataProvider;
}
@Test
public void sheetIterator_forEach() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
wb.createSheet("Sheet0");
wb.createSheet("Sheet1");
wb.createSheet("Sheet2");
int i = 0;
for (Sheet sh : wb) {
assertEquals("Sheet" + i, sh.getSheetName());
i++;
}
}
}
/**
* Expected ConcurrentModificationException:
* should not be able to advance an iterator when the
* underlying data has been reordered
*/
@Test
public void sheetIterator_sheetsReordered() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
wb.createSheet("Sheet0");
wb.createSheet("Sheet1");
wb.createSheet("Sheet2");
Iterator<Sheet> it = wb.sheetIterator();
it.next();
wb.setSheetOrder("Sheet2", 1);
// Iterator order should be fixed when iterator is created
assertThrows(ConcurrentModificationException.class, it::next);
}
}
/**
* Expected ConcurrentModificationException:
* should not be able to advance an iterator when the
* underlying data has been reordered
*/
@Test
public void sheetIterator_sheetRemoved() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
wb.createSheet("Sheet0");
wb.createSheet("Sheet1");
wb.createSheet("Sheet2");
Iterator<Sheet> it = wb.sheetIterator();
wb.removeSheetAt(1);
// Iterator order should be fixed when iterator is created
assertThrows(ConcurrentModificationException.class, it::next);
}
}
/**
* Expected UnsupportedOperationException:
* should not be able to remove sheets from the sheet iterator
*/
@Test
public void sheetIterator_remove() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
wb.createSheet("Sheet0");
Iterator<Sheet> it = wb.sheetIterator();
it.next(); //Sheet0
assertThrows(UnsupportedOperationException.class, it::remove);
}
}
@Test
public void createSheet() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
assertEquals(0, wb.getNumberOfSheets());
//getting a sheet by invalid index or non-existing name
assertNull(wb.getSheet("Sheet1"));
IllegalArgumentException ex = assertThrows(
IllegalArgumentException.class,
() -> wb.getSheetAt(0),
"should have thrown exception due to invalid sheet index"
);
// expected during successful test no negative index in the range message
assertFalse(ex.getMessage().contains("-1"));
assertThrows(IllegalArgumentException.class, () -> wb.getSheetAt(0));
Sheet sheet0 = wb.createSheet();
Sheet sheet1 = wb.createSheet();
assertEquals("Sheet0", sheet0.getSheetName());
assertEquals("Sheet1", sheet1.getSheetName());
assertEquals(2, wb.getNumberOfSheets());
//fetching sheets by name is case-insensitive
Sheet originalSheet = wb.createSheet("Sheet3");
Sheet fetchedSheet = wb.getSheet("sheet3");
assertNotNull(fetchedSheet, "Identified bug 44892");
assertEquals("Sheet3", fetchedSheet.getSheetName());
assertEquals(3, wb.getNumberOfSheets());
assertSame(originalSheet, fetchedSheet);
ex = assertThrows(
IllegalArgumentException.class,
() -> wb.createSheet("sHeeT3"),
"should have thrown exception due to duplicate sheet name"
);
// expected during successful test
assertEquals("The workbook already contains a sheet named 'sHeeT3'", ex.getMessage());
//names cannot be blank or contain any of /\*?[]
String[] invalidNames = {"", "Sheet/", "Sheet\\",
"Sheet?", "Sheet*", "Sheet[", "Sheet]", "'Sheet'",
"My:Sheet"};
for (String sheetName : invalidNames) {
assertThrows(
IllegalArgumentException.class,
() -> wb.createSheet(sheetName),
"should have thrown exception due to invalid sheet name: " + sheetName
);
}
//still have 3 sheets
assertEquals(3, wb.getNumberOfSheets());
//change the name of the 3rd sheet
wb.setSheetName(2, "I changed!");
//try to assign an invalid name to the 2nd sheet
assertThrows(IllegalArgumentException.class, () -> wb.setSheetName(1, "[I'm invalid]"));
//try to assign an invalid name to the 2nd sheet
assertThrows(IllegalArgumentException.class, () -> wb.createSheet(null));
assertThrows(IllegalArgumentException.class, () -> wb.setSheetName(2, null));
//check
assertEquals(0, wb.getSheetIndex("sheet0"));
assertEquals(1, wb.getSheetIndex("sheet1"));
assertEquals(2, wb.getSheetIndex("I changed!"));
assertSame(sheet0, wb.getSheet("sheet0"));
assertSame(sheet1, wb.getSheet("sheet1"));
assertSame(originalSheet, wb.getSheet("I changed!"));
assertNull(wb.getSheet("unknown"));
//serialize and read again
try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb)) {
assertEquals(3, wb2.getNumberOfSheets());
assertEquals(0, wb2.getSheetIndex("sheet0"));
assertEquals(1, wb2.getSheetIndex("sheet1"));
assertEquals(2, wb2.getSheetIndex("I changed!"));
}
}
}
/**
* POI allows creating sheets with names longer than 31 characters.
*
* Excel opens files with long sheet names without error or warning.
* However, long sheet names are silently truncated to 31 chars. In order to
* avoid funny duplicate sheet name errors, POI enforces uniqueness on only the first 31 chars.
* but for the purpose of uniqueness long sheet names are silently truncated to 31 chars.
*/
@Test
public void createSheetWithLongNames() throws IOException {
try (Workbook wb1 = _testDataProvider.createWorkbook()) {
String sheetName1 = "My very long sheet name which is longer than 31 chars";
String truncatedSheetName1 = sheetName1.substring(0, 31);
Sheet sh1 = wb1.createSheet(sheetName1);
assertEquals(truncatedSheetName1, sh1.getSheetName());
assertSame(sh1, wb1.getSheet(truncatedSheetName1));
// now via wb.setSheetName
wb1.setSheetName(0, sheetName1);
assertEquals(truncatedSheetName1, sh1.getSheetName());
assertSame(sh1, wb1.getSheet(truncatedSheetName1));
String sheetName2 = "My very long sheet name which is longer than 31 chars " +
"and sheetName2.substring(0, 31) == sheetName1.substring(0, 31)";
IllegalArgumentException e = assertThrows(IllegalArgumentException.class, () -> wb1.createSheet(sheetName2));
assertEquals("The workbook already contains a sheet named 'My very long sheet name which is longer than 31 chars and sheetName2.substring(0, 31) == sheetName1.substring(0, 31)'", e.getMessage());
String sheetName3 = "POI allows creating sheets with names longer than 31 characters";
String truncatedSheetName3 = sheetName3.substring(0, 31);
Sheet sh3 = wb1.createSheet(sheetName3);
assertEquals(truncatedSheetName3, sh3.getSheetName());
assertSame(sh3, wb1.getSheet(truncatedSheetName3));
//serialize and read again
try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
assertEquals(2, wb2.getNumberOfSheets());
assertEquals(0, wb2.getSheetIndex(truncatedSheetName1));
assertEquals(1, wb2.getSheetIndex(truncatedSheetName3));
}
}
}
@Test
public void removeSheetAt() throws IOException {
try (Workbook workbook = _testDataProvider.createWorkbook()) {
workbook.createSheet("sheet1");
workbook.createSheet("sheet2");
workbook.createSheet("sheet3");
assertEquals(3, workbook.getNumberOfSheets());
assertEquals(0, workbook.getActiveSheetIndex());
workbook.removeSheetAt(1);
assertEquals(2, workbook.getNumberOfSheets());
assertEquals("sheet3", workbook.getSheetName(1));
assertEquals(0, workbook.getActiveSheetIndex());
workbook.removeSheetAt(0);
assertEquals(1, workbook.getNumberOfSheets());
assertEquals("sheet3", workbook.getSheetName(0));
assertEquals(0, workbook.getActiveSheetIndex());
workbook.removeSheetAt(0);
assertEquals(0, workbook.getNumberOfSheets());
assertEquals(0, workbook.getActiveSheetIndex());
//re-create the sheets
workbook.createSheet("sheet1");
workbook.createSheet("sheet2");
workbook.createSheet("sheet3");
workbook.createSheet("sheet4");
assertEquals(4, workbook.getNumberOfSheets());
assertEquals(0, workbook.getActiveSheetIndex());
workbook.setActiveSheet(2);
assertEquals(2, workbook.getActiveSheetIndex());
workbook.removeSheetAt(2);
assertEquals(2, workbook.getActiveSheetIndex());
workbook.removeSheetAt(1);
assertEquals(1, workbook.getActiveSheetIndex());
workbook.removeSheetAt(0);
assertEquals(0, workbook.getActiveSheetIndex());
workbook.removeSheetAt(0);
assertEquals(0, workbook.getActiveSheetIndex());
}
}
@Test
public void testSetActiveCell() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
Sheet sheet = wb.createSheet("new sheet");
final CellAddress initialActiveCell = sheet.getActiveCell();
assertTrue(initialActiveCell == null || new CellAddress("A1").equals(initialActiveCell));
sheet.setActiveCell(new CellAddress("E11"));
assertEquals(new CellAddress("E11"), sheet.getActiveCell());
Workbook wbr = _testDataProvider.writeOutAndReadBack(wb);
sheet = wbr.getSheet("new sheet");
assertEquals(new CellAddress("E11"), sheet.getActiveCell());
}
}
@Test
public void defaultValues() throws IOException {
try (Workbook b = _testDataProvider.createWorkbook()) {
assertEquals(0, b.getActiveSheetIndex());
assertEquals(0, b.getFirstVisibleTab());
assertEquals(0, b.getNumberOfNames());
assertEquals(0, b.getNumberOfSheets());
}
}
@Test
public void sheetSelection() throws IOException {
try (Workbook b = _testDataProvider.createWorkbook()) {
b.createSheet("Sheet One");
b.createSheet("Sheet Two");
b.setActiveSheet(1);
b.setSelectedTab(1);
b.setFirstVisibleTab(1);
assertEquals(1, b.getActiveSheetIndex());
assertEquals(1, b.getFirstVisibleTab());
}
}
@Test
public void printArea() throws IOException {
try (Workbook workbook = _testDataProvider.createWorkbook()) {
Sheet sheet1 = workbook.createSheet("Test Print Area");
String sheetName1 = sheet1.getSheetName();
// workbook.setPrintArea(0, reference);
workbook.setPrintArea(0, 1, 5, 4, 9);
String retrievedPrintArea = workbook.getPrintArea(0);
assertEquals("'" + sheetName1 + "'!$B$5:$F$10", retrievedPrintArea);
String reference = "$A$1:$B$1";
workbook.setPrintArea(0, reference);
retrievedPrintArea = workbook.getPrintArea(0);
assertEquals("'" + sheetName1 + "'!" + reference, retrievedPrintArea);
workbook.removePrintArea(0);
assertNull(workbook.getPrintArea(0));
}
}
@Test
public void getSetActiveSheet() throws IOException {
try (Workbook workbook = _testDataProvider.createWorkbook()) {
assertEquals(0, workbook.getActiveSheetIndex());
workbook.createSheet("sheet1");
workbook.createSheet("sheet2");
workbook.createSheet("sheet3");
// set second sheet
workbook.setActiveSheet(1);
// test if second sheet is set up
assertEquals(1, workbook.getActiveSheetIndex());
workbook.setActiveSheet(0);
// test if second sheet is set up
assertEquals(0, workbook.getActiveSheetIndex());
}
}
@Test
public void setSheetOrder() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
for (int i = 0; i < 10; i++) {
wb.createSheet("Sheet " + i);
}
// Check the initial order
assertEquals(0, wb.getSheetIndex("Sheet 0"));
assertEquals(1, wb.getSheetIndex("Sheet 1"));
assertEquals(2, wb.getSheetIndex("Sheet 2"));
assertEquals(3, wb.getSheetIndex("Sheet 3"));
assertEquals(4, wb.getSheetIndex("Sheet 4"));
assertEquals(5, wb.getSheetIndex("Sheet 5"));
assertEquals(6, wb.getSheetIndex("Sheet 6"));
assertEquals(7, wb.getSheetIndex("Sheet 7"));
assertEquals(8, wb.getSheetIndex("Sheet 8"));
assertEquals(9, wb.getSheetIndex("Sheet 9"));
// check active sheet
assertEquals(0, wb.getActiveSheetIndex());
// Change
wb.setSheetOrder("Sheet 6", 0);
assertEquals(1, wb.getActiveSheetIndex());
wb.setSheetOrder("Sheet 3", 7);
wb.setSheetOrder("Sheet 1", 9);
// now the first sheet is at index 1
assertEquals(1, wb.getActiveSheetIndex());
// Check they're currently right
assertEquals(0, wb.getSheetIndex("Sheet 6"));
assertEquals(1, wb.getSheetIndex("Sheet 0"));
assertEquals(2, wb.getSheetIndex("Sheet 2"));
assertEquals(3, wb.getSheetIndex("Sheet 4"));
assertEquals(4, wb.getSheetIndex("Sheet 5"));
assertEquals(5, wb.getSheetIndex("Sheet 7"));
assertEquals(6, wb.getSheetIndex("Sheet 3"));
assertEquals(7, wb.getSheetIndex("Sheet 8"));
assertEquals(8, wb.getSheetIndex("Sheet 9"));
assertEquals(9, wb.getSheetIndex("Sheet 1"));
try (Workbook wbr = _testDataProvider.writeOutAndReadBack(wb)) {
assertEquals(0, wbr.getSheetIndex("Sheet 6"));
assertEquals(1, wbr.getSheetIndex("Sheet 0"));
assertEquals(2, wbr.getSheetIndex("Sheet 2"));
assertEquals(3, wbr.getSheetIndex("Sheet 4"));
assertEquals(4, wbr.getSheetIndex("Sheet 5"));
assertEquals(5, wbr.getSheetIndex("Sheet 7"));
assertEquals(6, wbr.getSheetIndex("Sheet 3"));
assertEquals(7, wbr.getSheetIndex("Sheet 8"));
assertEquals(8, wbr.getSheetIndex("Sheet 9"));
assertEquals(9, wbr.getSheetIndex("Sheet 1"));
assertEquals(1, wb.getActiveSheetIndex());
// Now get the index by the sheet, not the name
for (int i = 0; i < 10; i++) {
Sheet s = wbr.getSheetAt(i);
assertEquals(i, wbr.getSheetIndex(s));
}
}
}
}
@Test
public void cloneSheet() throws IOException {
try (Workbook book = _testDataProvider.createWorkbook()) {
Sheet sheet = book.createSheet("TEST");
sheet.createRow(0).createCell(0).setCellValue("Test");
sheet.createRow(1).createCell(0).setCellValue(36.6);
assertEquals(0, sheet.addMergedRegion(new CellRangeAddress(0, 1, 0, 2)));
assertEquals(1, sheet.addMergedRegion(new CellRangeAddress(2, 3, 0, 2)));
assertTrue(sheet.isSelected());
Sheet clonedSheet = book.cloneSheet(0);
assertEquals("TEST (2)", clonedSheet.getSheetName());
assertEquals(2, clonedSheet.getPhysicalNumberOfRows());
assertEquals(2, clonedSheet.getNumMergedRegions());
assertFalse(clonedSheet.isSelected());
//cloned sheet is a deep copy, adding rows or merged regions in the original does not affect the clone
sheet.createRow(2).createCell(0).setCellValue(1);
assertEquals(2, sheet.addMergedRegion(new CellRangeAddress(4, 5, 0, 2)));
assertEquals(2, clonedSheet.getPhysicalNumberOfRows());
assertEquals(2, clonedSheet.getNumMergedRegions());
clonedSheet.createRow(2).createCell(0).setCellValue(1);
assertEquals(2, clonedSheet.addMergedRegion(new CellRangeAddress(6, 7, 0, 2)));
assertEquals(3, clonedSheet.getPhysicalNumberOfRows());
assertEquals(3, clonedSheet.getNumMergedRegions());
}
}
@Test
public void parentReferences() throws IOException {
try (Workbook wb1 = _testDataProvider.createWorkbook()) {
Sheet sheet = wb1.createSheet();
assertSame(wb1, sheet.getWorkbook());
Row row = sheet.createRow(0);
assertSame(sheet, row.getSheet());
Cell cell = row.createCell(1);
assertSame(sheet, cell.getSheet());
assertSame(row, cell.getRow());
try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
wb1.close();
sheet = wb2.getSheetAt(0);
assertSame(wb2, sheet.getWorkbook());
row = sheet.getRow(0);
assertSame(sheet, row.getSheet());
cell = row.getCell(1);
assertSame(sheet, cell.getSheet());
assertSame(row, cell.getRow());
}
}
}
/**
* Test to validate that replacement for removed setRepeatingRowsAnsColumns() methods
* is still working correctly
*/
@Test
public void setRepeatingRowsAnsColumns() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
CellRangeAddress cra = new CellRangeAddress(0, 3, 0, 0);
String expRows = "1:4", expCols = "A:A";
Sheet sheet1 = wb.createSheet();
sheet1.setRepeatingRows(cra);
sheet1.setRepeatingColumns(cra);
assertEquals(expRows, sheet1.getRepeatingRows().formatAsString());
assertEquals(expCols, sheet1.getRepeatingColumns().formatAsString());
//must handle sheets with quotas, see Bugzilla #47294
Sheet sheet2 = wb.createSheet("My' Sheet");
sheet2.setRepeatingRows(cra);
sheet2.setRepeatingColumns(cra);
assertEquals(expRows, sheet2.getRepeatingRows().formatAsString());
assertEquals(expCols, sheet2.getRepeatingColumns().formatAsString());
}
}
/**
* Tests that all of the unicode capable string fields can be set, written and then read back
*/
@Test
public void unicodeInAll() throws IOException {
try (Workbook wb1 = _testDataProvider.createWorkbook()) {
CreationHelper factory = wb1.getCreationHelper();
//Create a unicode dataformat (contains euro symbol)
DataFormat df = wb1.createDataFormat();
final String formatStr = "_([$\u20ac-2]\\\\\\ * #,##0.00_);_([$\u20ac-2]\\\\\\ * \\\\\\(#,##0.00\\\\\\);_([$\u20ac-2]\\\\\\ *\\\"\\-\\\\\"??_);_(@_)";
short fmt = df.getFormat(formatStr);
//Create a unicode sheet name (euro symbol)
Sheet s = wb1.createSheet("\u20ac");
//Set a unicode header (you guessed it the euro symbol)
Header h = s.getHeader();
h.setCenter("\u20ac");
h.setLeft("\u20ac");
h.setRight("\u20ac");
//Set a unicode footer
Footer f = s.getFooter();
f.setCenter("\u20ac");
f.setLeft("\u20ac");
f.setRight("\u20ac");
Row r = s.createRow(0);
Cell c = r.createCell(1);
c.setCellValue(12.34);
c.getCellStyle().setDataFormat(fmt);
/*Cell c2 =*/
r.createCell(2); // TODO - c2 unused but changing next line ('c'->'c2') causes test to fail
c.setCellValue(factory.createRichTextString("\u20ac"));
Cell c3 = r.createCell(3);
String formulaString = "TEXT(12.34,\"\u20ac###,##\")";
c3.setCellFormula(formulaString);
try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
//Test the sheetname
s = wb2.getSheet("\u20ac");
assertNotNull(s);
//Test the header
h = s.getHeader();
assertEquals(h.getCenter(), "\u20ac");
assertEquals(h.getLeft(), "\u20ac");
assertEquals(h.getRight(), "\u20ac");
//Test the footer
f = s.getFooter();
assertEquals(f.getCenter(), "\u20ac");
assertEquals(f.getLeft(), "\u20ac");
assertEquals(f.getRight(), "\u20ac");
//Test the dataformat
r = s.getRow(0);
c = r.getCell(1);
df = wb2.createDataFormat();
assertEquals(formatStr, df.getFormat(c.getCellStyle().getDataFormat()));
//Test the cell string value
/*c2 =*/
r.getCell(2);
assertEquals(c.getRichStringCellValue().getString(), "\u20ac");
//Test the cell formula
c3 = r.getCell(3);
assertEquals(c3.getCellFormula(), formulaString);
}
}
}
private Workbook newSetSheetNameTestingWorkbook() {
Workbook wb = _testDataProvider.createWorkbook();
Sheet sh1 = wb.createSheet("Worksheet");
Sheet sh2 = wb.createSheet("Testing 47100");
Sheet sh3 = wb.createSheet("To be renamed");
Name name1 = wb.createName();
name1.setNameName("sale_1");
name1.setRefersToFormula("Worksheet!$A$1");
Name name2 = wb.createName();
name2.setNameName("sale_2");
name2.setRefersToFormula("'Testing 47100'!$A$1");
Name name3 = wb.createName();
name3.setNameName("sale_3");
name3.setRefersToFormula("'Testing 47100'!$B$1");
Name name4 = wb.createName();
name4.setNameName("sale_4");
name4.setRefersToFormula("'To be renamed'!$A$3");
sh1.createRow(0).createCell(0).setCellFormula("SUM('Testing 47100'!A1:C1)");
sh1.createRow(1).createCell(0).setCellFormula("SUM('Testing 47100'!A1:C1,'To be renamed'!A1:A5)");
sh1.createRow(2).createCell(0).setCellFormula("sale_2+sale_3+'Testing 47100'!C1");
sh2.createRow(0).createCell(0).setCellValue(1);
sh2.getRow(0).createCell(1).setCellValue(2);
sh2.getRow(0).createCell(2).setCellValue(3);
sh3.createRow(0).createCell(0).setCellValue(1);
sh3.createRow(1).createCell(0).setCellValue(2);
sh3.createRow(2).createCell(0).setCellValue(3);
sh3.createRow(3).createCell(0).setCellValue(4);
sh3.createRow(4).createCell(0).setCellValue(5);
sh3.createRow(5).createCell(0).setCellFormula("sale_3");
sh3.createRow(6).createCell(0).setCellFormula("'Testing 47100'!C1");
return wb;
}
/**
* Ensure that Workbook#setSheetName updates all dependent formulas and named ranges
*
* @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=47100">Bugzilla 47100</a>
*/
@Test
public void setSheetName() throws IOException {
try (Workbook wb1 = newSetSheetNameTestingWorkbook()) {
Sheet sh1 = wb1.getSheetAt(0);
Name sale_2 = wb1.getName("sale_2");
Name sale_3 = wb1.getName("sale_3");
Name sale_4 = wb1.getName("sale_4");
assertEquals("sale_2", sale_2.getNameName());
assertEquals("'Testing 47100'!$A$1", sale_2.getRefersToFormula());
assertEquals("sale_3", sale_3.getNameName());
assertEquals("'Testing 47100'!$B$1", sale_3.getRefersToFormula());
assertEquals("sale_4", sale_4.getNameName());
assertEquals("'To be renamed'!$A$3", sale_4.getRefersToFormula());
FormulaEvaluator evaluator = wb1.getCreationHelper().createFormulaEvaluator();
Cell cell0 = sh1.getRow(0).getCell(0);
Cell cell1 = sh1.getRow(1).getCell(0);
Cell cell2 = sh1.getRow(2).getCell(0);
assertEquals("SUM('Testing 47100'!A1:C1)", cell0.getCellFormula());
assertEquals("SUM('Testing 47100'!A1:C1,'To be renamed'!A1:A5)", cell1.getCellFormula());
assertEquals("sale_2+sale_3+'Testing 47100'!C1", cell2.getCellFormula());
assertEquals(6.0, evaluator.evaluate(cell0).getNumberValue(), 0);
assertEquals(21.0, evaluator.evaluate(cell1).getNumberValue(), 0);
assertEquals(6.0, evaluator.evaluate(cell2).getNumberValue(), 0);
wb1.setSheetName(1, "47100 - First");
wb1.setSheetName(2, "47100 - Second");
assertEquals("sale_2", sale_2.getNameName());
assertEquals("'47100 - First'!$A$1", sale_2.getRefersToFormula());
assertEquals("sale_3", sale_3.getNameName());
assertEquals("'47100 - First'!$B$1", sale_3.getRefersToFormula());
assertEquals("sale_4", sale_4.getNameName());
assertEquals("'47100 - Second'!$A$3", sale_4.getRefersToFormula());
assertEquals("SUM('47100 - First'!A1:C1)", cell0.getCellFormula());
assertEquals("SUM('47100 - First'!A1:C1,'47100 - Second'!A1:A5)", cell1.getCellFormula());
assertEquals("sale_2+sale_3+'47100 - First'!C1", cell2.getCellFormula());
evaluator.clearAllCachedResultValues();
assertEquals(6.0, evaluator.evaluate(cell0).getNumberValue(), 0);
assertEquals(21.0, evaluator.evaluate(cell1).getNumberValue(), 0);
assertEquals(6.0, evaluator.evaluate(cell2).getNumberValue(), 0);
try (Workbook wb2 = _testDataProvider.writeOutAndReadBack(wb1)) {
sh1 = wb2.getSheetAt(0);
sale_2 = wb2.getName("sale_2");
sale_3 = wb2.getName("sale_3");
sale_4 = wb2.getName("sale_4");
cell0 = sh1.getRow(0).getCell(0);
cell1 = sh1.getRow(1).getCell(0);
cell2 = sh1.getRow(2).getCell(0);
assertEquals("sale_2", sale_2.getNameName());
assertEquals("'47100 - First'!$A$1", sale_2.getRefersToFormula());
assertEquals("sale_3", sale_3.getNameName());
assertEquals("'47100 - First'!$B$1", sale_3.getRefersToFormula());
assertEquals("sale_4", sale_4.getNameName());
assertEquals("'47100 - Second'!$A$3", sale_4.getRefersToFormula());
assertEquals("SUM('47100 - First'!A1:C1)", cell0.getCellFormula());
assertEquals("SUM('47100 - First'!A1:C1,'47100 - Second'!A1:A5)", cell1.getCellFormula());
assertEquals("sale_2+sale_3+'47100 - First'!C1", cell2.getCellFormula());
evaluator = wb2.getCreationHelper().createFormulaEvaluator();
assertEquals(6.0, evaluator.evaluate(cell0).getNumberValue(), 0);
assertEquals(21.0, evaluator.evaluate(cell1).getNumberValue(), 0);
assertEquals(6.0, evaluator.evaluate(cell2).getNumberValue(), 0);
}
}
}
protected void changeSheetNameWithSharedFormulas(String sampleFile) throws IOException {
try (Workbook wb = _testDataProvider.openSampleWorkbook(sampleFile)) {
FormulaEvaluator evaluator = wb.getCreationHelper().createFormulaEvaluator();
Sheet sheet = wb.getSheetAt(0);
for (int rownum = 1; rownum <= 40; rownum++) {
Cell cellA = sheet.getRow(1).getCell(0);
Cell cellB = sheet.getRow(1).getCell(1);
assertEquals(cellB.getStringCellValue(), evaluator.evaluate(cellA).getStringValue());
}
wb.setSheetName(0, "Renamed by POI");
evaluator.clearAllCachedResultValues();
for (int rownum = 1; rownum <= 40; rownum++) {
Cell cellA = sheet.getRow(1).getCell(0);
Cell cellB = sheet.getRow(1).getCell(1);
assertEquals(cellB.getStringCellValue(), evaluator.evaluate(cellA).getStringValue());
}
}
}
protected void assertSheetOrder(Workbook wb, String... sheets) {
StringBuilder sheetNames = new StringBuilder();
for(int i = 0;i < wb.getNumberOfSheets();i++) {
sheetNames.append(wb.getSheetAt(i).getSheetName()).append(",");
}
assertEquals(sheets.length, wb.getNumberOfSheets(), "Had: " + sheetNames);
for(int i = 0;i < wb.getNumberOfSheets();i++) {
assertEquals(sheets[i], wb.getSheetAt(i).getSheetName(), "Had: " + sheetNames);
}
}
@Test
public void test58499() throws IOException {
try (Workbook workbook = _testDataProvider.createWorkbook();
OutputStream os = new NullOutputStream()) {
Sheet sheet = workbook.createSheet();
for (int i = 0; i < 900; i++) {
Row r = sheet.createRow(i);
Cell c = r.createCell(0);
CellStyle cs = workbook.createCellStyle();
c.setCellStyle(cs);
c.setCellValue("AAA");
}
workbook.write(os);
}
}
@Test
public void windowOneDefaults() throws IOException {
try (Workbook b = _testDataProvider.createWorkbook()) {
assertEquals(b.getActiveSheetIndex(), 0);
assertEquals(b.getFirstVisibleTab(), 0);
// throws NullPointerException when WindowOneRecord in Workbook is not probably initialized
}
}
@Test
public void getSpreadsheetVersion() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
assertEquals(_testDataProvider.getSpreadsheetVersion(), wb.getSpreadsheetVersion());
}
}
/* FIXME copied from {@link org.apache.poi.ss.TestWorkbookFactory} */
protected static void assertCloseDoesNotModifyFile(String filename, Workbook wb) throws IOException {
final byte[] before = HSSFTestDataSamples.getTestDataFileContent(filename);
wb.close();
final byte[] after = HSSFTestDataSamples.getTestDataFileContent(filename);
assertArrayEquals(before, after, filename + " sample file was modified as a result of closing the workbook");
}
@Test
public void sheetClone() throws IOException {
// First up, try a simple file
try (Workbook b = _testDataProvider.createWorkbook();
Workbook bBack = HSSFTestDataSamples.openSampleWorkbook("SheetWithDrawing.xls")) {
assertEquals(0, b.getNumberOfSheets());
b.createSheet("Sheet One");
b.createSheet("Sheet Two");
assertEquals(2, b.getNumberOfSheets());
b.cloneSheet(0);
assertEquals(3, b.getNumberOfSheets());
// Now try a problem one with drawing records in it
assertEquals(1, bBack.getNumberOfSheets());
bBack.cloneSheet(0);
assertEquals(2, bBack.getNumberOfSheets());
}
}
@Test
public void getSheetIndex() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
Sheet sheet1 = wb.createSheet("Sheet1");
Sheet sheet2 = wb.createSheet("Sheet2");
Sheet sheet3 = wb.createSheet("Sheet3");
Sheet sheet4 = wb.createSheet("Sheet4");
assertEquals(0, wb.getSheetIndex(sheet1));
assertEquals(1, wb.getSheetIndex(sheet2));
assertEquals(2, wb.getSheetIndex(sheet3));
assertEquals(3, wb.getSheetIndex(sheet4));
// remove sheets
wb.removeSheetAt(0);
wb.removeSheetAt(2);
// ensure that sheets are moved up and removed sheets are not found any more
assertEquals(-1, wb.getSheetIndex(sheet1));
assertEquals(0, wb.getSheetIndex(sheet2));
assertEquals(1, wb.getSheetIndex(sheet3));
assertEquals(-1, wb.getSheetIndex(sheet4));
}
}
@Test
public void addSheetTwice() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
Sheet sheet1 = wb.createSheet("Sheet1");
assertNotNull(sheet1);
IllegalArgumentException ex = assertThrows(
IllegalArgumentException.class,
() -> wb.createSheet("Sheet1")
);
assertEquals("The workbook already contains a sheet named 'Sheet1'", ex.getMessage());
}
}
// bug 51233 and 55075: correctly size image if added to a row with a custom height
@Test
public void createDrawing() throws Exception {
try (Workbook wb = _testDataProvider.createWorkbook()) {
Sheet sheet = wb.createSheet("Main Sheet");
Row row0 = sheet.createRow(0);
Row row1 = sheet.createRow(1);
row1.createCell(0);
row0.createCell(1);
row1.createCell(0);
row1.createCell(1);
byte[] pictureData = _testDataProvider.getTestDataFileContent("logoKarmokar4.png");
int handle = wb.addPicture(pictureData, Workbook.PICTURE_TYPE_PNG);
Drawing<?> drawing = sheet.createDrawingPatriarch();
CreationHelper helper = wb.getCreationHelper();
ClientAnchor anchor = helper.createClientAnchor();
anchor.setAnchorType(AnchorType.DONT_MOVE_AND_RESIZE);
anchor.setCol1(0);
anchor.setRow1(0);
Picture picture = drawing.createPicture(anchor, handle);
row0.setHeightInPoints(144);
// set a column width so that XSSF and SXSSF have the same width (default widths may be different otherwise)
sheet.setColumnWidth(0, 100 * 256);
picture.resize();
// The actual dimensions don't matter as much as having XSSF and SXSSF produce the same size drawings
// Check drawing height
assertEquals(0, anchor.getRow1());
assertEquals(0, anchor.getRow2());
assertEquals(0, anchor.getDy1());
assertEquals(1609725, anchor.getDy2()); //HSSF: 225
// Check drawing width
assertEquals(0, anchor.getCol1());
assertEquals(0, anchor.getCol2());
assertEquals(0, anchor.getDx1());
assertEquals(1114425, anchor.getDx2()); //HSSF: 171
}
}
}
|