Cleanup TODOs, tweak avro docs.

Author: zebdelk

schemas-analyze/src/main/java/org/cedar/schemas/analyze/DateInfo.java

@@ -28,14 +28,14 @@ public class DateInfo implements Comparable<DateInfo> {
   public final String utcDateTimeString;
   public final String endUtcDateTimeString;
   public final Long year;
-  public Integer dayOfYear; // values 1 - 366 // TODO temp remove final from these fields, just to sanity check things
-  public Integer dayOfMonth; // values 1 - 31
-  public Integer month; // values 1 - 12
+  public final Integer dayOfYear; // values 1 - 366
+  public final Integer dayOfMonth; // values 1 - 31
+  public final Integer month; // values 1 - 12
 
-  // special stuff for dealing with how we interpret year or month precision instants:
-  public Integer endDayOfYear;
-  public Integer endDayOfMonth;
-  public Integer endMonth;
+  // special stuff for dealing with how we interpret range, including instants with year or month precision instants:
+  public final Integer endDayOfYear; // values 1 - 366
+  public final Integer endDayOfMonth; // values 1 - 31
+  public final Integer endMonth; // values 1 - 12
 
   public DateInfo(String dateString, boolean start) {
     if (dateString == null || dateString.length() == 0) {
@@ -49,6 +49,9 @@ public DateInfo(String dateString, boolean start) {
       dayOfYear = null;
       dayOfMonth = null;
       month = null;
+      endDayOfYear = null;
+      endDayOfMonth = null;
+      endMonth = null;
       return;
     }
 
@@ -61,30 +64,30 @@ public DateInfo(String dateString, boolean start) {
     } else {
       year = (long) yearValue;
     }
-    dayOfYear = extractField(parsedDate, ChronoField.DAY_OF_YEAR);
-    dayOfMonth = extractField(parsedDate, ChronoField.DAY_OF_MONTH);
-    month = extractField(parsedDate, ChronoField.MONTH_OF_YEAR);
-    if (parsedDate != null && dayOfMonth == null && month != null) { // TODO or parsedDate instanceof YearMonth
+    Integer dayOfYearValue = extractField(parsedDate, ChronoField.DAY_OF_YEAR);
+    Integer dayOfMonthValue = extractField(parsedDate, ChronoField.DAY_OF_MONTH);
+    Integer monthValue = extractField(parsedDate, ChronoField.MONTH_OF_YEAR);
+    if (parsedDate instanceof YearMonth) {
+      month = monthValue;
       endMonth = month;
       dayOfMonth = 1;
       endDayOfMonth = ((YearMonth)parsedDate).lengthOfMonth();
       dayOfYear = ((YearMonth)parsedDate).atDay(1).getDayOfYear();
       endDayOfYear = ((YearMonth)parsedDate).atEndOfMonth().getDayOfYear();
-      // endUtcDateTimeString = utcDateTimeString(((YearMonth)parsedDate).atEndOfMonth(), false);
-    } else if (parsedDate != null && month == null && year != null) { // TODO or instanceof Year?
+    } else if (parsedDate instanceof Year) {
       dayOfMonth = 1;
       dayOfYear = 1;
       endDayOfYear = ((Year)parsedDate).length(); // number of days in the year, including leap years
       endDayOfMonth = 31;
       month = 1;
       endMonth = 12;
-
-      // endUtcDateTimeString = utcDateTimeString(((Year)parsedDate).atDay(endDayOfYear), false);
     } else {
+      dayOfYear = dayOfYearValue;
+      dayOfMonth = dayOfMonthValue;
+      month = monthValue;
       endMonth = month;
       endDayOfMonth = dayOfMonth;
       endDayOfYear = dayOfYear;
-      // endUtcDateTimeString = utcDateTimeString;
     }
 
     if (longDate != null && !indexable(longDate)) {

schemas-core/src/main/resources/avro/psi/analysis.avsc

@@ -495,7 +495,7 @@
                 "string"
               ],
               "default": null,
-              "doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the analyzed instant value. If instantPrecision does not include time, day, or month, the value is the assumed date time the instant ends, e.g. the last day of a month or year"
+              "doc": "If possible, a full ISO-8601 formatted date time string in the UTC time zone for the end analyzed instant value. The actual or assumed end date time based on precision of original data"
             },
             {
               "name": "instantYear",
@@ -522,7 +522,7 @@
                 "int"
               ],
               "default": null,
-              "doc": "If instantPrecision does not include day, an integer indicating the assumed day of year the instant ends, e.g. the last day of a month or year"
+              "doc": "An integer indicating the actual or assumed day of year the instant ends depending on the precision of the original content, e.g. the last day of a month or year."
             },
             {
               "name": "instantDayOfMonth",
@@ -540,7 +540,7 @@
                 "int"
               ],
               "default": null,
-              "doc": "If instantPrecision does not include day, an integer indicating the assumed day of month the instant ends, e.g. the last day of a month or year"
+              "doc": "An integer indicating the actual or assumed day of month the instant ends depending on precision, e.g. the last day of a month or year"
             },
             {
               "name": "instantMonth",