You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

TestDataFormatter.java 59KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200
  1. /* ====================================================================
  2. Licensed to the Apache Software Foundation (ASF) under one or more
  3. contributor license agreements. See the NOTICE file distributed with
  4. this work for additional information regarding copyright ownership.
  5. The ASF licenses this file to You under the Apache License, Version 2.0
  6. (the "License"); you may not use this file except in compliance with
  7. the License. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  9. Unless required by applicable law or agreed to in writing, software
  10. distributed under the License is distributed on an "AS IS" BASIS,
  11. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. See the License for the specific language governing permissions and
  13. limitations under the License.
  14. 2012 - Alfresco Software, Ltd.
  15. Alfresco Software has modified source of this file
  16. The details of changes as svn diff can be found in svn at location root/projects/3rd-party/src
  17. ==================================================================== */
  18. package org.apache.poi.ss.usermodel;
  19. import static org.junit.jupiter.api.Assertions.assertEquals;
  20. import static org.junit.jupiter.api.Assertions.assertFalse;
  21. import static org.junit.jupiter.api.Assertions.assertThrows;
  22. import static org.junit.jupiter.api.Assertions.assertTrue;
  23. import java.io.IOException;
  24. import java.text.DateFormat;
  25. import java.util.ArrayList;
  26. import java.util.Calendar;
  27. import java.util.Date;
  28. import java.util.Locale;
  29. import java.util.concurrent.CompletableFuture;
  30. import java.util.concurrent.TimeUnit;
  31. import org.apache.poi.POITestCase;
  32. import org.apache.poi.hssf.HSSFTestDataSamples;
  33. import org.apache.poi.hssf.usermodel.HSSFWorkbook;
  34. import org.apache.poi.hssf.usermodel.TestHSSFDataFormatter;
  35. import org.apache.poi.ss.format.CellFormat;
  36. import org.apache.poi.ss.format.CellFormatResult;
  37. import org.apache.poi.ss.util.CellReference;
  38. import org.apache.poi.ss.util.NumberToTextConverter;
  39. import org.apache.poi.util.LocaleUtil;
  40. import org.apache.poi.util.SuppressForbidden;
  41. import org.junit.jupiter.api.BeforeAll;
  42. import org.junit.jupiter.api.Disabled;
  43. import org.junit.jupiter.api.Test;
  44. /**
  45. * Tests of {@link DataFormatter}
  46. *
  47. * See {@link TestHSSFDataFormatter} too for
  48. * more tests.
  49. */
  50. class TestDataFormatter {
  51. private static final double _15_MINUTES = 0.041666667;
  52. @BeforeAll
  53. @SuppressForbidden
  54. public static void setUpClass() {
  55. // some pre-checks to hunt for a problem in the Maven build
  56. // these checks ensure that the correct locale is set, so a failure here
  57. // usually indicates an invalid locale during test-execution
  58. assertFalse(DateUtil.isADateFormat(-1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  59. Locale ul = LocaleUtil.getUserLocale();
  60. assertTrue(Locale.ROOT.equals(ul) || Locale.getDefault().equals(ul));
  61. final String textValue = NumberToTextConverter.toText(1234.56);
  62. assertEquals(-1, textValue.indexOf('E'));
  63. Object cellValueO = 1234.56;
  64. /*CellFormat cellFormat = new CellFormat("_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-");
  65. CellFormatResult result = cellFormat.apply(cellValueO);
  66. assertEquals(" 1,234.56 ", result.text);*/
  67. CellFormat cfmt = CellFormat.getInstance("_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-");
  68. CellFormatResult result = cfmt.apply(cellValueO);
  69. assertEquals(" 1,234.56 ", result.text,
  70. "This failure can indicate that the wrong locale is used during test-execution, "
  71. + "ensure you run with english/US via -Duser.language=en -Duser.country=US. "
  72. + "Having: " + System.getProperty("user.language") + "/" + System.getProperty("user.country"));
  73. }
  74. @Test
  75. void setEmulateCSV() {
  76. DataFormatter dataFormatter = new DataFormatter();
  77. assertFalse(dataFormatter.isEmulateCSV());
  78. dataFormatter.setEmulateCSV(true);
  79. assertTrue(dataFormatter.isEmulateCSV());
  80. dataFormatter.setEmulateCSV(false);
  81. assertFalse(dataFormatter.isEmulateCSV());
  82. }
  83. @Test
  84. void setUse4DigitYearsInAllDateFormats() {
  85. DataFormatter dataFormatter = new DataFormatter();
  86. assertFalse(dataFormatter.use4DigitYearsInAllDateFormats());
  87. dataFormatter.setUse4DigitYearsInAllDateFormats(true);
  88. assertTrue(dataFormatter.use4DigitYearsInAllDateFormats());
  89. dataFormatter.setUse4DigitYearsInAllDateFormats(false);
  90. assertFalse(dataFormatter.use4DigitYearsInAllDateFormats());
  91. }
  92. @Test
  93. void useCachedValuesForFormulaCells() {
  94. DataFormatter dataFormatter = new DataFormatter();
  95. assertFalse(dataFormatter.useCachedValuesForFormulaCells());
  96. dataFormatter.setUseCachedValuesForFormulaCells(true);
  97. assertTrue(dataFormatter.useCachedValuesForFormulaCells());
  98. dataFormatter.setUseCachedValuesForFormulaCells(false);
  99. assertFalse(dataFormatter.useCachedValuesForFormulaCells());
  100. }
  101. /**
  102. * Test that we use the specified locale when deciding
  103. * how to format normal numbers
  104. */
  105. @Test
  106. void testLocale() {
  107. DataFormatter dfUS = new DataFormatter(Locale.US);
  108. DataFormatter dfFR = new DataFormatter(Locale.FRENCH);
  109. assertEquals("1234", dfUS.formatRawCellContents(1234, -1, "@"));
  110. assertEquals("1234", dfFR.formatRawCellContents(1234, -1, "@"));
  111. assertEquals("12.34", dfUS.formatRawCellContents(12.34, -1, "@"));
  112. assertEquals("12,34", dfFR.formatRawCellContents(12.34, -1, "@"));
  113. }
  114. /**
  115. * At the moment, we don't decode the locale strings into
  116. * a specific locale, but we should format things as if
  117. * the locale (eg '[$-1010409]') isn't there
  118. */
  119. @Test
  120. void testLocaleBasedFormats() {
  121. DataFormatter dfUS = new DataFormatter(Locale.US);
  122. // Standard formats
  123. assertEquals("63", dfUS.formatRawCellContents(63.0, -1, "[$-1010409]General"));
  124. assertEquals("63", dfUS.formatRawCellContents(63.0, -1, "[$-1010409]@"));
  125. // Regular numeric style formats
  126. assertEquals("63", dfUS.formatRawCellContents(63.0, -1, "[$-1010409]##"));
  127. assertEquals("63", dfUS.formatRawCellContents(63.0, -1, "[$-1010409]00"));
  128. }
  129. /**
  130. * Test that we use the specified locale when deciding
  131. * how to format normal numbers
  132. */
  133. @Test
  134. void testGrouping() {
  135. DataFormatter dfUS = new DataFormatter(Locale.US);
  136. DataFormatter dfDE = new DataFormatter(Locale.GERMAN);
  137. assertEquals("1,234.57", dfUS.formatRawCellContents(1234.567, -1, "#,##0.00"));
  138. assertEquals("1'234.57", dfUS.formatRawCellContents(1234.567, -1, "#'##0.00"));
  139. assertEquals("1 234.57", dfUS.formatRawCellContents(1234.567, -1, "# ##0.00"));
  140. assertEquals("1.234,57", dfDE.formatRawCellContents(1234.567, -1, "#,##0.00"));
  141. assertEquals("1'234,57", dfDE.formatRawCellContents(1234.567, -1, "#'##0.00"));
  142. assertEquals("1 234,57", dfDE.formatRawCellContents(1234.567, -1, "# ##0.00"));
  143. }
  144. /**
  145. * Ensure that colours get correctly
  146. * zapped from within the format strings
  147. */
  148. @Test
  149. void testColours() {
  150. DataFormatter dfUS = new DataFormatter(Locale.US);
  151. String[] formats = {
  152. "##.##",
  153. "[WHITE]##.##",
  154. "[BLACK]##.##;[RED]-##.##",
  155. "[COLOR11]##.##;[COLOR 43]-##.00",
  156. };
  157. for (String format : formats) {
  158. assertEquals(
  159. "12.34",
  160. dfUS.formatRawCellContents(12.343, -1, format),
  161. "Wrong format for: " + format
  162. );
  163. assertEquals(
  164. "-12.34",
  165. dfUS.formatRawCellContents(-12.343, -1, format),
  166. "Wrong format for: " + format
  167. );
  168. }
  169. // Ensure that random square brackets remain
  170. assertEquals("12.34[a]", dfUS.formatRawCellContents(12.343, -1, "##.##[a]"));
  171. assertEquals("[ab]12.34[x]", dfUS.formatRawCellContents(12.343, -1, "[ab]##.##[x]"));
  172. }
  173. @Test
  174. void testColoursAndBrackets() {
  175. DataFormatter dfUS = new DataFormatter(Locale.US);
  176. // Without currency symbols
  177. String[] formats = { "#,##0.00;[Blue](#,##0.00)" };
  178. for (String format : formats) {
  179. assertEquals(
  180. "12.34",
  181. dfUS.formatRawCellContents(12.343, -1, format),
  182. "Wrong format for: " + format
  183. );
  184. assertEquals(
  185. "(12.34)",
  186. dfUS.formatRawCellContents(-12.343, -1, format),
  187. "Wrong format for: " + format
  188. );
  189. }
  190. // With
  191. formats = new String[] { "$#,##0.00;[Red]($#,##0.00)" };
  192. for (String format : formats) {
  193. assertEquals(
  194. "$12.34",
  195. dfUS.formatRawCellContents(12.343, -1, format),
  196. "Wrong format for: " + format
  197. );
  198. assertEquals(
  199. "($12.34)",
  200. dfUS.formatRawCellContents(-12.343, -1, format),
  201. "Wrong format for: " + format
  202. );
  203. }
  204. }
  205. @Test
  206. void testConditionalRanges() {
  207. DataFormatter dfUS = new DataFormatter(Locale.US);
  208. String format = "[>=10]#,##0;[<10]0.0";
  209. assertEquals("17,876", dfUS.formatRawCellContents(17876.000, -1, format), "Wrong format for " + format);
  210. assertEquals("9.7", dfUS.formatRawCellContents(9.71, -1, format), "Wrong format for " + format);
  211. }
  212. /**
  213. * Test how we handle negative and zeros.
  214. * Note - some tests are disabled as DecimalFormat
  215. * and Excel differ, and workarounds are not
  216. * yet in place for all of these
  217. */
  218. @Test
  219. void testNegativeZero() {
  220. DataFormatter dfUS = new DataFormatter(Locale.US);
  221. String all2dp = "00.00";
  222. String alln1dp = "(00.0)";
  223. String p1dp_n1dp = "00.0;(00.0)";
  224. String p2dp_n1dp = "00.00;(00.0)";
  225. String p2dp_n1dp_z0 = "00.00;(00.0);0";
  226. String all2dpTSP = "00.00_x";
  227. String p2dp_n2dpTSP = "00.00_x;(00.00)_x";
  228. //String p2dp_n1dpTSP = "00.00_x;(00.0)_x";
  229. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, all2dp));
  230. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, p2dp_n1dp));
  231. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, p2dp_n1dp_z0));
  232. assertEquals("(12.3)", dfUS.formatRawCellContents(12.343, -1, alln1dp));
  233. assertEquals("-(12.3)", dfUS.formatRawCellContents(-12.343, -1, alln1dp));
  234. assertEquals("12.3", dfUS.formatRawCellContents(12.343, -1, p1dp_n1dp));
  235. assertEquals("(12.3)", dfUS.formatRawCellContents(-12.343, -1, p1dp_n1dp));
  236. assertEquals("-12.34", dfUS.formatRawCellContents(-12.343, -1, all2dp));
  237. // TODO - fix case of negative subpattern differing from the
  238. // positive one by more than just the prefix+suffix, which
  239. // is all DecimalFormat supports...
  240. // assertEquals("(12.3)", dfUS.formatRawCellContents(-12.343, -1, p2dp_n1dp));
  241. // assertEquals("(12.3)", dfUS.formatRawCellContents(-12.343, -1, p2dp_n1dp_z0));
  242. assertEquals("00.00", dfUS.formatRawCellContents(0, -1, all2dp));
  243. assertEquals("00.00", dfUS.formatRawCellContents(0, -1, p2dp_n1dp));
  244. assertEquals("0", dfUS.formatRawCellContents(0, -1, p2dp_n1dp_z0));
  245. // Spaces are skipped
  246. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, all2dpTSP));
  247. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, p2dp_n2dpTSP));
  248. assertEquals("(12.34)", dfUS.formatRawCellContents(-12.343, -1, p2dp_n2dpTSP));
  249. // assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, p2dp_n1dpTSP));
  250. // assertEquals("(12.3)", dfUS.formatRawCellContents(-12.343, -1, p2dp_n1dpTSP));
  251. }
  252. /**
  253. * Test that we correctly handle fractions in the
  254. * format string, eg # #/#
  255. */
  256. @Test
  257. void testFractions() {
  258. DataFormatter dfUS = new DataFormatter(Locale.US);
  259. // Excel often prefers "# #/#"
  260. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# #/#"));
  261. assertEquals("321 26/81", dfUS.formatRawCellContents(321.321, -1, "# #/##"));
  262. assertEquals("26027/81", dfUS.formatRawCellContents(321.321, -1, "#/##"));
  263. // OOo seems to like the "# ?/?" form
  264. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# ?/?"));
  265. assertEquals("321 26/81", dfUS.formatRawCellContents(321.321, -1, "# ?/??"));
  266. assertEquals("26027/81", dfUS.formatRawCellContents(321.321, -1, "?/??"));
  267. // p;n;z;s parts
  268. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# #/#;# ##/#;0;xxx"));
  269. assertEquals("321 1/3", dfUS.formatRawCellContents(-321.321, -1, "# #/#;# ##/#;0;xxx")); // Note the lack of - sign!
  270. assertEquals("0", dfUS.formatRawCellContents(0, -1, "# #/#;# ##/#;0;xxx"));
  271. // assertEquals(".", dfUS.formatRawCellContents(0, -1, "# #/#;# ##/#;#.#;xxx")); // Currently shows as 0. not .
  272. // Custom formats with text
  273. assertEquals("+ve", dfUS.formatRawCellContents(1, -1, "+ve;-ve;zero;xxx"));
  274. assertEquals("-ve", dfUS.formatRawCellContents(-1, -1, "-ve;-ve;zero;xxx"));
  275. assertEquals("zero", dfUS.formatRawCellContents(0, -1, "zero;-ve;zero;xxx"));
  276. // Custom formats - check text is stripped, including multiple spaces
  277. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# #/#"));
  278. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "#\" \" #/#"));
  279. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "#\"FRED\" #/#"));
  280. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "#\\ #/#"));
  281. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# \\q#/#"));
  282. // Cases that were very slow
  283. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "0\" \"?/?;?/?")); // 0" "?/?;?/? - length of -ve part was used
  284. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "0 \"#\"\\#\\#?/?")); // 0 "#"\#\#?/? - length of text was used
  285. assertEquals("321 295/919", dfUS.formatRawCellContents(321.321, -1, "# #/###"));
  286. assertEquals("321 321/1000", dfUS.formatRawCellContents(321.321, -1, "# #/####")); // Code limits to #### as that is as slow as we want to get
  287. assertEquals("321 321/1000", dfUS.formatRawCellContents(321.321, -1, "# #/##########"));
  288. // Not a valid fraction formats (too many #/# or ?/?) - hence the strange expected results
  289. /*
  290. assertEquals("321 / ?/?", dfUS.formatRawCellContents(321.321, -1, "# #/# ?/?"));
  291. assertEquals("321 / /", dfUS.formatRawCellContents(321.321, -1, "# #/# #/#"));
  292. assertEquals("321 ?/? ?/?", dfUS.formatRawCellContents(321.321, -1, "# ?/? ?/?"));
  293. assertEquals("321 ?/? / /", dfUS.formatRawCellContents(321.321, -1, "# ?/? #/# #/#"));
  294. */
  295. //Bug54686 patch sets default behavior of # #/## if there is a failure to parse
  296. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# #/# ?/?"));
  297. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# #/# #/#"));
  298. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# ?/? ?/?"));
  299. assertEquals("321 1/3", dfUS.formatRawCellContents(321.321, -1, "# ?/? #/# #/#"));
  300. // Where +ve has a fraction, but -ve doesn't, we currently show both
  301. assertEquals("123 1/3", dfUS.formatRawCellContents( 123.321, -1, "0 ?/?;0"));
  302. //assertEquals("123", dfUS.formatRawCellContents(-123.321, -1, "0 ?/?;0"));
  303. //Bug54868 patch has a hit on the first string before the ";"
  304. assertEquals("-123 1/3", dfUS.formatRawCellContents(-123.321, -1, "0 ?/?;0"));
  305. assertEquals("123 1/3", dfUS.formatRawCellContents(123.321, -1, "0 ?/?;0"));
  306. //Bug53150 formatting a whole number with fractions should just give the number
  307. assertEquals("1", dfUS.formatRawCellContents(1.0, -1, "# #/#"));
  308. assertEquals("11", dfUS.formatRawCellContents(11.0, -1, "# #/#"));
  309. }
  310. /**
  311. * Test that _x (blank with the space taken by "x")
  312. * and *x (fill to the column width with "x"s) are
  313. * correctly ignored by us.
  314. */
  315. @Test
  316. void testPaddingSpaces() {
  317. DataFormatter dfUS = new DataFormatter(Locale.US);
  318. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##_ "));
  319. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##_1"));
  320. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##_)"));
  321. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "_-##.##"));
  322. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##* "));
  323. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##*1"));
  324. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##*)"));
  325. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "*-##.##"));
  326. }
  327. /**
  328. * DataFormatter is the CSV mode preserves spaces
  329. */
  330. @Test
  331. void testPaddingSpacesCSV() {
  332. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  333. assertEquals("12.34 ", dfUS.formatRawCellContents(12.343, -1, "##.##_ "));
  334. assertEquals("-12.34 ", dfUS.formatRawCellContents(-12.343, -1, "##.##_ "));
  335. assertEquals(". ", dfUS.formatRawCellContents(0.0, -1, "##.##_ "));
  336. assertEquals("12.34 ", dfUS.formatRawCellContents(12.343, -1, "##.##_1"));
  337. assertEquals("-12.34 ", dfUS.formatRawCellContents(-12.343, -1, "##.##_1"));
  338. assertEquals(". ", dfUS.formatRawCellContents(0.0, -1, "##.##_1"));
  339. assertEquals("12.34 ", dfUS.formatRawCellContents(12.343, -1, "##.##_)"));
  340. assertEquals("-12.34 ", dfUS.formatRawCellContents(-12.343, -1, "##.##_)"));
  341. assertEquals(". ", dfUS.formatRawCellContents(0.0, -1, "##.##_)"));
  342. assertEquals(" 12.34", dfUS.formatRawCellContents(12.343, -1, "_-##.##"));
  343. assertEquals("- 12.34", dfUS.formatRawCellContents(-12.343, -1, "_-##.##"));
  344. assertEquals(" .", dfUS.formatRawCellContents(0.0, -1, "_-##.##"));
  345. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##* "));
  346. assertEquals("-12.34", dfUS.formatRawCellContents(-12.343, -1, "##.##* "));
  347. assertEquals(".", dfUS.formatRawCellContents(0.0, -1, "##.##* "));
  348. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##*1"));
  349. assertEquals("-12.34", dfUS.formatRawCellContents(-12.343, -1, "##.##*1"));
  350. assertEquals(".", dfUS.formatRawCellContents(0.0, -1, "##.##*1"));
  351. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "##.##*)"));
  352. assertEquals("-12.34", dfUS.formatRawCellContents(-12.343, -1, "##.##*)"));
  353. assertEquals(".", dfUS.formatRawCellContents(0.0, -1, "##.##*)"));
  354. assertEquals("12.34", dfUS.formatRawCellContents(12.343, -1, "*-##.##"));
  355. assertEquals("-12.34", dfUS.formatRawCellContents(-12.343, -1, "*-##.##"));
  356. assertEquals(".", dfUS.formatRawCellContents(0.0, -1, "*-##.##"));
  357. }
  358. /**
  359. * Test that the special Excel month format MMMMM
  360. * gets turned into the first letter of the month
  361. */
  362. @Test
  363. void testMMMMM() {
  364. DataFormatter dfUS = new DataFormatter(Locale.US);
  365. Calendar c = LocaleUtil.getLocaleCalendar(2010, 5, 1, 2, 0, 0);
  366. assertEquals("2010-J-1 2:00:00", dfUS.formatRawCellContents(
  367. DateUtil.getExcelDate(c, false), -1, "YYYY-MMMMM-D h:mm:ss"
  368. ));
  369. }
  370. /**
  371. * Tests that we do AM/PM handling properly
  372. */
  373. @Test
  374. void testAMPM() {
  375. DataFormatter dfUS = new DataFormatter(Locale.US);
  376. assertEquals("06:00", dfUS.formatRawCellContents(0.25, -1, "hh:mm"));
  377. assertEquals("18:00", dfUS.formatRawCellContents(0.75, -1, "hh:mm"));
  378. assertEquals("06:00 AM", dfUS.formatRawCellContents(0.25, -1, "hh:mm AM/PM"));
  379. assertEquals("06:00 PM", dfUS.formatRawCellContents(0.75, -1, "hh:mm AM/PM"));
  380. assertEquals("1904-01-01 06:00:00 AM", dfUS.formatRawCellContents(0.25, -1, "yyyy-mm-dd hh:mm:ss AM/PM", true));
  381. assertEquals("1904-01-01 06:00:00 PM", dfUS.formatRawCellContents(0.75, -1, "yyyy-mm-dd hh:mm:ss AM/PM", true));
  382. }
  383. /**
  384. * Test that we can handle elapsed time,
  385. * eg formatting 1 day 4 hours as 28 hours
  386. */
  387. @Test
  388. void testElapsedTime() {
  389. DataFormatter dfUS = new DataFormatter(Locale.US);
  390. double hour = 1.0/24.0;
  391. assertEquals("01:00", dfUS.formatRawCellContents(1*hour, -1, "hh:mm"));
  392. assertEquals("05:00", dfUS.formatRawCellContents(5*hour, -1, "hh:mm"));
  393. assertEquals("20:00", dfUS.formatRawCellContents(20*hour, -1, "hh:mm"));
  394. assertEquals("23:00", dfUS.formatRawCellContents(23*hour, -1, "hh:mm"));
  395. assertEquals("00:00", dfUS.formatRawCellContents(24*hour, -1, "hh:mm"));
  396. assertEquals("02:00", dfUS.formatRawCellContents(26*hour, -1, "hh:mm"));
  397. assertEquals("20:00", dfUS.formatRawCellContents(44*hour, -1, "hh:mm"));
  398. assertEquals("02:00", dfUS.formatRawCellContents(50*hour, -1, "hh:mm"));
  399. assertEquals("01:00", dfUS.formatRawCellContents(1*hour, -1, "[hh]:mm"));
  400. assertEquals("05:00", dfUS.formatRawCellContents(5*hour, -1, "[hh]:mm"));
  401. assertEquals("20:00", dfUS.formatRawCellContents(20*hour, -1, "[hh]:mm"));
  402. assertEquals("23:00", dfUS.formatRawCellContents(23*hour, -1, "[hh]:mm"));
  403. assertEquals("24:00", dfUS.formatRawCellContents(24*hour, -1, "[hh]:mm"));
  404. assertEquals("26:00", dfUS.formatRawCellContents(26*hour, -1, "[hh]:mm"));
  405. assertEquals("44:00", dfUS.formatRawCellContents(44*hour, -1, "[hh]:mm"));
  406. assertEquals("50:00", dfUS.formatRawCellContents(50*hour, -1, "[hh]:mm"));
  407. assertEquals("01", dfUS.formatRawCellContents(1*hour, -1, "[hh]"));
  408. assertEquals("05", dfUS.formatRawCellContents(5*hour, -1, "[hh]"));
  409. assertEquals("20", dfUS.formatRawCellContents(20*hour, -1, "[hh]"));
  410. assertEquals("23", dfUS.formatRawCellContents(23*hour, -1, "[hh]"));
  411. assertEquals("24", dfUS.formatRawCellContents(24*hour, -1, "[hh]"));
  412. assertEquals("26", dfUS.formatRawCellContents(26*hour, -1, "[hh]"));
  413. assertEquals("44", dfUS.formatRawCellContents(44*hour, -1, "[hh]"));
  414. assertEquals("50", dfUS.formatRawCellContents(50*hour, -1, "[hh]"));
  415. double minute = 1.0/24.0/60.0;
  416. assertEquals("01:00", dfUS.formatRawCellContents(1*minute, -1, "[mm]:ss"));
  417. assertEquals("05:00", dfUS.formatRawCellContents(5*minute, -1, "[mm]:ss"));
  418. assertEquals("20:00", dfUS.formatRawCellContents(20*minute, -1, "[mm]:ss"));
  419. assertEquals("23:00", dfUS.formatRawCellContents(23*minute, -1, "[mm]:ss"));
  420. assertEquals("24:00", dfUS.formatRawCellContents(24*minute, -1, "[mm]:ss"));
  421. assertEquals("26:00", dfUS.formatRawCellContents(26*minute, -1, "[mm]:ss"));
  422. assertEquals("44:00", dfUS.formatRawCellContents(44*minute, -1, "[mm]:ss"));
  423. assertEquals("50:00", dfUS.formatRawCellContents(50*minute, -1, "[mm]:ss"));
  424. assertEquals("59:00", dfUS.formatRawCellContents(59*minute, -1, "[mm]:ss"));
  425. assertEquals("60:00", dfUS.formatRawCellContents(60*minute, -1, "[mm]:ss"));
  426. assertEquals("61:00", dfUS.formatRawCellContents(61*minute, -1, "[mm]:ss"));
  427. assertEquals("119:00", dfUS.formatRawCellContents(119*minute, -1, "[mm]:ss"));
  428. assertEquals("120:00", dfUS.formatRawCellContents(120*minute, -1, "[mm]:ss"));
  429. assertEquals("121:00", dfUS.formatRawCellContents(121*minute, -1, "[mm]:ss"));
  430. assertEquals("01", dfUS.formatRawCellContents(1*minute, -1, "[mm]"));
  431. assertEquals("05", dfUS.formatRawCellContents(5*minute, -1, "[mm]"));
  432. assertEquals("20", dfUS.formatRawCellContents(20*minute, -1, "[mm]"));
  433. assertEquals("23", dfUS.formatRawCellContents(23*minute, -1, "[mm]"));
  434. assertEquals("24", dfUS.formatRawCellContents(24*minute, -1, "[mm]"));
  435. assertEquals("26", dfUS.formatRawCellContents(26*minute, -1, "[mm]"));
  436. assertEquals("44", dfUS.formatRawCellContents(44*minute, -1, "[mm]"));
  437. assertEquals("50", dfUS.formatRawCellContents(50*minute, -1, "[mm]"));
  438. assertEquals("59", dfUS.formatRawCellContents(59*minute, -1, "[mm]"));
  439. assertEquals("60", dfUS.formatRawCellContents(60*minute, -1, "[mm]"));
  440. assertEquals("61", dfUS.formatRawCellContents(61*minute, -1, "[mm]"));
  441. assertEquals("119", dfUS.formatRawCellContents(119*minute, -1, "[mm]"));
  442. assertEquals("120", dfUS.formatRawCellContents(120*minute, -1, "[mm]"));
  443. assertEquals("121", dfUS.formatRawCellContents(121*minute, -1, "[mm]"));
  444. double second = 1.0/24.0/60.0/60.0;
  445. assertEquals("86400", dfUS.formatRawCellContents(86400*second, -1, "[ss]"));
  446. assertEquals("01", dfUS.formatRawCellContents(1*second, -1, "[ss]"));
  447. assertEquals("05", dfUS.formatRawCellContents(5*second, -1, "[ss]"));
  448. assertEquals("20", dfUS.formatRawCellContents(20*second, -1, "[ss]"));
  449. assertEquals("23", dfUS.formatRawCellContents(23*second, -1, "[ss]"));
  450. assertEquals("24", dfUS.formatRawCellContents(24*second, -1, "[ss]"));
  451. assertEquals("26", dfUS.formatRawCellContents(26*second, -1, "[ss]"));
  452. assertEquals("44", dfUS.formatRawCellContents(44*second, -1, "[ss]"));
  453. assertEquals("50", dfUS.formatRawCellContents(50*second, -1, "[ss]"));
  454. assertEquals("59", dfUS.formatRawCellContents(59*second, -1, "[ss]"));
  455. assertEquals("60", dfUS.formatRawCellContents(60*second, -1, "[ss]"));
  456. assertEquals("61", dfUS.formatRawCellContents(61*second, -1, "[ss]"));
  457. assertEquals("119", dfUS.formatRawCellContents(119*second, -1, "[ss]"));
  458. assertEquals("120", dfUS.formatRawCellContents(120*second, -1, "[ss]"));
  459. assertEquals("121", dfUS.formatRawCellContents(121*second, -1, "[ss]"));
  460. assertEquals("27:18:08", dfUS.formatRawCellContents(1.1376, -1, "[h]:mm:ss"));
  461. assertEquals("28:48:00", dfUS.formatRawCellContents(1.2, -1, "[h]:mm:ss"));
  462. assertEquals("29:31:12", dfUS.formatRawCellContents(1.23, -1, "[h]:mm:ss"));
  463. assertEquals("31:26:24", dfUS.formatRawCellContents(1.31, -1, "[h]:mm:ss"));
  464. assertEquals("27:18:08", dfUS.formatRawCellContents(1.1376, -1, "[hh]:mm:ss"));
  465. assertEquals("28:48:00", dfUS.formatRawCellContents(1.2, -1, "[hh]:mm:ss"));
  466. assertEquals("29:31:12", dfUS.formatRawCellContents(1.23, -1, "[hh]:mm:ss"));
  467. assertEquals("31:26:24", dfUS.formatRawCellContents(1.31, -1, "[hh]:mm:ss"));
  468. assertEquals("57:07.2", dfUS.formatRawCellContents(.123, -1, "mm:ss.0;@"));
  469. assertEquals("57:41.8", dfUS.formatRawCellContents(.1234, -1, "mm:ss.0;@"));
  470. assertEquals("57:41.76", dfUS.formatRawCellContents(.1234, -1, "mm:ss.00;@"));
  471. assertEquals("57:41.760", dfUS.formatRawCellContents(.1234, -1, "mm:ss.000;@"));
  472. assertEquals("24:00.0", dfUS.formatRawCellContents(123456.6, -1, "mm:ss.0"));
  473. }
  474. @Test
  475. void testDateWindowing() {
  476. DataFormatter dfUS = new DataFormatter(Locale.US);
  477. assertEquals("1899-12-31 00:00:00", dfUS.formatRawCellContents(0.0, -1, "yyyy-mm-dd hh:mm:ss"));
  478. assertEquals("1899-12-31 00:00:00", dfUS.formatRawCellContents(0.0, -1, "yyyy-mm-dd hh:mm:ss", false));
  479. assertEquals("1904-01-01 00:00:00", dfUS.formatRawCellContents(0.0, -1, "yyyy-mm-dd hh:mm:ss", true));
  480. }
  481. @Test
  482. void testScientificNotation() {
  483. DataFormatter dfUS = new DataFormatter(Locale.US);
  484. assertEquals("1.23E+01", dfUS.formatRawCellContents(12.343, -1, "0.00E+00"));
  485. assertEquals("-1.23E+01", dfUS.formatRawCellContents(-12.343, -1, "0.00E+00"));
  486. assertEquals("0.00E+00", dfUS.formatRawCellContents(0.0, -1, "0.00E+00"));
  487. }
  488. @Test
  489. void testInvalidDate() {
  490. DataFormatter df1 = new DataFormatter(Locale.US);
  491. assertEquals("-1.0", df1.formatRawCellContents(-1, -1, "mm/dd/yyyy"));
  492. DataFormatter df2 = new DataFormatter(Locale.US, true);
  493. assertEquals("###############################################################################################################################################################################################################################################################",
  494. df2.formatRawCellContents(-1, -1, "mm/dd/yyyy"));
  495. }
  496. @Test
  497. void testEscapes() {
  498. DataFormatter dfUS = new DataFormatter(Locale.US);
  499. assertEquals("1901-01-01", dfUS.formatRawCellContents(367.0, -1, "yyyy-mm-dd"));
  500. assertEquals("1901-01-01", dfUS.formatRawCellContents(367.0, -1, "yyyy\\-mm\\-dd"));
  501. assertEquals("1901.01.01", dfUS.formatRawCellContents(367.0, -1, "yyyy.mm.dd"));
  502. assertEquals("1901.01.01", dfUS.formatRawCellContents(367.0, -1, "yyyy\\.mm\\.dd"));
  503. assertEquals("1901/01/01", dfUS.formatRawCellContents(367.0, -1, "yyyy/mm/dd"));
  504. assertEquals("1901/01/01", dfUS.formatRawCellContents(367.0, -1, "yyyy\\/mm\\/dd"));
  505. }
  506. @Test
  507. void testFormatsWithPadding() {
  508. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  509. // These request space-padding, based on the cell width
  510. // There should always be one space after, variable (non-zero) amount before
  511. // Because the Cell Width isn't available, this gets emulated with
  512. // 4 leading spaces, or a minus then 3 leading spaces
  513. // This isn't all that consistent, but it's the best we can really manage...
  514. assertEquals(" 1,234.56 ", dfUS.formatRawCellContents( 1234.56, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  515. assertEquals("- 1,234.56 ", dfUS.formatRawCellContents(-1234.56, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  516. assertEquals(" 12.34 ", dfUS.formatRawCellContents( 12.34, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  517. assertEquals("- 12.34 ", dfUS.formatRawCellContents(-12.34, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  518. assertEquals(" 0.10 ", dfUS.formatRawCellContents( 0.1, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  519. assertEquals("- 0.10 ", dfUS.formatRawCellContents(-0.1, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  520. // TODO Fix this, we are randomly adding a 0 at the end that shouldn't be there
  521. //assertEquals(" - ", dfUS.formatRawCellContents(0.0, -1, "_-* #,##0.00_-;-* #,##0.00_-;_-* \"-\"??_-;_-@_-"));
  522. assertEquals(" $ 1.10 ", dfUS.formatRawCellContents( 1.1, -1, "_-$* #,##0.00_-;-$* #,##0.00_-;_-$* \"-\"??_-;_-@_-"));
  523. assertEquals("-$ 1.10 ", dfUS.formatRawCellContents(-1.1, -1, "_-$* #,##0.00_-;-$* #,##0.00_-;_-$* \"-\"??_-;_-@_-"));
  524. // TODO Fix this, we are randomly adding a 0 at the end that shouldn't be there
  525. //assertEquals(" $ - ", dfUS.formatRawCellContents( 0.0, -1, "_-$* #,##0.00_-;-$* #,##0.00_-;_-$* \"-\"??_-;_-@_-"));
  526. }
  527. @Test
  528. void testErrors() throws IOException {
  529. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  530. // Create a spreadsheet with some formula errors in it
  531. try (Workbook wb = new HSSFWorkbook()) {
  532. Sheet s = wb.createSheet();
  533. Row r = s.createRow(0);
  534. Cell c = r.createCell(0, CellType.ERROR);
  535. c.setCellErrorValue(FormulaError.DIV0.getCode());
  536. assertEquals(FormulaError.DIV0.getString(), dfUS.formatCellValue(c));
  537. c.setCellErrorValue(FormulaError.REF.getCode());
  538. assertEquals(FormulaError.REF.getString(), dfUS.formatCellValue(c));
  539. }
  540. }
  541. @Test
  542. void testBoolean() throws IOException {
  543. DataFormatter formatter = new DataFormatter();
  544. // Create a spreadsheet with some TRUE/FALSE boolean values in it
  545. try (Workbook wb = new HSSFWorkbook()) {
  546. Sheet s = wb.createSheet();
  547. Row r = s.createRow(0);
  548. Cell c = r.createCell(0);
  549. c.setCellValue(true);
  550. assertEquals("TRUE", formatter.formatCellValue(c));
  551. c.setCellValue(false);
  552. assertEquals("FALSE", formatter.formatCellValue(c));
  553. }
  554. }
  555. /**
  556. * While we don't currently support using a locale code at
  557. * the start of a format string to format it differently, we
  558. * should at least handle it as it if wasn't there
  559. */
  560. @Test
  561. void testDatesWithLocales() {
  562. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  563. String dateFormatEnglish = "[$-409]mmmm dd yyyy h:mm AM/PM";
  564. String dateFormatChinese = "[$-804]mmmm dd yyyy h:mm AM/PM";
  565. // Check we format the English one correctly
  566. double date = 26995.477777777778;
  567. assertEquals(
  568. "November 27 1973 11:28 AM",
  569. dfUS.formatRawCellContents(date, -1, dateFormatEnglish)
  570. );
  571. // Check that, in the absence of locale support, we handle
  572. // the Chinese one the same as the English one
  573. assertEquals(
  574. "November 27 1973 11:28 AM",
  575. dfUS.formatRawCellContents(date, -1, dateFormatChinese)
  576. );
  577. }
  578. /**
  579. * TODO Fix these so that they work
  580. */
  581. @Test
  582. @Disabled
  583. void testCustomFormats() {
  584. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  585. String fmt;
  586. fmt = "\"At\" H:MM AM/PM \"on\" DDDD MMMM D\",\" YYYY";
  587. assertEquals(
  588. "At 4:20 AM on Thursday May 17, 2007",
  589. dfUS.formatRawCellContents(39219.1805636921, -1, fmt)
  590. );
  591. fmt = "0 \"dollars and\" .00 \"cents\"";
  592. assertEquals("19 dollars and .99 cents", dfUS.formatRawCellContents(19.99, -1, fmt));
  593. }
  594. /**
  595. * ExcelStyleDateFormatter should work for Milliseconds too
  596. */
  597. @Test
  598. void testExcelStyleDateFormatterStringOnMillis() {
  599. // Test directly with the .000 style
  600. DateFormat formatter1 = new ExcelStyleDateFormatter("ss.000");
  601. assertEquals("00.001", formatter1.format(new Date(1L)));
  602. assertEquals("00.010", formatter1.format(new Date(10L)));
  603. assertEquals("00.100", formatter1.format(new Date(100L)));
  604. assertEquals("01.000", formatter1.format(new Date(1000L)));
  605. assertEquals("01.001", formatter1.format(new Date(1001L)));
  606. assertEquals("10.000", formatter1.format(new Date(10000L)));
  607. assertEquals("10.001", formatter1.format(new Date(10001L)));
  608. // Test directly with the .SSS style
  609. DateFormat formatter2 = new ExcelStyleDateFormatter("ss.SSS");
  610. assertEquals("00.001", formatter2.format(new Date(1L)));
  611. assertEquals("00.010", formatter2.format(new Date(10L)));
  612. assertEquals("00.100", formatter2.format(new Date(100L)));
  613. assertEquals("01.000", formatter2.format(new Date(1000L)));
  614. assertEquals("01.001", formatter2.format(new Date(1001L)));
  615. assertEquals("10.000", formatter2.format(new Date(10000L)));
  616. assertEquals("10.001", formatter2.format(new Date(10001L)));
  617. // Test via DataFormatter
  618. DataFormatter dfUS = new DataFormatter(Locale.US, true);
  619. assertEquals("01.010", dfUS.formatRawCellContents(0.0000116898, -1, "ss.000"));
  620. }
  621. @Test
  622. void testBug54786() {
  623. DataFormatter formatter = new DataFormatter();
  624. String format = "[h]\"\"h\"\" m\"\"m\"\"";
  625. assertTrue(DateUtil.isADateFormat(-1,format));
  626. assertTrue(DateUtil.isValidExcelDate(_15_MINUTES));
  627. assertEquals("1h 0m", formatter.formatRawCellContents(_15_MINUTES, -1, format, false));
  628. assertEquals("0.041666667", formatter.formatRawCellContents(_15_MINUTES, -1, "[h]'h'", false));
  629. assertEquals("1h 0m\"", formatter.formatRawCellContents(_15_MINUTES, -1, "[h]\"\"h\"\" m\"\"m\"\"\"", false));
  630. assertEquals("1h", formatter.formatRawCellContents(_15_MINUTES, -1, "[h]\"\"h\"\"", false));
  631. assertEquals("h1", formatter.formatRawCellContents(_15_MINUTES, -1, "\"\"h\"\"[h]", false));
  632. assertEquals("h1", formatter.formatRawCellContents(_15_MINUTES, -1, "\"\"h\"\"h", false));
  633. assertEquals(" 60", formatter.formatRawCellContents(_15_MINUTES, -1, " [m]", false));
  634. assertEquals("h60", formatter.formatRawCellContents(_15_MINUTES, -1, "\"\"h\"\"[m]", false));
  635. assertEquals("m1", formatter.formatRawCellContents(_15_MINUTES, -1, "\"\"m\"\"h", false));
  636. IllegalArgumentException e = assertThrows(IllegalArgumentException.class, () ->
  637. formatter.formatRawCellContents(_15_MINUTES, -1, "[h]\"\"h\"\" m\"\"m\"\"\"\"", false),
  638. "Catches exception because of invalid format, i.e. trailing quoting");
  639. assertTrue(e.getMessage().contains("Cannot format given Object as a Number"));
  640. }
  641. @Test
  642. void testIsADateFormat() {
  643. // first check some cases that should not be a date, also call multiple times to ensure the cache is used
  644. assertFalse(DateUtil.isADateFormat(-1, null));
  645. assertFalse(DateUtil.isADateFormat(-1, null));
  646. assertFalse(DateUtil.isADateFormat(123, null));
  647. assertFalse(DateUtil.isADateFormat(123, ""));
  648. assertFalse(DateUtil.isADateFormat(124, ""));
  649. assertFalse(DateUtil.isADateFormat(-1, ""));
  650. assertFalse(DateUtil.isADateFormat(-1, ""));
  651. assertFalse(DateUtil.isADateFormat(-1, "nodateformat"));
  652. // then also do the same for some valid date formats
  653. assertTrue(DateUtil.isADateFormat(0x0e, null));
  654. assertTrue(DateUtil.isADateFormat(0x2f, null));
  655. assertTrue(DateUtil.isADateFormat(-1, "yyyy"));
  656. assertTrue(DateUtil.isADateFormat(-1, "yyyy"));
  657. assertTrue(DateUtil.isADateFormat(-1, "dd/mm/yy;[red]dd/mm/yy"));
  658. assertTrue(DateUtil.isADateFormat(-1, "dd/mm/yy;[red]dd/mm/yy"));
  659. assertTrue(DateUtil.isADateFormat(-1, "[h]"));
  660. }
  661. @Test
  662. void testLargeNumbersAndENotation() throws IOException{
  663. assertFormatsTo("1E+86", 99999999999999999999999999999999999999999999999999999999999999999999999999999999999999d);
  664. assertFormatsTo("1E-84", 0.000000000000000000000000000000000000000000000000000000000000000000000000000000000001d);
  665. // Smallest double
  666. // See https://bugs.openjdk.org/browse/JDK-8291240
  667. assertFormatsTo(POITestCase.getJDKVersion() >= 19 ? "9.9E-324" : "1E-323",
  668. 0.00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001d);
  669. // "up to 11 numeric characters, with the decimal point counting as a numeric character"
  670. // https://support.microsoft.com/en-us/kb/65903
  671. assertFormatsTo( "12345678911", 12345678911d);
  672. assertFormatsTo( "1.23457E+11", 123456789112d); // 12th digit of integer -> scientific
  673. assertFormatsTo( "-12345678911", -12345678911d);
  674. assertFormatsTo( "-1.23457E+11", -123456789112d);
  675. assertFormatsTo( "0.1", 0.1);
  676. assertFormatsTo( "0.000000001", 0.000000001);
  677. assertFormatsTo( "1E-10", 0.0000000001); // 12th digit
  678. assertFormatsTo( "-0.000000001", -0.000000001);
  679. assertFormatsTo( "-1E-10", -0.0000000001);
  680. assertFormatsTo( "123.4567892", 123.45678919); // excess decimals are simply rounded away
  681. assertFormatsTo("-123.4567892", -123.45678919);
  682. assertFormatsTo( "1.234567893", 1.2345678925); // rounding mode is half-up
  683. assertFormatsTo("-1.234567893", -1.2345678925);
  684. assertFormatsTo( "1.23457E+19", 12345650000000000000d);
  685. assertFormatsTo("-1.23457E+19", -12345650000000000000d);
  686. assertFormatsTo( "1.23457E-19", 0.0000000000000000001234565d);
  687. assertFormatsTo("-1.23457E-19", -0.0000000000000000001234565d);
  688. assertFormatsTo( "1.000000001", 1.000000001);
  689. assertFormatsTo( "1", 1.0000000001);
  690. assertFormatsTo( "1234.567891", 1234.567891123456789d);
  691. assertFormatsTo( "1234567.891", 1234567.891123456789d);
  692. assertFormatsTo( "12345678912", 12345678911.63456789d); // integer portion uses all 11 digits
  693. assertFormatsTo( "12345678913", 12345678912.5d); // half-up here too
  694. assertFormatsTo("-12345678913", -12345678912.5d);
  695. assertFormatsTo( "1.23457E+11", 123456789112.3456789d);
  696. }
  697. private static void assertFormatsTo(String expected, double input) throws IOException {
  698. try (Workbook wb = new HSSFWorkbook()) {
  699. Sheet s1 = wb.createSheet();
  700. Row row = s1.createRow(0);
  701. Cell rawValue = row.createCell(0);
  702. rawValue.setCellValue(input);
  703. CellStyle newStyle = wb.createCellStyle();
  704. DataFormat dataFormat = wb.createDataFormat();
  705. newStyle.setDataFormat(dataFormat.getFormat("General"));
  706. String actual = new DataFormatter().formatCellValue(rawValue);
  707. assertEquals(expected, actual,
  708. "Failed for input " + input);
  709. }
  710. }
  711. @Test
  712. public void testJDK19() {
  713. // See https://bugs.openjdk.org/browse/JDK-8291240
  714. assertEquals(POITestCase.getJDKVersion() >= 19 ? "9.9E-324" : "1.0E-323",
  715. Double.toString(0.00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001d));
  716. }
  717. @Test
  718. void testFormulaEvaluation() throws IOException {
  719. try (Workbook wb = HSSFTestDataSamples.openSampleWorkbook("FormulaEvalTestData.xls")) {
  720. CellReference ref = new CellReference("D47");
  721. Cell cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
  722. assertEquals(CellType.FORMULA, cell.getCellType());
  723. assertEquals("G9:K9 I7:I12", cell.getCellFormula());
  724. DataFormatter formatter = new DataFormatter();
  725. FormulaEvaluator evaluator = wb.getCreationHelper().createFormulaEvaluator();
  726. assertEquals("5.6789", formatter.formatCellValue(cell, evaluator));
  727. }
  728. }
  729. @Test
  730. void testFormulaEvaluationWithoutFormulaEvaluator() throws IOException {
  731. String formula = "G9:K9 I7:I12";
  732. try (Workbook wb = HSSFTestDataSamples.openSampleWorkbook("FormulaEvalTestData.xls")) {
  733. CellReference ref = new CellReference("D47");
  734. Cell cell = wb.getSheetAt(0).getRow(ref.getRow()).getCell(ref.getCol());
  735. assertEquals(CellType.FORMULA, cell.getCellType());
  736. assertEquals(formula, cell.getCellFormula());
  737. DataFormatter formatter = new DataFormatter();
  738. assertEquals(formula, formatter.formatCellValue(cell));
  739. formatter.setUseCachedValuesForFormulaCells(true);
  740. assertEquals("5.6789", formatter.formatCellValue(cell));
  741. }
  742. }
  743. @Test
  744. void testFormatWithTrailingDotsUS() {
  745. DataFormatter dfUS = new DataFormatter(Locale.US);
  746. assertEquals("1,000,000", dfUS.formatRawCellContents(1000000, -1, "#,##0"));
  747. assertEquals("1,000", dfUS.formatRawCellContents(1000000, -1, "#,##0,"));
  748. assertEquals("1", dfUS.formatRawCellContents(1000000, -1, "#,##0,,"));
  749. assertEquals("1,000,000.0", dfUS.formatRawCellContents(1000000, -1, "#,##0.0"));
  750. assertEquals("1,000.0", dfUS.formatRawCellContents(1000000, -1, "#,##0.0,"));
  751. assertEquals("1.0", dfUS.formatRawCellContents(1000000, -1, "#,##0.0,,"));
  752. assertEquals("1,000,000.00", dfUS.formatRawCellContents(1000000, -1, "#,##0.00"));
  753. assertEquals("1,000.00", dfUS.formatRawCellContents(1000000, -1, "#,##0.00,"));
  754. assertEquals("1.00", dfUS.formatRawCellContents(1000000, -1, "#,##0.00,,"));
  755. assertEquals("1,000,000", dfUS.formatRawCellContents(1e24, -1, "#,##0,,,,,,"));
  756. }
  757. @Test
  758. void testFormatWithTrailingDotsOtherLocale() {
  759. DataFormatter dfIT = new DataFormatter(Locale.ITALY);
  760. assertEquals("1.000.000", dfIT.formatRawCellContents(1000000, -1, "#,##0"));
  761. assertEquals("1.000", dfIT.formatRawCellContents(1000000, -1, "#,##0,"));
  762. assertEquals("1", dfIT.formatRawCellContents(1000000, -1, "#,##0,,"));
  763. assertEquals("1.000.000,0", dfIT.formatRawCellContents(1000000, -1, "#,##0.0"));
  764. assertEquals("1.000,0", dfIT.formatRawCellContents(1000000, -1, "#,##0.0,"));
  765. assertEquals("1,0", dfIT.formatRawCellContents(1000000, -1, "#,##0.0,,"));
  766. assertEquals("1.000.000,00", dfIT.formatRawCellContents(1000000, -1, "#,##0.00"));
  767. assertEquals("1.000,00", dfIT.formatRawCellContents(1000000, -1, "#,##0.00,"));
  768. assertEquals("1,00", dfIT.formatRawCellContents(1000000, -1, "#,##0.00,,"));
  769. assertEquals("1.000.000", dfIT.formatRawCellContents(1e24, -1, "#,##0,,,,,,"));
  770. }
  771. /**
  772. * bug 60031: DataFormatter parses months incorrectly when put at the end of date segment
  773. */
  774. @Test
  775. void testBug60031() {
  776. // 23-08-2016 08:51:01 which is 42605.368761574071 as double was parsed
  777. // with format "yyyy-dd-MM HH:mm:ss" into "2016-23-51 08:51:01".
  778. DataFormatter dfUS = new DataFormatter(Locale.US);
  779. assertEquals("2016-23-08 08:51:01", dfUS.formatRawCellContents(42605.368761574071, -1, "yyyy-dd-MM HH:mm:ss"));
  780. assertEquals("2016-23 08:51:01 08", dfUS.formatRawCellContents(42605.368761574071, -1, "yyyy-dd HH:mm:ss MM"));
  781. assertEquals("2017-12-01 January 09:54:33", dfUS.formatRawCellContents(42747.412892397523, -1, "yyyy-dd-MM MMMM HH:mm:ss"));
  782. assertEquals("08", dfUS.formatRawCellContents(42605.368761574071, -1, "MM"));
  783. assertEquals("01", dfUS.formatRawCellContents(42605.368761574071, -1, "ss"));
  784. // From Excel help:
  785. /*
  786. The "m" or "mm" code must appear immediately after the "h" or"hh"
  787. code or immediately before the "ss" code; otherwise, Microsoft
  788. Excel displays the month instead of minutes."
  789. */
  790. assertEquals("08", dfUS.formatRawCellContents(42605.368761574071, -1, "mm"));
  791. assertEquals("08:51", dfUS.formatRawCellContents(42605.368761574071, -1, "hh:mm"));
  792. assertEquals("51:01", dfUS.formatRawCellContents(42605.368761574071, -1, "mm:ss"));
  793. }
  794. @Test
  795. void testDateFormattingWithLocales() {
  796. // 2017-12-01 09:54:33 which is 42747.412892397523 as double
  797. DataFormatter dfDE = new DataFormatter(Locale.GERMANY);
  798. DataFormatter dfZH = new DataFormatter(Locale.PRC);
  799. DataFormatter dfIE = new DataFormatter(new Locale("GA", "IE"));
  800. double date = 42747.412892397523;
  801. String format = "dd MMMM yyyy HH:mm:ss";
  802. assertEquals("12 Januar 2017 09:54:33", dfDE.formatRawCellContents(date, -1, format));
  803. assertEquals("12 \u4E00\u6708 2017 09:54:33", dfZH.formatRawCellContents(date, -1, format));
  804. assertEquals("12 Ean\u00E1ir 2017 09:54:33", dfIE.formatRawCellContents(date, -1, format));
  805. }
  806. /**
  807. * bug 60422 : simple number formats seem ok
  808. */
  809. @Test
  810. void testSimpleNumericFormatsInGermanyLocale() {
  811. Locale[] locales = new Locale[] {Locale.GERMANY, Locale.US, Locale.ROOT};
  812. for (Locale locale : locales) {
  813. //show that LocaleUtil has no effect on these tests
  814. LocaleUtil.setUserLocale(locale);
  815. try {
  816. char euro = '\u20AC';
  817. DataFormatter df = new DataFormatter(Locale.GERMANY);
  818. assertEquals("4,33", df.formatRawCellContents(4.33, -1, "#,##0.00"));
  819. assertEquals("1.234,33", df.formatRawCellContents(1234.333, -1, "#,##0.00"));
  820. assertEquals("-1.234,33", df.formatRawCellContents(-1234.333, -1, "#,##0.00"));
  821. assertEquals("1.234,33 " + euro, df.formatRawCellContents(1234.33, -1, "#,##0.00 " + euro));
  822. assertEquals("1.234,33 " + euro, df.formatRawCellContents(1234.33, -1, "#,##0.00 \"" + euro + "\""));
  823. } finally {
  824. LocaleUtil.resetUserLocale();
  825. }
  826. }
  827. }
  828. /**
  829. * bug 60422 : DataFormatter has issues with a specific NumberFormat in Germany default locale
  830. ≈ */
  831. @Test
  832. void testBug60422() {
  833. char euro = '\u20AC';
  834. DataFormatter df = new DataFormatter(Locale.GERMANY);
  835. String formatString = String.format(Locale.ROOT,
  836. "_-* #,##0.00\\ \"%s\"_-;\\-* #,##0.00\\ \"%s\"_-;_-* \"-\"??\\ \"%s\"_-;_-@_-",
  837. euro, euro, euro);
  838. assertEquals("4,33 " + euro, df.formatRawCellContents(4.33, 178, formatString));
  839. assertEquals("1.234,33 " + euro, df.formatRawCellContents(1234.33, 178, formatString));
  840. }
  841. @Test
  842. void testBug62839() throws IOException {
  843. try (Workbook wb = new HSSFWorkbook()) {
  844. Sheet sheet = wb.createSheet();
  845. Row row = sheet.createRow(0);
  846. Cell cell = row.createCell(0);
  847. cell.setCellFormula("FLOOR(-123,10)");
  848. DataFormatter df = new DataFormatter(Locale.GERMANY);
  849. String value = df.formatCellValue(cell, wb.getCreationHelper().createFormulaEvaluator());
  850. assertEquals("-130", value);
  851. }
  852. }
  853. /**
  854. * Bug #63292
  855. */
  856. @Test
  857. void test1904With4PartFormat() {
  858. Date date = new Date();
  859. int formatIndex = 105;
  860. String formatString1 = "[$-F400]m/d/yy h:mm:ss\\ AM/PM";
  861. String formatString4 = "[$-F400]m/d/yy h:mm:ss\\ AM/PM;[$-F400]m/d/yy h:mm:ss\\ AM/PM;_-* \"\"??_-;_-@_-";
  862. String s1900, s1904;
  863. // These two format calls return the same thing, as expected:
  864. // The assertEquals() passes with 1-part format
  865. s1900 = format(date, formatIndex, formatString1, false);
  866. s1904 = format(date, formatIndex, formatString1, true);
  867. assertEquals(s1900, s1904); // WORKS
  868. // These two format calls should return the same thing but don't:
  869. // It fails with 4-part format because the call to CellFormat ignores 'use1904Windowing'
  870. s1900 = format(date, formatIndex, formatString4, false);
  871. s1904 = format(date, formatIndex, formatString4, true);
  872. assertEquals(s1900, s1904); // FAILS before fix for #63292
  873. }
  874. private String format(Date date, int formatIndex, String formatString, boolean use1904Windowing) {
  875. DataFormatter formatter = new DataFormatter();
  876. double n = DateUtil.getExcelDate(date, use1904Windowing);
  877. return formatter.formatRawCellContents(n, formatIndex, formatString, use1904Windowing);
  878. }
  879. @Test
  880. void testConcurrentCellFormat() throws Exception {
  881. DataFormatter formatter1 = new DataFormatter();
  882. DataFormatter formatter2 = new DataFormatter();
  883. doFormatTestSequential(formatter1);
  884. doFormatTestConcurrent(formatter1, formatter2);
  885. }
  886. /**
  887. * Bug #64319
  888. *
  889. * A custom format string like TRUE shouldn't be E+
  890. * A numeric format string like 0E0 shouldn't be E+
  891. * A numeric format string like 0E+0 should be E+
  892. */
  893. @Test
  894. void testWithEinFormat() {
  895. DataFormatter formatter = new DataFormatter();
  896. // Format string literals with an E in them shouldn't be
  897. // treated as a Scientific format, so shouldn't become E+
  898. assertEquals("TRUE", formatter.formatRawCellContents(1.0, 170,
  899. "\"TRUE\";\"FALSE\";\"ZERO\""));
  900. assertEquals("ZERO", formatter.formatRawCellContents(0.0, 170,
  901. "\"TRUE\";\"FALSE\";\"ZERO\""));
  902. assertEquals("FALSE", formatter.formatRawCellContents(-1.0, 170,
  903. "\"TRUE\";\"FALSE\";\"ZERO\""));
  904. // Explicit Scientific format does need E+
  905. assertEquals("1E+05", formatter.formatRawCellContents(1e05, 170,
  906. "0E+00"));
  907. assertEquals("1E+10", formatter.formatRawCellContents(1e10, 170,
  908. "0E+00"));
  909. assertEquals("1E-10", formatter.formatRawCellContents(1e-10, 170,
  910. "0E+00"));
  911. // Large numbers with "General" need E+
  912. assertEquals("100000", formatter.formatRawCellContents(1e05, -1, "General"));
  913. assertEquals("1E+12", formatter.formatRawCellContents(1e12, -1, "General"));
  914. // Less common Scientific-like formats which don't ask for
  915. // the + on >1 exponentials don't need it adding
  916. // (Java will put the -ve ones in for E-## automatically)
  917. assertEquals("1E5", formatter.formatRawCellContents(1e05, 170,
  918. "0E0"));
  919. assertEquals("1E10", formatter.formatRawCellContents(1e10, 170,
  920. "0E0"));
  921. assertEquals("1E-10", formatter.formatRawCellContents(1e-10, 170,
  922. "0E0"));
  923. assertEquals("1E5", formatter.formatRawCellContents(1e05, 170,
  924. "0E-0"));
  925. assertEquals("1E10", formatter.formatRawCellContents(1e10, 170,
  926. "0E-0"));
  927. assertEquals("1E-10", formatter.formatRawCellContents(1e-10, 170,
  928. "0E-0"));
  929. }
  930. @Test
  931. void bug63211() {
  932. DataFormatter formatter = new DataFormatter();
  933. // https://bz.apache.org/bugzilla/show_bug.cgi?id=63211
  934. // this format is an escaped % so is not the built-in percent which treats 0.125 as 12.5%
  935. // this escaped format just appends a % to the raw decimal - so 12.5 becomes 12.5%
  936. assertEquals("12.5%",
  937. formatter.formatRawCellContents(12.5, -1, "0.0\\%;\\-0.0\\%"));
  938. assertEquals("-12.5%",
  939. formatter.formatRawCellContents(-12.5, -1, "0.0\\%;\\-0.0\\%"));
  940. }
  941. @Test
  942. void testAdjustTo4DigitYearsIfConfigured() {
  943. DataFormatter dataFormatter = new DataFormatter();
  944. assertEquals("d/m/yy", dataFormatter.adjustTo4DigitYearsIfConfigured("d/m/yy"));
  945. dataFormatter.setUse4DigitYearsInAllDateFormats(true);
  946. assertEquals("d/m/yyyy", dataFormatter.adjustTo4DigitYearsIfConfigured("d/m/yy"));
  947. assertEquals("d/m/yyyy", dataFormatter.adjustTo4DigitYearsIfConfigured("d/m/yyyy"));
  948. //fake case with 3 digit year - just leave format as is
  949. assertEquals("d/m/yyy", dataFormatter.adjustTo4DigitYearsIfConfigured("d/m/yyy"));
  950. assertEquals("yyyy-mm-dd", dataFormatter.adjustTo4DigitYearsIfConfigured("yy-mm-dd"));
  951. assertEquals("yyyy-mm-dd", dataFormatter.adjustTo4DigitYearsIfConfigured("yyyy-mm-dd"));
  952. assertEquals("m/d/yyyy h:mm", dataFormatter.adjustTo4DigitYearsIfConfigured("m/d/yy h:mm"));
  953. assertEquals("m/d/yyyy h:mm", dataFormatter.adjustTo4DigitYearsIfConfigured("m/d/yyyy h:mm"));
  954. assertEquals("h:mm:ss AM/PM", dataFormatter.adjustTo4DigitYearsIfConfigured("h:mm:ss AM/PM"));
  955. assertEquals("yyyy/mmm/dd yyyy", dataFormatter.adjustTo4DigitYearsIfConfigured("yyyy/mmm/dd yy"));
  956. assertEquals("yyyy/mmm/dd yyyy", dataFormatter.adjustTo4DigitYearsIfConfigured("yy/mmm/dd yy"));
  957. assertEquals("yyyy/mmm/dd yyyy", dataFormatter.adjustTo4DigitYearsIfConfigured("yyyy/mmm/dd yyyy"));
  958. String formatString4 = "[$-F400]m/d/yy h:mm:ss\\ AM/PM;[$-F400]m/d/yy h:mm:ss\\ AM/PM;_-* \"\"??_-;_-@_-";
  959. assertEquals(formatString4.replace("yy", "yyyy"), dataFormatter.adjustTo4DigitYearsIfConfigured(formatString4));
  960. }
  961. @Test
  962. void testDataFormatterWithAdjustTo4DigitYears() {
  963. DataFormatter dataFormatter = new DataFormatter();
  964. dataFormatter.setUse4DigitYearsInAllDateFormats(true);
  965. double date = 42747.412892397523;
  966. assertEquals("12/1/2017",
  967. dataFormatter.formatRawCellContents(date, -1, "d/m/yy"));
  968. }
  969. private void doFormatTestSequential(DataFormatter formatter) {
  970. for (int i = 0; i < 1_000; i++) {
  971. assertTrue(doFormatTest(formatter, 43551.50990171296, "3/27/19 12:14:15 PM", i));
  972. assertTrue(doFormatTest(formatter, 36104.424780092595, "11/5/98 10:11:41 AM", i));
  973. }
  974. }
  975. private void doFormatTestConcurrent(DataFormatter formatter1, DataFormatter formatter2) throws Exception {
  976. ArrayList<CompletableFuture<Boolean>> futures = new ArrayList<>();
  977. for (int i = 0; i < 1_000; i++) {
  978. final int iteration = i;
  979. CompletableFuture<Boolean> future = CompletableFuture.supplyAsync(
  980. () -> {
  981. boolean r1 = doFormatTest(formatter1, 43551.50990171296, "3/27/19 12:14:15 PM", iteration);
  982. boolean r2 = doFormatTest(formatter1, 36104.424780092595, "11/5/98 10:11:41 AM", iteration);
  983. return r1 && r2;
  984. });
  985. futures.add(future);
  986. future = CompletableFuture.supplyAsync(
  987. () -> {
  988. boolean r1 = doFormatTest(formatter2, 43551.50990171296, "3/27/19 12:14:15 PM", iteration);
  989. boolean r2 = doFormatTest(formatter2, 36104.424780092595, "11/5/98 10:11:41 AM", iteration);
  990. return r1 && r2;
  991. });
  992. futures.add(future);
  993. }
  994. for (CompletableFuture<Boolean> future : futures) {
  995. assertTrue(future.get(1, TimeUnit.MINUTES));
  996. }
  997. }
  998. private static boolean doFormatTest(DataFormatter formatter, double n, String expected, int iteration) {
  999. int formatIndex = 105;
  1000. String formatString = "[$-F400]m/d/yy h:mm:ss\\ AM/PM;[$-F400]m/d/yy h:mm:ss\\ AM/PM;_-* \"\"??_-;_-@_-";
  1001. String actual = formatter.formatRawCellContents(n, formatIndex, formatString);
  1002. assertEquals(expected, actual, "Failed on iteration " + iteration);
  1003. return true;
  1004. }
  1005. @Test
  1006. public void testFormatCellValue() throws IOException {
  1007. DataFormatter df = new DataFormatter();
  1008. assertEquals("", df.formatCellValue(null));
  1009. try (Workbook wb = new HSSFWorkbook()) {
  1010. Cell cell = wb.createSheet("test").createRow(0).createCell(0);
  1011. assertEquals("", df.formatCellValue(cell));
  1012. cell.setCellValue(123);
  1013. assertEquals("123", df.formatCellValue(cell));
  1014. /* This is flaky, likely because of timezone
  1015. cell.setCellValue(new Date(234092383));
  1016. assertEquals("25571.75107", df.formatCellValue(cell));*/
  1017. cell.setCellValue("abcdefgh");
  1018. assertEquals("abcdefgh", df.formatCellValue(cell));
  1019. cell.setCellValue(true);
  1020. assertEquals("TRUE", df.formatCellValue(cell));
  1021. CellStyle cellStyle = wb.createCellStyle();
  1022. cellStyle.setDataFormat((short)14);
  1023. cell.setCellStyle(cellStyle);
  1024. cell.setCellValue(new Date(234092383));
  1025. assertEquals("1/3/70", df.formatCellValue(cell));
  1026. /* This is flaky, likely because of timezone
  1027. cellStyle.setDataFormat((short)9999);
  1028. assertEquals("25571.751069247686", df.formatCellValue(cell));*/
  1029. }
  1030. }
  1031. }