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
|
/* ====================================================================
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.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.IOException;
import org.apache.poi.ss.ITestDataProvider;
import org.junit.jupiter.api.Test;
/**
* Tests of implementation of {@link DataFormat}
*
*/
public abstract class BaseTestDataFormat {
protected static final String POUND_FMT = "\"\u00a3\"#,##0;[Red]\\-\"\u00a3\"#,##0";
private final ITestDataProvider _testDataProvider;
protected BaseTestDataFormat(ITestDataProvider testDataProvider) {
_testDataProvider = testDataProvider;
}
public void assertNotBuiltInFormat(String customFmt) {
//check it is not in built-in formats
assertEquals(-1, BuiltinFormats.getBuiltinFormat(customFmt));
}
@Test
public final void testBuiltinFormats() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
DataFormat df = wb.createDataFormat();
String[] formats = BuiltinFormats.getAll();
for (int idx = 0; idx < formats.length; idx++) {
String fmt = formats[idx];
assertEquals(idx, df.getFormat(fmt));
}
//default format for new cells is General
Sheet sheet = wb.createSheet();
Cell cell = sheet.createRow(0).createCell(0);
assertEquals(0, cell.getCellStyle().getDataFormat());
assertEquals("General", cell.getCellStyle().getDataFormatString());
//create a custom data format
String customFmt = "#0.00 AM/PM";
//check it is not in built-in formats
assertNotBuiltInFormat(customFmt);
int customIdx = df.getFormat(customFmt);
//The first user-defined format starts at 164.
assertTrue(customIdx >= BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX);
//read and verify the string representation
assertEquals(customFmt, df.getFormat((short) customIdx));
}
}
/**
* [Bug 49928] formatCellValue returns incorrect value for \u00a3 formatted cells
*/
@Test
public void test49928() throws IOException {
String fileName = "49928.xls" + (getClass().getName().contains("xssf") ? "x" : "");
try (Workbook wb = _testDataProvider.openSampleWorkbook(fileName)) {
DataFormatter df = new DataFormatter();
Sheet sheet = wb.getSheetAt(0);
Cell cell = sheet.getRow(0).getCell(0);
CellStyle style = cell.getCellStyle();
// not expected normally, id of a custom format should be greater
// than BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX
short poundFmtIdx = 6;
assertEquals(POUND_FMT, style.getDataFormatString());
assertEquals(poundFmtIdx, style.getDataFormat());
assertEquals("\u00a31", df.formatCellValue(cell));
DataFormat dataFormat = wb.createDataFormat();
assertEquals(poundFmtIdx, dataFormat.getFormat(POUND_FMT));
assertEquals(POUND_FMT, dataFormat.getFormat(poundFmtIdx));
// As of 2015-12-27, there is no way to override a built-in number format with POI XSSFWorkbook
// 49928.xlsx has been saved with a poundFmt that overrides the default value (dollar)
poundFmtIdx = wb.getSheetAt(0).getRow(0).getCell(0).getCellStyle().getDataFormat();
assertEquals(poundFmtIdx, dataFormat.getFormat(POUND_FMT));
// now create a custom format with Pound (\u00a3)
String customFmt = "\u00a3##.00[Yellow]";
assertNotBuiltInFormat(customFmt);
short customFmtIdx = dataFormat.getFormat(customFmt);
assertTrue(customFmtIdx >= BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX);
assertEquals(customFmt, dataFormat.getFormat(customFmtIdx));
}
}
@Test
public void testReadbackFormat() throws IOException {
readbackFormat("built-in format", "0.00");
readbackFormat("overridden built-in format", POUND_FMT);
String customFormat = "#0.00 AM/PM";
assertNotBuiltInFormat(customFormat);
readbackFormat("custom format", customFormat);
}
private void readbackFormat(String msg, String fmt) throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
DataFormat dataFormat = wb.createDataFormat();
short fmtIdx = dataFormat.getFormat(fmt);
String readbackFmt = dataFormat.getFormat(fmtIdx);
assertEquals(fmt, readbackFmt, msg);
}
}
/**
* [Bug 58532] Handle formats that go numnum, numK, numM etc
*/
@Test
public void test58532() throws IOException {
String fileName = "FormatKM.xls" + (getClass().getName().contains("xssf") ? "x" : "");
try (Workbook wb = _testDataProvider.openSampleWorkbook(fileName)) {
Sheet s = wb.getSheetAt(0);
DataFormatter fmt = new DataFormatter();
FormulaEvaluator eval = wb.getCreationHelper().createFormulaEvaluator();
// Column A is the raw values
// Column B is the ##/#K/#M values
// Column C is strings of what they should look like
// Column D is the #.##/#.#K/#.#M values
// Column E is strings of what they should look like
String formatKMWhole = "[>999999]#,,\"M\";[>999]#,\"K\";#";
String formatKM3dp = "[>999999]#.000,,\"M\";[>999]#.000,\"K\";#.000";
// Check the formats are as expected
Row headers = s.getRow(0);
assertNotNull(headers);
assertEquals(formatKMWhole, headers.getCell(1).getStringCellValue());
assertEquals(formatKM3dp, headers.getCell(3).getStringCellValue());
Row r2 = s.getRow(1);
assertNotNull(r2);
assertEquals(formatKMWhole, r2.getCell(1).getCellStyle().getDataFormatString());
assertEquals(formatKM3dp, r2.getCell(3).getCellStyle().getDataFormatString());
// For all of the contents rows, check that DataFormatter is able
// to format the cells to the same value as the one next to it
for (int rn = 1; rn < s.getLastRowNum(); rn++) {
Row r = s.getRow(rn);
if (r == null) break;
double value = r.getCell(0).getNumericCellValue();
String expWhole = r.getCell(2).getStringCellValue();
String exp3dp = r.getCell(4).getStringCellValue();
assertEquals(expWhole, fmt.formatCellValue(r.getCell(1), eval),
"Wrong formatting of " + value + " for row " + rn);
assertEquals(exp3dp, fmt.formatCellValue(r.getCell(3), eval),
"Wrong formatting of " + value + " for row " + rn);
}
}
}
/**
* Localized accountancy formats
*/
@Test
public final void test58536() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
DataFormatter formatter = new DataFormatter();
DataFormat fmt = wb.createDataFormat();
Sheet sheet = wb.createSheet();
Row r = sheet.createRow(0);
char pound = '\u00A3';
String formatUK = "_-[$" + pound + "-809]* #,##0_-;\\-[$" + pound + "-809]* #,##0_-;_-[$" + pound + "-809]* \"-\"??_-;_-@_-";
CellStyle cs = wb.createCellStyle();
cs.setDataFormat(fmt.getFormat(formatUK));
Cell pve = r.createCell(0);
pve.setCellValue(12345);
pve.setCellStyle(cs);
Cell nve = r.createCell(1);
nve.setCellValue(-12345);
nve.setCellStyle(cs);
Cell zero = r.createCell(2);
zero.setCellValue(0);
zero.setCellStyle(cs);
assertEquals(pound + " 12,345", formatter.formatCellValue(pve));
assertEquals("-" + pound + " 12,345", formatter.formatCellValue(nve));
// TODO Fix this to not have an extra 0 at the end
//assertEquals(pound+" - ", formatter.formatCellValue(zero));
}
}
/**
* Using a single quote (') instead of a comma (,) as
* a number separator, eg 1000 -> 1'000
*/
@Test
public final void test55265() throws IOException {
try (Workbook wb = _testDataProvider.createWorkbook()) {
DataFormatter formatter = new DataFormatter();
DataFormat fmt = wb.createDataFormat();
Sheet sheet = wb.createSheet();
Row r = sheet.createRow(0);
CellStyle cs = wb.createCellStyle();
cs.setDataFormat(fmt.getFormat("#'##0"));
Cell zero = r.createCell(0);
zero.setCellValue(0);
zero.setCellStyle(cs);
Cell sml = r.createCell(1);
sml.setCellValue(12);
sml.setCellStyle(cs);
Cell med = r.createCell(2);
med.setCellValue(1234);
med.setCellStyle(cs);
Cell lge = r.createCell(3);
lge.setCellValue(12345678);
lge.setCellStyle(cs);
assertEquals("0", formatter.formatCellValue(zero));
assertEquals("12", formatter.formatCellValue(sml));
assertEquals("1'234", formatter.formatCellValue(med));
assertEquals("12'345'678", formatter.formatCellValue(lge));
}
}
}
|