You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by fa...@apache.org on 2022/05/28 18:12:37 UTC

svn commit: r1901361 - in /poi/trunk/poi/src: main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java main/java/org/apache/poi/ss/formula/functions/Days.java test/java/org/apache/poi/ss/formula/functions/TestDays.java

Author: fanningpj
Date: Sat May 28 18:12:36 2022
New Revision: 1901361

URL: http://svn.apache.org/viewvc?rev=1901361&view=rev
Log:
[bug-58468] implement DAYS function

Added:
    poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java   (with props)
    poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestDays.java
      - copied, changed from r1901355, poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestStdev.java
Modified:
    poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java

Modified: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java?rev=1901361&r1=1901360&r2=1901361&view=diff
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java (original)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/atp/AnalysisToolPak.java Sat May 28 18:12:36 2022
@@ -98,6 +98,7 @@ public final class AnalysisToolPak imple
         r(m, "CUBEVALUE", null);
         r(m, "CUMIPMT", null);
         r(m, "CUMPRINC", null);
+        r(m, "DAYS", Days.instance);
         r(m, "DEC2BIN", Dec2Bin.instance);
         r(m, "DEC2HEX", Dec2Hex.instance);
         r(m, "DEC2OCT", null);

Added: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java?rev=1901361&view=auto
==============================================================================
--- poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java (added)
+++ poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java Sat May 28 18:12:36 2022
@@ -0,0 +1,93 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+package org.apache.poi.ss.formula.functions;
+
+import java.time.LocalDate;
+import java.time.temporal.ChronoUnit;
+import java.util.Date;
+
+import org.apache.poi.ss.formula.OperationEvaluationContext;
+import org.apache.poi.ss.formula.eval.EvaluationException;
+import org.apache.poi.ss.formula.eval.NumberEval;
+import org.apache.poi.ss.formula.eval.OperandResolver;
+import org.apache.poi.ss.formula.eval.ValueEval;
+import org.apache.poi.ss.usermodel.DateUtil;
+import org.apache.poi.ss.util.DateParser;
+import org.apache.poi.util.LocaleUtil;
+
+/**
+ * <p>Calculates the number of days between two dates based on a real year,
+ * which is used in some accounting calculations.</p>
+ *
+ * <p> 
+ * {@code DAYS(end_date,start_date)}
+ * 
+ * <ul>
+ * <li>Start_date, end_date (required):<br/>
+ * The two dates between which you want to know the number of days.<br/>
+ * If start_date occurs after end_date, the DAYS function returns a negative number.</li>
+ * 
+ * </ul>
+ * </p>
+ * 
+ * @see <a href="https://support.office.com/en-us/article/DAYS-function-57740535-D549-4395-8728-0F07BFF0B9DF">DAYS function - Microsoft Office</a>
+ */
+public class Days implements FreeRefFunction {
+
+    public static final Days instance = new Days();
+
+    private Days() {}
+
+    @Override
+    public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
+        return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0], args[1]);
+    }
+
+    private ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) {
+        double result;
+        try {
+            LocalDate d0 = getDate(arg0, srcRowIndex, srcColumnIndex);
+            LocalDate d1 = getDate(arg1, srcRowIndex, srcColumnIndex);
+            result = evaluate(d0, d1);
+        } catch (EvaluationException e) {
+            return e.getErrorEval();
+        }
+        return new NumberEval(result);
+    }
+
+    private static double evaluate(LocalDate endDate, LocalDate startDate) {
+        return ChronoUnit.DAYS.between(startDate, endDate);
+    }
+
+    private static LocalDate getDate(ValueEval eval, int srcRowIndex, int srcColumnIndex) throws EvaluationException {
+        ValueEval ve = OperandResolver.getSingleValue(eval, srcRowIndex, srcColumnIndex);
+        try {
+            double d0 = NumericFunction.singleOperandEvaluate(ve, srcRowIndex, srcColumnIndex);
+            return getDate(d0);
+        } catch (Exception e) {
+            String strText1 = OperandResolver.coerceValueToString(ve);
+            return DateParser.parseLocalDate(strText1);
+        }
+    }
+
+    private static LocalDate getDate(double date) {
+        Date d = DateUtil.getJavaDate(date, false);
+        return d.toInstant()
+                .atZone(LocaleUtil.getUserTimeZone().toZoneId())
+                .toLocalDate();
+    }
+}

Propchange: poi/trunk/poi/src/main/java/org/apache/poi/ss/formula/functions/Days.java
------------------------------------------------------------------------------
    svn:eol-style = native

Copied: poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestDays.java (from r1901355, poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestStdev.java)
URL: http://svn.apache.org/viewvc/poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestDays.java?p2=poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestDays.java&p1=poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestStdev.java&r1=1901355&r2=1901361&rev=1901361&view=diff
==============================================================================
--- poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestStdev.java (original)
+++ poi/trunk/poi/src/test/java/org/apache/poi/ss/formula/functions/TestDays.java Sat May 28 18:12:36 2022
@@ -21,60 +21,40 @@ import org.apache.poi.hssf.usermodel.HSS
 import org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator;
 import org.apache.poi.hssf.usermodel.HSSFSheet;
 import org.apache.poi.hssf.usermodel.HSSFWorkbook;
+import org.apache.poi.ss.usermodel.DateUtil;
+import org.apache.poi.ss.usermodel.FormulaError;
 import org.junit.jupiter.api.Test;
 
 import java.io.IOException;
+import java.time.LocalDate;
 
 import static org.apache.poi.ss.util.Utils.addRow;
 import static org.apache.poi.ss.util.Utils.assertDouble;
+import static org.apache.poi.ss.util.Utils.assertError;
 
 /**
- * Testcase for functions: STDEV(), STDEVP(), STDEV.S(), STDEV.P(), STDEVA(), STDEVPA()
+ * Testcase for DAYS() functions
  */
-public class TestStdev {
+public class TestDays {
 
-    //https://support.microsoft.com/en-us/office/stdevp-function-1f7c1c88-1bec-4422-8242-e9f7dc8bb195
-    //https://support.microsoft.com/en-us/office/stdev-p-function-6e917c05-31a0-496f-ade7-4f4e7462f285
-    //https://support.microsoft.com/en-us/office/stdev-s-function-7d69cf97-0c1f-4acf-be27-f3e83904cc23
-    //https://support.microsoft.com/en-us/office/stdeva-function-5ff38888-7ea5-48de-9a6d-11ed73b29e9d
-    //https://support.microsoft.com/en-us/office/stdevpa-function-5578d4d6-455a-4308-9991-d405afe2c28c
+    //https://support.microsoft.com/en-us/office/days-function-57740535-d549-4395-8728-0f07bff0b9df
     @Test
     void testMicrosoftExample1() throws IOException {
         try (HSSFWorkbook wb = initWorkbook1()) {
             HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
             HSSFCell cell = wb.getSheetAt(0).getRow(0).createCell(12);
-            assertDouble(fe, cell, "STDEVP(A3:A12)", 26.0545581424825, 0.00000000001);
-            assertDouble(fe, cell, "STDEV.P(A3:A12)", 26.0545581424825, 0.00000000001);
-            assertDouble(fe, cell, "STDEVPA(A3:A12)", 26.0545581424825, 0.00000000001);
-            assertDouble(fe, cell, "STDEV(A3:A12)", 27.4639157198435, 0.00000000001);
-            assertDouble(fe, cell, "STDEV.S(A3:A12)", 27.4639157198435, 0.00000000001);
-            assertDouble(fe, cell, "STDEVA(A3:A12)", 27.4639157198435, 0.00000000001);
+            assertDouble(fe, cell, "DAYS(\"15-MAR-2021\",\"1-FEB-2021\")", 42, 0.00000000001);
+            assertDouble(fe, cell, "DAYS(A2,A3)", 364, 0.00000000001);
         }
     }
 
     @Test
-    void testBooleans() throws IOException {
-        try (HSSFWorkbook wb = initWorkbook2()) {
-            HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
-            HSSFCell cell = wb.getSheetAt(0).getRow(0).createCell(12);
-            assertDouble(fe, cell, "STDEVP(A2:A7)", 3.082207001484488, 0.00000000001);
-            assertDouble(fe, cell, "STDEV.P(A2:A7)", 3.082207001484488, 0.00000000001);
-            assertDouble(fe, cell, "STDEVPA(A2:A7)", 3.975620147292188, 0.00000000001);
-            assertDouble(fe, cell, "STDEV(A2:A7)", 3.559026084010437, 0.00000000001);
-            assertDouble(fe, cell, "STDEV.S(A2:A7)", 3.559026084010437, 0.00000000001);
-            assertDouble(fe, cell, "STDEVA(A2:A7)", 4.355073669487885, 0.00000000001);
-        }
-    }
-
-    @Test
-    void testStringsWithNums() throws IOException {
-        try (HSSFWorkbook wb = initWorkbook3()) {
+    void testInvalid() throws IOException {
+        try (HSSFWorkbook wb = initWorkbook1()) {
             HSSFFormulaEvaluator fe = new HSSFFormulaEvaluator(wb);
             HSSFCell cell = wb.getSheetAt(0).getRow(0).createCell(12);
-            assertDouble(fe, cell, "STDEVA(A2:A7)", 4.546060565661952, 0.00000000001);
-            assertDouble(fe, cell, "STDEV(A2:A7)", 3.559026084010437, 0.00000000001);
-            assertDouble(fe, cell, "STDEVPA(A2:A7)", 4.149966532662911, 0.00000000001);
-            assertDouble(fe, cell, "STDEVP(A2:A7)", 3.082207001484488, 0.00000000001);
+            assertError(fe, cell, "DAYS(\"15-XYZ\",\"1-FEB-2021\")", FormulaError.VALUE);
+            assertError(fe, cell, "DAYS(\"15-MAR-2021\",\"1-XYZ\")", FormulaError.VALUE);
         }
     }
 
@@ -82,43 +62,8 @@ public class TestStdev {
         HSSFWorkbook wb = new HSSFWorkbook();
         HSSFSheet sheet = wb.createSheet();
         addRow(sheet, 0, "Data");
-        addRow(sheet, 1, "Strength");
-        addRow(sheet, 2, 1345);
-        addRow(sheet, 3, 1301);
-        addRow(sheet, 4, 1368);
-        addRow(sheet, 5, 1322);
-        addRow(sheet, 6, 1310);
-        addRow(sheet, 7, 1370);
-        addRow(sheet, 8, 1318);
-        addRow(sheet, 9, 1350);
-        addRow(sheet, 10, 1303);
-        addRow(sheet, 11, 1299);
-        return wb;
-    }
-
-    private HSSFWorkbook initWorkbook2() {
-        HSSFWorkbook wb = new HSSFWorkbook();
-        HSSFSheet sheet = wb.createSheet();
-        addRow(sheet, 0, "Data");
-        addRow(sheet, 1, 10);
-        addRow(sheet, 2, 7);
-        addRow(sheet, 3, 9);
-        addRow(sheet, 4, 2);
-        addRow(sheet, 5, true);
-        addRow(sheet, 6, false);
-        return wb;
-    }
-
-    private HSSFWorkbook initWorkbook3() {
-        HSSFWorkbook wb = new HSSFWorkbook();
-        HSSFSheet sheet = wb.createSheet();
-        addRow(sheet, 0, "Data");
-        addRow(sheet, 1, 10);
-        addRow(sheet, 2, 7);
-        addRow(sheet, 3, 9);
-        addRow(sheet, 4, 2);
-        addRow(sheet, 5, "4.5");
-        addRow(sheet, 6, "14");
+        addRow(sheet, 1, DateUtil.getExcelDate(LocalDate.parse("2021-12-31")));
+        addRow(sheet, 2, DateUtil.getExcelDate(LocalDate.parse("2021-01-01")));
         return wb;
     }
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org