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

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