ca.gc.aafc.dina.datetime.ISODateTime Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dina-base-api Show documentation
Base DINA API package for Java built on SpringBoot and Crnk
The newest version!
package ca.gc.aafc.dina.datetime;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NonNull;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.Year;
import java.time.YearMonth;
import java.time.format.DateTimeParseException;
import java.util.Optional;
import java.util.regex.Pattern;

/**
 * ISO DateTime representation with support for partial dates.
 * This class is immutable.
 */
@AllArgsConstructor
@Builder
@Getter
@EqualsAndHashCode
public class ISODateTime {
  
  private static final Pattern ALL_NON_NUMERIC = Pattern.compile("[^\\d]");

  private static final byte YYYY_PRECISION = 4;
  private static final byte YYYY_MM_PRECISION = 6;
  private static final byte YYYY_MM_DD_PRECISION = 8;
  private static final byte YYYY_MM_DD_HH_MM_PRECISION = 12;
  private static final byte YYYY_MM_DD_HH_MM_SS_PRECISION = 14;
  private static final byte YYYY_MM_DD_HH_MM_SS_MMM_PRECISION = 17;

  public enum Format {
    YYYY(YYYY_PRECISION),
    YYYY_MM(YYYY_MM_PRECISION),
    YYYY_MM_DD(YYYY_MM_DD_PRECISION),
    YYYY_MM_DD_HH_MM(YYYY_MM_DD_HH_MM_PRECISION),
    YYYY_MM_DD_HH_MM_SS(YYYY_MM_DD_HH_MM_SS_PRECISION),
    YYYY_MM_DD_HH_MM_SS_MMM(YYYY_MM_DD_HH_MM_SS_MMM_PRECISION);

    private final byte precision;
    Format(byte precision) {
      this.precision = precision;
    }

    /**
     * Tries to get a {@link Format} that is matching a precision representing the number
     * of numerical digits in an ISO date.
     *
     * @param precision
     * @return
     */
    public static Optional fromPrecision(int precision) {
      switch(precision) {
        case YYYY_PRECISION : return Optional.of(YYYY);
        case YYYY_MM_PRECISION : return Optional.of(YYYY_MM);
        case YYYY_MM_DD_PRECISION : return Optional.of(YYYY_MM_DD);
        case YYYY_MM_DD_HH_MM_PRECISION: return Optional.of(YYYY_MM_DD_HH_MM);
        case YYYY_MM_DD_HH_MM_SS_PRECISION: return Optional.of(YYYY_MM_DD_HH_MM_SS);
        default:
          break;
      }

      // Consider that all precision above seconds means milliseconds
      if (precision > YYYY_MM_DD_HH_MM_SS_PRECISION) {
        return Optional.of(YYYY_MM_DD_HH_MM_SS_MMM);
      }

      return Optional.empty();
    }

    public byte getPrecision() {
      return precision;
    }

  }

  private final LocalDateTime localDateTime;
  private final Format format;

  /**
   * Tries to parse the provided date-time.
   *
   * @param dateTime date and time as string, can't be null
   * @return date time as {@link ISODateTime}
   * @throws DateTimeParseException if the provided value can't be parsed.
   */
  public static ISODateTime parse(@NonNull String dateTime) {
    int numberOfNumericChar = ALL_NON_NUMERIC
        .matcher(dateTime).replaceAll("").length();

    Format format = Format.fromPrecision(numberOfNumericChar)
        .orElseThrow(() -> new DateTimeParseException("unknown format", dateTime, 0));
    LocalDateTime parsedLocalDateTime = null;

    switch (format) {
      case YYYY:
        parsedLocalDateTime = Year.parse(dateTime).atDay(1).atStartOfDay();
        break;
      case YYYY_MM:
        parsedLocalDateTime = YearMonth.parse(dateTime).atDay(1).atStartOfDay();
        break;
      case YYYY_MM_DD:
        parsedLocalDateTime = LocalDate.parse(dateTime).atStartOfDay();
        break;
      case YYYY_MM_DD_HH_MM:
      case YYYY_MM_DD_HH_MM_SS:
      case YYYY_MM_DD_HH_MM_SS_MMM:
        parsedLocalDateTime = LocalDateTime.parse(dateTime);
        break;
      default:
        break;
    }
    return new ISODateTime(parsedLocalDateTime, format);
  }

  public String toString() {
    switch (format) {
      case YYYY:
        return Year.from(localDateTime).toString();
      case YYYY_MM:
        return YearMonth.from(localDateTime).toString();
      case YYYY_MM_DD:
        return LocalDate.from(localDateTime).toString();
      case YYYY_MM_DD_HH_MM:
      case YYYY_MM_DD_HH_MM_SS:
      case YYYY_MM_DD_HH_MM_SS_MMM:
        return localDateTime.toString();
      default:
        break;
    }
    return "";
  }

}