Application: gvSIG desktop

package org.gvsig.expressionevaluator.impl.function.date;

import java.time.LocalDateTime;

import java.time.ZoneId;

import java.time.temporal.ChronoField;

import java.time.temporal.IsoFields;

import java.util.Date;

import org.apache.commons.lang3.Range;

import org.gvsig.expressionevaluator.Interpreter;

import org.gvsig.expressionevaluator.spi.AbstractFunction;

import static org.gvsig.expressionevaluator.ExpressionBuilder.FUNCTION_EXTRACT;

public class ExtractFunction extends AbstractFunction {

  public ExtractFunction() {

    super("Date", FUNCTION_EXTRACT, Range.is(2),

            "The extract function retrieves subfields such as year or hour from date/time values. source must be a value expression of type timestamp, time, or interval. (Expressions of type date are cast to timestamp and can therefore be used as well.) field is an identifier or string that selects what field to extract from the source value. The extract function returns values of type double precision. The following are valid field names:\n"

            + "\n"

            + "century (not supported)\n"

            + "\n"

            + "    The century\n"

            + "\n"

            + "    EXTRACT(CENTURY FROM TIMESTAMP '2000-12-16 12:21:13');\n"

            + "    Result: 20\n"

            + "    EXTRACT(CENTURY FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 21\n"

            + "\n"

            + "    The first century starts at 0001-01-01 00:00:00 AD, although they did not know it at the time. This definition applies to all Gregorian calendar countries. There is no century number 0, you go from -1 century to 1 century. If you disagree with this, please write your complaint to: Pope, Cathedral Saint-Peter of Roma, Vatican.\n"

            + "\n"

            + "day\n"

            + "\n"

            + "    For timestamp values, the day (of the month) field (1 - 31) ; for interval values, the number of days\n"

            + "\n"

            + "    EXTRACT(DAY FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 16\n"

            + "\n"

            + "decade (not supported)\n"

            + "\n"

            + "    The year field divided by 10\n"

            + "\n"

            + "    EXTRACT(DECADE FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 200\n"

            + "\n"

            + "dow\n"

            + "\n"

            + "    The day of the week as Sunday (0) to Saturday (6)\n"

            + "\n"

            + "    EXTRACT(DOW FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 5\n"

            + "\n"

            + "doy\n"

            + "\n"

            + "    The day of the year (1 - 365/366)\n"

            + "\n"

            + "    EXTRACT(DOY FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 47\n"

            + "\n"

            + "hour\n"

            + "\n"

            + "    The hour field (0 - 23)\n"

            + "\n"

            + "    EXTRACT(HOUR FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 20\n"

            + "\n"

            + "isodow\n"

            + "\n"

            + "    The day of the week as Monday (1) to Sunday (7)\n"

            + "\n"

            + "    EXTRACT(ISODOW FROM TIMESTAMP '2001-02-18 20:38:40');\n"

            + "    Result: 7\n"

            + "\n"

            + "    This is identical to dow except for Sunday. This matches the ISO 8601 day of the week numbering.\n"

            + "\n"

            + "isoyear (not supported)\n"

            + "\n"

            + "    The ISO 8601 week-numbering year that the date falls in (not applicable to intervals)\n"

            + "\n"

            + "    EXTRACT(ISOYEAR FROM DATE '2006-01-01');\n"

            + "    Result: 2005\n"

            + "    EXTRACT(ISOYEAR FROM DATE '2006-01-02');\n"

            + "    Result: 2006\n"

            + "\n"

            + "    Each ISO 8601 week-numbering year begins with the Monday of the week containing the 4th of January, so in early January or late December the ISO year may be different from the Gregorian year. See the week field for more information.\n"

            + "\n"

            + "\n"

            + "microseconds (not supported)\n"

            + "\n"

            + "    The seconds field, including fractional parts, multiplied by 1 000 000; note that this includes full seconds\n"

            + "\n"

            + "    EXTRACT(MICROSECONDS FROM TIME '17:12:28.5');\n"

            + "    Result: 28500000\n"

            + "\n"

            + "millennium (not supported)\n"

            + "\n"

            + "    The millennium\n"

            + "\n"

            + "    EXTRACT(MILLENNIUM FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 3\n"

            + "\n"

            + "    Years in the 1900s are in the second millennium. The third millennium started January 1, 2001.\n"

            + "\n"

            + "milliseconds\n"

            + "\n"

            + "    The seconds field, including fractional parts, multiplied by 1000. Note that this includes full seconds.\n"

            + "\n"

            + "    EXTRACT(MILLISECONDS FROM TIME '17:12:28.5');\n"

            + "    Result: 28500\n"

            + "\n"

            + "minute\n"

            + "\n"

            + "    The minutes field (0 - 59)\n"

            + "\n"

            + "    EXTRACT(MINUTE FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 38\n"

            + "\n"

            + "month\n"

            + "\n"

            + "    For timestamp values, the number of the month within the year (1 - 12) ; for interval values, the number of months, modulo 12 (0 - 11)\n"

            + "\n"

            + "    EXTRACT(MONTH FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 2\n"

            + "\n"

            + "quarter\n"

            + "\n"

            + "    The quarter of the year (1 - 4) that the date is in\n"

            + "\n"

            + "    EXTRACT(QUARTER FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 1\n"

            + "\n"

            + "second\n"

            + "\n"

            + "    The seconds field, including fractional parts (0 - 59[1])\n"

            + "\n"

            + "    EXTRACT(SECOND FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 40\n"

            + "\n"

            + "    EXTRACT(SECOND FROM TIME '17:12:28.5');\n"

            + "    Result: 28.5\n"

            + "\n"

            + "week\n"

            + "\n"

            + "    The number of the ISO 8601 week-numbering week of the year. By definition, ISO weeks start on Mondays and the first week of a year contains January 4 of that year. In other words, the first Thursday of a year is in week 1 of that year.\n"

            + "\n"

            + "    In the ISO week-numbering system, it is possible for early-January dates to be part of the 52nd or 53rd week of the previous year, and for late-December dates to be part of the first week of the next year. For example, 2005-01-01 is part of the 53rd week of year 2004, and 2006-01-01 is part of the 52nd week of year 2005, while 2012-12-31 is part of the first week of 2013. It's recommended to use the isoyear field together with week to get consistent results.\n"

            + "\n"

            + "    EXTRACT(WEEK FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 7\n"

            + "\n"

            + "year\n"

            + "\n"

            + "    The year field. Keep in mind there is no 0 AD, so subtracting BC years from AD years should be done with care.\n"

            + "\n"

            + "    EXTRACT(YEAR FROM TIMESTAMP '2001-02-16 20:38:40');\n"

            + "    Result: 2001\n"

            + "",

            "EXTRACT( {{time_field}} FROM time_expression)",

            new String[]{

              "field - ",

              "date - a string with a date"

            },

            "OBJECT",

            true

    );

  }

  @Override

  public boolean allowConstantFolding() {

    return true;

  }

  @Override

  public Object call(Interpreter interpreter, Object[] args) {

    String field = getStr(args, 0).toLowerCase();

    Date date = (Date) getObject(args, 1);

    if( date instanceof java.sql.Date ) {

      date = new Date(date.getTime());

    } else if( date instanceof java.sql.Time ) {

      date = new Date(date.getTime());

    } else if( date instanceof java.sql.Time ) {

      date = new Date(date.getTime());

    }

    LocalDateTime time = LocalDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault());

    Number r = null;

    switch(field) {

      case "day":

        r = time.getDayOfMonth();

        break;

      case "dow":

        r = date.getDay();

        break;

      case "hour":

        r = time.getHour();

        break;

      case "isodow":

        r = time.getDayOfWeek().getValue();

        break;

      case "minute":

        r = time.getMinute();

        break;

      case "month":

        r = time.getDayOfMonth();

        break;

      case "second":

        r = time.getSecond() + (time.getNano()/1000000000.0);

        break;

      case "week":

        r = time.get(ChronoField.ALIGNED_WEEK_OF_YEAR);

        break;

      case "year":

        r = time.getYear();

        break;

      case "quarter":

        r = time.get(IsoFields.QUARTER_OF_YEAR);

        break;

      case "doy":

        r = time.get(ChronoField.DAY_OF_YEAR);

        break;

      case "decade":

      case "century":

      case "isoyear":

      case "microseconds":

      case "millennium":

      case "milliseconds":

      default:

        throw new RuntimeException("field '"+field+"' not supported.");

    }

    return r;

  }

}