Fixes #634 - Implemented data entry date option for TS data retrieval

cwms-data-api/src/main/java/cwms/cda/api/TimeSeriesController.java

@@ -67,7 +67,6 @@
 import io.javalin.plugin.openapi.annotations.OpenApiParam;
 import io.javalin.plugin.openapi.annotations.OpenApiRequestBody;
 import io.javalin.plugin.openapi.annotations.OpenApiResponse;
-import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 import java.net.URLEncoder;
 import java.nio.charset.StandardCharsets;
@@ -84,7 +83,7 @@
 
 public class TimeSeriesController implements CrudHandler {
     private static final Logger logger = Logger.getLogger(TimeSeriesController.class.getName());
-
+    private static final String INCLUDE_ENTRY_DATE = "include-entry-date";
     public static final String TAG = "TimeSeries";
     public static final String STORE_RULE_DESC = "The business rule to use "
             + "when merging the incoming with existing data\n"
@@ -204,7 +203,7 @@ public void create(@NotNull Context ctx) {
             TimeSeries timeSeries = deserializeTimeSeries(ctx);
             dao.create(timeSeries, createAsLrts, storeRule, overrideProtection);
             ctx.status(HttpServletResponse.SC_OK);
-        } catch (IOException | DataAccessException ex) {
+        } catch (DataAccessException ex) {
             CdaError re = new CdaError("Internal Error");
             logger.log(Level.SEVERE, re.toString(), ex);
             ctx.status(HttpServletResponse.SC_INTERNAL_SERVER_ERROR).json(re);
@@ -382,6 +381,8 @@ public void delete(@NotNull Context ctx, @NotNull String timeseries) {
                         + "\n* `xml`"
                         + "\n* `wml2` (only if name field is specified)"
                         + "\n* `json` (default)"),
+                @OpenApiParam(name = INCLUDE_ENTRY_DATE, type = Boolean.class, description = "Specifies "
+                    + "whether to include the data entry date in the response.  Default is false."),
                 @OpenApiParam(name = PAGE, description = "This end point can return large amounts "
                         + "of data as a series of pages. This parameter is used to describes the "
                         + "current location in the response stream.  This is an opaque "
@@ -431,6 +432,9 @@ public void getAll(@NotNull Context ctx) {
 
             ZonedDateTime versionDate = queryParamAsZdt(ctx, VERSION_DATE);
 
+            boolean includeEntryDate = ctx.queryParamAsClass(INCLUDE_ENTRY_DATE, Boolean.class)
+                    .getOrDefault(false);
+
             // The following parameters are only used for jsonv2 and xmlv2
             String cursor = queryParamAsClass(ctx, new String[]{PAGE, CURSOR},
                     String.class, "", metrics, name(TimeSeriesController.class.getName(),
@@ -463,7 +467,7 @@ public void getAll(@NotNull Context ctx) {
 
                 String office = requiredParam(ctx, OFFICE);
                 TimeSeries ts = dao.getTimeseries(cursor, pageSize, names, office, unit,
-                        beginZdt, endZdt, versionDate, trim.getOrDefault(true));
+                        beginZdt, endZdt, versionDate, trim.getOrDefault(true), includeEntryDate);
 
                 results = Formats.format(contentType, ts);
 
@@ -573,14 +577,14 @@ public void update(@NotNull Context ctx, @NotNull String id) {
             dao.store(timeSeries, createAsLrts, storeRule, overrideProtection);
 
             ctx.status(HttpServletResponse.SC_OK);
-        } catch (IOException | DataAccessException ex) {
+        } catch (DataAccessException ex) {
             CdaError re = new CdaError("Internal Error");
             logger.log(Level.SEVERE, re.toString(), ex);
             ctx.status(HttpServletResponse.SC_INTERNAL_SERVER_ERROR).json(re);
         }
     }
 
-    private TimeSeries deserializeTimeSeries(Context ctx) throws IOException {
+    private TimeSeries deserializeTimeSeries(Context ctx) {
         String contentTypeHeader = ctx.req.getContentType();
         ContentType contentType = Formats.parseHeader(contentTypeHeader, TimeSeries.class);
         return Formats.parseContent(contentType, ctx.bodyAsInputStream(), TimeSeries.class);

cwms-data-api/src/main/java/cwms/cda/data/dao/LocationLevelsDaoImpl.java

@@ -62,7 +62,6 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
-import java.util.TimeZone;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
@@ -242,13 +241,12 @@ private static SEASONAL_VALUE_TAB_T getSeasonalValues(LocationLevel locationLeve
         List<SeasonalValueBean> seasonalValues = locationLevel.getSeasonalValues();
 
         SEASONAL_VALUE_TAB_T pSeasonalValues = null;
-        if(seasonalValues != null && !seasonalValues.isEmpty()) {
+        if (seasonalValues != null && !seasonalValues.isEmpty()) {
             pSeasonalValues = new SEASONAL_VALUE_TAB_T();
-            for(SeasonalValueBean seasonalValue : seasonalValues)
-            {
+            for (SeasonalValueBean seasonalValue : seasonalValues) {
                 SEASONAL_VALUE_T seasonalValueT = new SEASONAL_VALUE_T();
                 seasonalValueT.setOFFSET_MINUTES(toBigDecimal(seasonalValue.getOffsetMinutes()));
-                if(seasonalValue.getOffsetMonths() != null) {
+                if (seasonalValue.getOffsetMonths() != null) {
                     seasonalValueT.setOFFSET_MONTHS(seasonalValue.getOffsetMonths().byteValue());
                 }
                 seasonalValueT.setVALUE(toBigDecimal(seasonalValue.getValue()));
@@ -469,7 +467,7 @@ private void addSeasonalValue(Record r,
             String calOffset = r.get(view.CALENDAR_OFFSET);
             String timeOffset = r.get(view.TIME_OFFSET);
             JDomSeasonalIntervalImpl newSeasonalOffset = buildSeasonalOffset(calOffset, timeOffset);
-            SeasonalValueBean seasonalValue = buildSeasonalValueBean(seasonalLevel, newSeasonalOffset) ;
+            SeasonalValueBean seasonalValue = buildSeasonalValueBean(seasonalLevel, newSeasonalOffset);
             builder.withSeasonalValue(seasonalValue);
         }
     }

cwms-data-api/src/main/java/cwms/cda/data/dao/TimeSeriesDao.java

@@ -27,7 +27,7 @@ void store(TimeSeries timeSeries, boolean createAsLrts,
 
     TimeSeries getTimeseries(String cursor, int pageSize, String names, String office,
                              String unit, ZonedDateTime begin, ZonedDateTime end,
-                             ZonedDateTime versionDate, boolean trim);
+                             ZonedDateTime versionDate, boolean trim, boolean includeEntryDate);
 
     String getTimeseries(String format, String names, String office, String unit, String datum,
                          ZonedDateTime begin, ZonedDateTime end, ZoneId timezone);