From af8137a6e4d7a9c26ad0c91ec6f0642fc1a196f3 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Fri, 15 May 2020 20:15:00 +0000 Subject: [github-180] Add DateValue function. Thanks to Milosz Rembisz. This closes #180 git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1877793 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/poi/ss/formula/eval/FunctionEval.java | 2 +- .../apache/poi/ss/formula/functions/DateValue.java | 135 +++++++++++++++++++++ 2 files changed, 136 insertions(+), 1 deletion(-) create mode 100644 src/java/org/apache/poi/ss/formula/functions/DateValue.java (limited to 'src/java/org') diff --git a/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java b/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java index 1f405ed45e..ad034e1a67 100644 --- a/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java +++ b/src/java/org/apache/poi/ss/formula/eval/FunctionEval.java @@ -180,7 +180,7 @@ public final class FunctionEval { retval[129] = LogicalFunction.ISBLANK; retval[130] = new T(); // 131: N - // 140: DATEVALUE + retval[140] = new DateValue(); // 141: TIMEVALUE // 142: SLN // 143: SYD diff --git a/src/java/org/apache/poi/ss/formula/functions/DateValue.java b/src/java/org/apache/poi/ss/formula/functions/DateValue.java new file mode 100644 index 0000000000..77efed657e --- /dev/null +++ b/src/java/org/apache/poi/ss/formula/functions/DateValue.java @@ -0,0 +1,135 @@ +/* ==================================================================== + 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.text.DateFormatSymbols; +import java.time.DateTimeException; +import java.time.LocalDate; +import java.util.ArrayList; +import java.util.List; +import java.util.regex.MatchResult; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.apache.poi.ss.formula.eval.BlankEval; +import org.apache.poi.ss.formula.eval.ErrorEval; +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; + +/** + * Implementation for the DATEVALUE() Excel function.

+ * + * Syntax:
+ * DATEVALUE(date_text)

+ *

+ * The DATEVALUE function converts a date that is stored as text to a serial number that Excel + * recognizes as a date. For example, the formula =DATEVALUE("1/1/2008") returns 39448, the + * serial number of the date 1/1/2008. Remember, though, that your computer's system date setting may + * cause the results of a DATEVALUE function to vary from this example + *

+ * The DATEVALUE function is helpful in cases where a worksheet contains dates in a text format + * that you want to filter, sort, or format as dates, or use in date calculations. + *

+ * To view a date serial number as a date, you must apply a date format to the cell. Find links to more + * information about displaying numbers as dates in the See Also section. + * + * @author Milosz Rembisz + */ +public class DateValue extends Fixed1ArgFunction { + + private enum Format { + YMD_DASHES("^(\\d{4})-(\\w+)-(\\d{1,2})$", "ymd"), + DMY_DASHES("^(\\d{1,2})-(\\w+)-(\\d{4})$", "dmy"), + MD_DASHES("^(\\w+)-(\\d{1,2})$", "md"), + MDY_SLASHES("^(\\w+)/(\\d{1,2})/(\\d{4})$", "mdy"), + YMD_SLASHES("^(\\d{4})/(\\w+)/(\\d{1,2})$", "ymd"), + MD_SLASHES("^(\\w+)/(\\d{1,2})$", "md"); + + private Pattern pattern; + private boolean hasYear; + private int yearIndex; + private int monthIndex; + private int dayIndex; + + Format(String patternString, String groupOrder) { + this.pattern = Pattern.compile(patternString); + this.hasYear = groupOrder.contains("y"); + if (hasYear) { + yearIndex = groupOrder.indexOf("y"); + } + monthIndex = groupOrder.indexOf("m"); + dayIndex = groupOrder.indexOf("d"); + } + + } + + @Override + public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval dateTextArg) { + try { + String dateText = OperandResolver.coerceValueToString( + OperandResolver.getSingleValue(dateTextArg, srcRowIndex, srcColumnIndex)); + + if (dateText == null || dateText.isEmpty()) { + return BlankEval.instance; + } + + for (Format format : Format.values()) { + Matcher matcher = format.pattern.matcher(dateText); + if (matcher.find()) { + MatchResult matchResult = matcher.toMatchResult(); + List groups = new ArrayList<>(); + for (int i = 1; i <= matchResult.groupCount(); ++i) { + groups.add(matchResult.group(i)); + } + int year = format.hasYear + ? Integer.valueOf(groups.get(format.yearIndex)) + : LocalDate.now().getYear(); + int month = parseMonth(groups.get(format.monthIndex)); + int day = Integer.valueOf(groups.get(format.dayIndex)); + return new NumberEval(DateUtil.getExcelDate(LocalDate.of(year, month, day))); + + } + } + } catch (DateTimeException e) { + return ErrorEval.VALUE_INVALID; + } catch (EvaluationException e) { + return e.getErrorEval(); + } + + return ErrorEval.VALUE_INVALID; + } + + private int parseMonth(String monthPart) { + try { + return Integer.valueOf(monthPart); + } catch (NumberFormatException ignored) { + } + + + String[] months = new DateFormatSymbols().getMonths(); + for (int month = 0; month < months.length; ++month) { + if (months[month].toLowerCase().startsWith(monthPart.toLowerCase())) { + return month + 1; + } + } + return -1; + } +} -- cgit v1.2.3