Bug 56269 - DateFormat - Rounding of fractionals

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1592419 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/poi/ss/formula/atp/YearFracCalculator.java

@@ -317,7 +317,7 @@ final class YearFracCalculator {
 
 	private static SimpleDate createDate(int dayCount) {
 		GregorianCalendar calendar = new GregorianCalendar(UTC_TIME_ZONE);
-		DateUtil.setCalendar(calendar, dayCount, 0, false);
+		DateUtil.setCalendar(calendar, dayCount, 0, false, false);
 		return new SimpleDate(calendar);
 	}
 

src/java/org/apache/poi/ss/usermodel/DateUtil.java

@@ -185,8 +185,29 @@ public class DateUtil {
      *  @return Java representation of the date, or null if date is not a valid Excel date
      */
     public static Date getJavaDate(double date, boolean use1904windowing, TimeZone tz) {
-        return getJavaCalendar(date, use1904windowing, tz).getTime();
+        return getJavaCalendar(date, use1904windowing, tz, false).getTime();
     }
+    
+    /**
+     *  Given an Excel date with either 1900 or 1904 date windowing,
+     *  converts it to a java.util.Date.
+     *  
+     *  Excel Dates and Times are stored without any timezone 
+     *  information. If you know (through other means) that your file 
+     *  uses a different TimeZone to the system default, you can use
+     *  this version of the getJavaDate() method to handle it.
+     *   
+     *  @param date  The Excel date.
+     *  @param tz The TimeZone to evaluate the date in
+     *  @param use1904windowing  true if date uses 1904 windowing,
+     *   or false if using 1900 date windowing.
+     *  @param roundSeconds round to closest second
+     *  @return Java representation of the date, or null if date is not a valid Excel date
+     */
+    public static Date getJavaDate(double date, boolean use1904windowing, TimeZone tz, boolean roundSeconds) {
+        return getJavaCalendar(date, use1904windowing, tz, roundSeconds).getTime();
+    }
+    
     /**
      *  Given an Excel date with either 1900 or 1904 date windowing,
      *  converts it to a java.util.Date.
@@ -207,12 +228,12 @@ public class DateUtil {
      *  @see java.util.TimeZone
      */
     public static Date getJavaDate(double date, boolean use1904windowing) {
-        return getJavaCalendar(date, use1904windowing).getTime();
+        return getJavaCalendar(date, use1904windowing, null, false).getTime();
     }
 
 
     public static void setCalendar(Calendar calendar, int wholeDays,
-            int millisecondsInDay, boolean use1904windowing) {
+            int millisecondsInDay, boolean use1904windowing, boolean roundSeconds) {
         int startYear = 1900;
         int dayAdjust = -1; // Excel thinks 2/29/1900 is a valid date, which it isn't
         if (use1904windowing) {
@@ -225,10 +246,24 @@ public class DateUtil {
             dayAdjust = 0;
         }
         calendar.set(startYear,0, wholeDays + dayAdjust, 0, 0, 0);
-        calendar.set(GregorianCalendar.MILLISECOND, millisecondsInDay);
+        calendar.set(Calendar.MILLISECOND, millisecondsInDay);
+        if (roundSeconds) {
+            calendar.add(Calendar.MILLISECOND, 500);
+            calendar.clear(Calendar.MILLISECOND);
+        }
     }
 
 
+    /**
+     * Get EXCEL date as Java Calendar (with default time zone).
+     * This is like {@link #getJavaDate(double)} but returns a Calendar object.
+     *  @param date  The Excel date.
+     *  @return Java representation of the date, or null if date is not a valid Excel date
+     */
+    public static Calendar getJavaCalendar(double date) {
+        return getJavaCalendar(date, false, (TimeZone)null, false);
+    }
+
     /**
      * Get EXCEL date as Java Calendar (with default time zone).
      * This is like {@link #getJavaDate(double, boolean)} but returns a Calendar object.
@@ -238,7 +273,7 @@ public class DateUtil {
      *  @return Java representation of the date, or null if date is not a valid Excel date
      */
     public static Calendar getJavaCalendar(double date, boolean use1904windowing) {
-    	return getJavaCalendar(date, use1904windowing, (TimeZone)null);
+        return getJavaCalendar(date, use1904windowing, (TimeZone)null, false);
     }
 
     /**
@@ -251,16 +286,32 @@ public class DateUtil {
      * @return Java representation of the date in UTC, or null if date is not a valid Excel date
      */
     public static Calendar getJavaCalendarUTC(double date, boolean use1904windowing) {
-    	return getJavaCalendar(date, use1904windowing, TIMEZONE_UTC);
+    	return getJavaCalendar(date, use1904windowing, TIMEZONE_UTC, false);
     }
 
 
     /**
      * Get EXCEL date as Java Calendar with given time zone.
-     * @see #getJavaDate(double, TimeZone)
+     * @param date  The Excel date.
+     * @param use1904windowing  true if date uses 1904 windowing,
+     *  or false if using 1900 date windowing.
+     * @param timeZone The TimeZone to evaluate the date in
      * @return Java representation of the date, or null if date is not a valid Excel date
      */
     public static Calendar getJavaCalendar(double date, boolean use1904windowing, TimeZone timeZone) {
+        return getJavaCalendar(date, use1904windowing, timeZone, false);
+    }
+        
+    /**
+     * Get EXCEL date as Java Calendar with given time zone.
+     * @param date  The Excel date.
+     * @param use1904windowing  true if date uses 1904 windowing,
+     *  or false if using 1900 date windowing.
+     * @param timeZone The TimeZone to evaluate the date in
+     * @param roundSeconds round to closest second
+     * @return Java representation of the date, or null if date is not a valid Excel date
+     */
+    public static Calendar getJavaCalendar(double date, boolean use1904windowing, TimeZone timeZone, boolean roundSeconds) {
         if (!isValidExcelDate(date)) {
             return null;
         }
@@ -272,7 +323,7 @@ public class DateUtil {
         } else {
             calendar = new GregorianCalendar();     // using default time-zone
         }
-        setCalendar(calendar, wholeDays, millisecondsInDay, use1904windowing);
+        setCalendar(calendar, wholeDays, millisecondsInDay, use1904windowing, roundSeconds);
         return calendar;
     }
 
@@ -537,6 +588,7 @@ public class DateUtil {
     }
 
 
+    @SuppressWarnings("serial")
     private static final class FormatException extends Exception {
         public FormatException(String msg) {
             super(msg);

src/testcases/org/apache/poi/hssf/usermodel/TestHSSFDateUtil.java

@@ -17,15 +17,18 @@
 
 package org.apache.poi.hssf.usermodel;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
 import java.util.Calendar;
 import java.util.Date;
 import java.util.GregorianCalendar;
 import java.util.TimeZone;
 
-import junit.framework.TestCase;
-
 import org.apache.poi.hssf.HSSFTestDataSamples;
 import org.apache.poi.hssf.model.InternalWorkbook;
+import org.junit.Test;
 
 /**
  * Class TestHSSFDateUtil
@@ -37,7 +40,7 @@ import org.apache.poi.hssf.model.InternalWorkbook;
  * @author Alex Jacoby (ajacoby at gmail.com)
  * @version %I%, %G%
  */
-public final class TestHSSFDateUtil extends TestCase {
+public final class TestHSSFDateUtil {
 
     public static final int CALENDAR_JANUARY = 0;
     public static final int CALENDAR_FEBRUARY = 1;
@@ -49,8 +52,8 @@ public final class TestHSSFDateUtil extends TestCase {
     /**
      * Checks the date conversion functions in the HSSFDateUtil class.
      */
-
+    @Test
-    public void testDateConversion() {
+    public void dateConversion() {
 
         // Iteratating over the hours exposes any rounding issues.
         for (int hour = 0; hour < 23; hour++)
@@ -87,7 +90,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * Checks the conversion of a java.util.date to Excel on a day when
      * Daylight Saving Time starts.
      */
-    public void testExcelConversionOnDSTStart() {
+    @Test
+    public void excelConversionOnDSTStart() {
         TimeZone cet = TimeZone.getTimeZone("Europe/Copenhagen");
         TimeZone.setDefault(cet);
         Calendar cal = new GregorianCalendar(2004, CALENDAR_MARCH, 28);
@@ -117,7 +121,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * Checks the conversion of an Excel date to a java.util.date on a day when
      * Daylight Saving Time starts.
      */
-    public void testJavaConversionOnDSTStart() {
+    @Test
+    public void javaConversionOnDSTStart() {
         TimeZone cet = TimeZone.getTimeZone("Europe/Copenhagen");
         TimeZone.setDefault(cet);
         Calendar cal = new GregorianCalendar(2004, CALENDAR_MARCH, 28);
@@ -144,7 +149,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * Checks the conversion of a java.util.Date to Excel on a day when
      * Daylight Saving Time ends.
      */
-    public void testExcelConversionOnDSTEnd() {
+    @Test
+    public void excelConversionOnDSTEnd() {
         TimeZone cet = TimeZone.getTimeZone("Europe/Copenhagen");
         TimeZone.setDefault(cet);
         Calendar cal = new GregorianCalendar(2004, CALENDAR_OCTOBER, 31);
@@ -167,7 +173,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * Checks the conversion of an Excel date to java.util.Date on a day when
      * Daylight Saving Time ends.
      */
-    public void testJavaConversionOnDSTEnd() {
+    @Test
+    public void javaConversionOnDSTEnd() {
         TimeZone cet = TimeZone.getTimeZone("Europe/Copenhagen");
         TimeZone.setDefault(cet);
         Calendar cal = new GregorianCalendar(2004, CALENDAR_OCTOBER, 31);
@@ -186,7 +193,8 @@ public final class TestHSSFDateUtil extends TestCase {
     /**
      * Tests that we deal with time-zones properly
      */
-    public void testCalendarConversion() {
+    @Test
+    public void calendarConversion() {
         GregorianCalendar date = new GregorianCalendar(2002, 0, 1, 12, 1, 1);
         Date expected = date.getTime();
 
@@ -226,7 +234,8 @@ public final class TestHSSFDateUtil extends TestCase {
     /**
      * Tests that we correctly detect date formats as such
      */
-    public void testIdentifyDateFormats() {
+    @Test
+    public void identifyDateFormats() {
         // First up, try with a few built in date formats
         short[] builtins = new short[] { 0x0e, 0x0f, 0x10, 0x16, 0x2d, 0x2e };
         for(int i=0; i<builtins.length; i++) {
@@ -329,7 +338,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * Test that against a real, test file, we still do everything
      *  correctly
      */
-    public void testOnARealFile() {
+    @Test
+    public void onARealFile() {
 
         HSSFWorkbook workbook = HSSFTestDataSamples.openSampleWorkbook("DateFormats.xls");
         HSSFSheet sheet       = workbook.getSheetAt(0);
@@ -386,7 +396,8 @@ public final class TestHSSFDateUtil extends TestCase {
         assertTrue(HSSFDateUtil.isCellDateFormatted(cell));
     }
 
-    public void testDateBug_2Excel() {
+    @Test
+    public void dateBug_2Excel() {
         assertEquals(59.0, HSSFDateUtil.getExcelDate(createDate(1900, CALENDAR_FEBRUARY, 28), false), 0.00001);
         assertEquals(61.0, HSSFDateUtil.getExcelDate(createDate(1900, CALENDAR_MARCH, 1), false), 0.00001);
 
@@ -396,7 +407,8 @@ public final class TestHSSFDateUtil extends TestCase {
         assertEquals(38074.00, HSSFDateUtil.getExcelDate(createDate(2004, CALENDAR_MARCH, 28), false), 0.00001);
     }
 
-    public void testDateBug_2Java() {
+    @Test
+    public void dateBug_2Java() {
         assertEquals(createDate(1900, CALENDAR_FEBRUARY, 28), HSSFDateUtil.getJavaDate(59.0, false));
         assertEquals(createDate(1900, CALENDAR_MARCH, 1), HSSFDateUtil.getJavaDate(61.0, false));
 
@@ -406,7 +418,8 @@ public final class TestHSSFDateUtil extends TestCase {
         assertEquals(createDate(2004, CALENDAR_MARCH, 28), HSSFDateUtil.getJavaDate(38074.00, false));
     }
 
-    public void testDate1904() {
+    @Test
+    public void date1904() {
         assertEquals(createDate(1904, CALENDAR_JANUARY, 2), HSSFDateUtil.getJavaDate(1.0, true));
         assertEquals(createDate(1904, CALENDAR_JANUARY, 1), HSSFDateUtil.getJavaDate(0.0, true));
         assertEquals(0.0, HSSFDateUtil.getExcelDate(createDate(1904, CALENDAR_JANUARY, 1), true), 0.00001);
@@ -441,7 +454,8 @@ public final class TestHSSFDateUtil extends TestCase {
     /**
      * Check if HSSFDateUtil.getAbsoluteDay works as advertised.
      */
-    public void testAbsoluteDay() {
+    @Test
+    public void absoluteDay() {
         // 1 Jan 1900 is 1 day after 31 Dec 1899
         GregorianCalendar calendar = new GregorianCalendar(1900, 0, 1);
         assertEquals("Checking absolute day (1 Jan 1900)", 1, HSSFDateUtil.absoluteDay(calendar, false));
@@ -450,7 +464,8 @@ public final class TestHSSFDateUtil extends TestCase {
         assertEquals("Checking absolute day (1 Jan 1901)", 366, HSSFDateUtil.absoluteDay(calendar, false));
     }
 
-    public void testConvertTime() {
+    @Test
+    public void convertTime() {
 
         final double delta = 1E-7; // a couple of digits more accuracy than strictly required
         assertEquals(0.5, HSSFDateUtil.convertTime("12:00"), delta);
@@ -459,7 +474,8 @@ public final class TestHSSFDateUtil extends TestCase {
         assertEquals(0.7330440, HSSFDateUtil.convertTime("17:35:35"), delta);
     }
 
-    public void testParseDate() {
+    @Test
+    public void parseDate() {
         assertEquals(createDate(2008, Calendar.AUGUST, 3), HSSFDateUtil.parseYYYYMMDDDate("2008/08/03"));
         assertEquals(createDate(1994, Calendar.MAY, 1), HSSFDateUtil.parseYYYYMMDDDate("1994/05/01"));
     }
@@ -467,7 +483,8 @@ public final class TestHSSFDateUtil extends TestCase {
     /**
      * Ensure that date values *with* a fractional portion get the right time of day
      */
-    public void testConvertDateTime() {
+    @Test
+    public void convertDateTime() {
     	// Excel day 30000 is date 18-Feb-1982
         // 0.7 corresponds to time 16:48:00
         Date actual = HSSFDateUtil.getJavaDate(30000.7);
@@ -479,7 +496,8 @@ public final class TestHSSFDateUtil extends TestCase {
      * User reported a datetime issue in POI-2.5:
      *  Setting Cell's value to Jan 1, 1900 without a time doesn't return the same value set to
      */
-    public void testBug19172()
+    @Test
+    public void bug19172()
     {
         HSSFWorkbook workbook = new HSSFWorkbook();
         HSSFSheet sheet = workbook.createSheet();
@@ -503,10 +521,24 @@ public final class TestHSSFDateUtil extends TestCase {
      * DateUtil.isCellFormatted(Cell) should not true for a numeric cell 
      * that's formatted as ".0000"
      */
-    public void testBug54557() throws Exception {
+    @Test
+    public void bug54557() throws Exception {
        final String format = ".0000";
        boolean isDateFormat = HSSFDateUtil.isADateFormat(165, format);
        
        assertEquals(false, isDateFormat);
     }
+    
+    @Test
+    public void bug56269() throws Exception {
+        double excelFraction = 41642.45833321759d;
+        Calendar calNoRound = HSSFDateUtil.getJavaCalendar(excelFraction, false);
+        assertEquals(10, calNoRound.get(Calendar.HOUR));
+        assertEquals(59, calNoRound.get(Calendar.MINUTE));
+        assertEquals(59, calNoRound.get(Calendar.SECOND));
+        Calendar calRound = HSSFDateUtil.getJavaCalendar(excelFraction, false, null, true);
+        assertEquals(11, calRound.get(Calendar.HOUR));
+        assertEquals(0, calRound.get(Calendar.MINUTE));
+        assertEquals(0, calRound.get(Calendar.SECOND));
+    }
 }