CWMSVUE-634 - Updated name to TypeTimeSeriesIdentifiers. Made dto represent mapping of location id to mapping of ts-type to ts-id.

Author: rma-bryson

…o/AccessToWaterTimeSeriesIdentifier.java …data/dto/TypedTimeSeriesIdentifiers.javacwms-data-api/src/main/java/cwms/cda/data/dto/AccessToWaterTimeSeriesIdentifier.java renamed to cwms-data-api/src/main/java/cwms/cda/data/dto/TypedTimeSeriesIdentifiers.java cwms-data-api/src/main/java/cwms/cda/data/dto/AccessToWaterTimeSeriesIdentifier.java renamed to cwms-data-api/src/main/java/cwms/cda/data/dto/TypedTimeSeriesIdentifiers.java

@@ -23,68 +23,64 @@
  */
 package cwms.cda.data.dto;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.PropertyNamingStrategies;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonNaming;
+
 import cwms.cda.formatters.Formats;
 import cwms.cda.formatters.annotations.FormattableWith;
 import cwms.cda.formatters.json.JsonV1;
+import java.util.HashMap;
+import java.util.Map;
 
-@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class, aliases = {Formats.JSON, Formats.DEFAULT})
-@JsonDeserialize(builder = AccessToWaterTimeSeriesIdentifier.Builder.class)
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class, aliases = {Formats.DEFAULT, Formats.JSON})
+@JsonDeserialize(builder = TypedTimeSeriesIdentifiers.Builder.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
-public final class AccessToWaterTimeSeriesIdentifier extends CwmsDTOBase {
+public final class TypedTimeSeriesIdentifiers extends CwmsDTOBase {
     @JsonProperty(required = true)
     private final CwmsId locationId;
-    @JsonProperty(required = true)
-    private final TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor;
-    @JsonProperty(required = true)
-    private final String tsType;
 
-    private AccessToWaterTimeSeriesIdentifier(Builder builder) {
+    private final Map<String, TimeSeriesIdentifierDescriptor> typeToTsIdMap;
+
+    private TypedTimeSeriesIdentifiers(Builder builder) {
         this.locationId = builder.locationId;
-        this.timeSeriesIdDescriptor = builder.timeSeriesIdDescriptor;
-        this.tsType = builder.tsType;
+        this.typeToTsIdMap = builder.typeToTsIdMap;
     }
 
     public CwmsId getLocationId() {
         return locationId;
     }
 
-    public TimeSeriesIdentifierDescriptor getTimeSeriesIdDescriptor() {
-        return timeSeriesIdDescriptor;
-    }
-
-    public String getTsType() {
-        return tsType;
+    public Map<String, TimeSeriesIdentifierDescriptor> getTypeToTsIdMap() {
+        return typeToTsIdMap;
     }
 
     public static class Builder {
         private CwmsId locationId;
-        private TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor;
-        private String tsType;
+        private Map<String, TimeSeriesIdentifierDescriptor> typeToTsIdMap = new HashMap<>();
 
         public Builder withLocationId(CwmsId locationId) {
             this.locationId = locationId;
             return this;
         }
 
-        public Builder withTimeSeriesIdDescriptor(TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor) {
-            this.timeSeriesIdDescriptor = timeSeriesIdDescriptor;
+        public Builder withTypeToTsIdMap(Map<String, TimeSeriesIdentifierDescriptor> typeToTsIdMap) {
+            this.typeToTsIdMap = typeToTsIdMap;
             return this;
         }
 
-        public Builder withTsType(String tsType) {
-            this.tsType = tsType;
+        @JsonIgnore
+        public Builder withTypeToTsId(String type, TimeSeriesIdentifierDescriptor tsId) {
+            this.typeToTsIdMap.put(type, tsId);
             return this;
         }
 
-        public AccessToWaterTimeSeriesIdentifier build() {
-            return new AccessToWaterTimeSeriesIdentifier(this);
+        public TypedTimeSeriesIdentifiers build() {
+            return new TypedTimeSeriesIdentifiers(this);
         }
-
     }
 }

cwms-data-api/src/main/java/cwms/cda/data/dto/TypedTimeSeriesIdentifiersList.java

@@ -0,0 +1,88 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package cwms.cda.data.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import cwms.cda.formatters.Formats;
+import cwms.cda.formatters.annotations.FormattableWith;
+import cwms.cda.formatters.json.JsonV1;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
+@JsonDeserialize(builder = TypedTimeSeriesIdentifiersList.Builder.class)
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class, aliases = {Formats.DEFAULT, Formats.JSON})
+public class TypedTimeSeriesIdentifiersList extends CwmsDTOPaginated {
+
+    private final List<TypedTimeSeriesIdentifiers> typedTimeSeriesIdentifiers;
+    private final int offset;
+
+    private TypedTimeSeriesIdentifiersList(int offset, int pageSize, Integer total, List<TypedTimeSeriesIdentifiers> identifiersList) {
+        super(Integer.toString(offset), pageSize, total);
+        this.typedTimeSeriesIdentifiers = new ArrayList<>(identifiersList);
+        this.offset = offset;
+    }
+
+    public List<TypedTimeSeriesIdentifiers> getTypedTimeSeriesIdentifiers() {
+        return Collections.unmodifiableList(typedTimeSeriesIdentifiers);
+    }
+
+    public static class Builder {
+        private final int offset;
+        private final int pageSize;
+        private final Integer total;
+
+        private List<TypedTimeSeriesIdentifiers> typedTimeSeriesIdentifiers = new ArrayList<>();
+
+        public Builder(int offset, int pageSize, Integer total) {
+            this.offset = offset;
+            this.pageSize = pageSize;
+            this.total = total;
+        }
+
+        public Builder withTypedTimeSeriesIdentifiers(Collection<TypedTimeSeriesIdentifiers> identifiersList) {
+            this.typedTimeSeriesIdentifiers = new ArrayList<>(identifiersList);
+            return this;
+        }
+
+        public TypedTimeSeriesIdentifiersList build() {
+            TypedTimeSeriesIdentifiersList retval = new TypedTimeSeriesIdentifiersList(offset, pageSize, total, typedTimeSeriesIdentifiers);
+
+            if (this.typedTimeSeriesIdentifiers.size() == this.pageSize) {
+                String cursor = Integer.toString(retval.offset + retval.typedTimeSeriesIdentifiers.size());
+                retval.nextPage = encodeCursor(cursor, retval.pageSize, retval.total);
+            } else {
+                retval.nextPage = null;
+            }
+            return retval;
+        }
+    }
+}

…cessToWaterTimeSeriesIdentifierTest.java …a/dto/TypedTimeSeriesIdentifierTest.javacwms-data-api/src/test/java/cwms/cda/data/dto/AccessToWaterTimeSeriesIdentifierTest.java renamed to cwms-data-api/src/test/java/cwms/cda/data/dto/TypedTimeSeriesIdentifierTest.java cwms-data-api/src/test/java/cwms/cda/data/dto/AccessToWaterTimeSeriesIdentifierTest.java renamed to cwms-data-api/src/test/java/cwms/cda/data/dto/TypedTimeSeriesIdentifierTest.java

@@ -25,6 +25,8 @@
 package cwms.cda.data.dto;
 
 import java.time.ZoneId;
+import java.util.HashMap;
+import java.util.Map;
 import static org.junit.jupiter.api.Assertions.*;
 
 import cwms.cda.api.errors.FieldException;
@@ -36,7 +38,7 @@
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.Test;
 
-final class AccessToWaterTimeSeriesIdentifierTest {
+final class TypedTimeSeriesIdentifierTest {
 
     @Test
     void createAccessToWaterTimeSeriesData_allFieldsProvided_success() {
@@ -47,16 +49,23 @@ void createAccessToWaterTimeSeriesData_allFieldsProvided_success() {
                 .withIntervalOffsetMinutes(0L)
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
-        AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
+        TimeSeriesIdentifierDescriptor tsDescriptor2 = new TimeSeriesIdentifierDescriptor.Builder()
+                .withTimeSeriesId("VANL.Flow.Inst.15Minutes.0.Ccp-Rev")
+                .withOfficeId("SWT")
+                .withActive(true)
+                .withIntervalOffsetMinutes(0L)
+                .withZoneId(ZoneId.of("UTC"))
+                .build();
+        TypedTimeSeriesIdentifiers items = new TypedTimeSeriesIdentifiers.Builder()
                 .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
-                .withTimeSeriesIdDescriptor(tsDescriptor)
-                .withTsType("STAGE")
+                .withTypeToTsId("STAGE", tsDescriptor)
+                .withTypeToTsId("OUTFLOW", tsDescriptor2)
                 .build();
 
         assertAll(
-                () -> DTOMatch.assertMatch(CwmsId.buildCwmsId("SWT", "VANL"), item.getLocationId(), "The location ID does not match the provided value"),
-                () -> DTOMatch.assertMatch(tsDescriptor, item.getTimeSeriesIdDescriptor()),
-                () -> assertEquals("STAGE", item.getTsType(), "The time series type does not match the provided value")
+                () -> DTOMatch.assertMatch(CwmsId.buildCwmsId("SWT", "VANL"), items.getLocationId(), "Location ID"),
+                () -> DTOMatch.assertMatch(tsDescriptor, items.getTypeToTsIdMap().get("STAGE")),
+                () -> DTOMatch.assertMatch(tsDescriptor2, items.getTypeToTsIdMap().get("OUTFLOW"))
         );
     }
 
@@ -69,30 +78,15 @@ void createAccessToWaterTimeSeriesData_missingField_throwsFieldException() {
                 .withIntervalOffsetMinutes(0L)
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
+        Map<String, TimeSeriesIdentifierDescriptor> typeToTsIdMap = new HashMap<>();
+        typeToTsIdMap.put("STAGE", tsDescriptor);
         assertAll(
                 () -> assertThrows(FieldException.class, () -> {
-                    AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withTimeSeriesIdDescriptor(tsDescriptor)
-                            .withTsType("STAGE")
-                            .build();
-                    item.validate();
-                }, "The validate method should have thrown a FieldException because the location ID is missing"),
-
-                () -> assertThrows(FieldException.class, () -> {
-                    AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
-                            .withTsType("STAGE")
-                            .build();
-                    item.validate();
-                }, "The validate method should have thrown a FieldException because the TimeSeries ID is missing"),
-
-                () -> assertThrows(FieldException.class, () -> {
-                    AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
-                            .withTimeSeriesIdDescriptor(tsDescriptor)
+                    TypedTimeSeriesIdentifiers item = new TypedTimeSeriesIdentifiers.Builder()
+                            .withTypeToTsIdMap(typeToTsIdMap)
                             .build();
                     item.validate();
-                }, "The validate method should have thrown a FieldException because the time series type is missing")
+                }, "The validate method should have thrown a FieldException because the location ID is missing")
         );
     }
 
@@ -105,15 +99,14 @@ void createAccessToWaterTimeSeriesData_serialize_roundtrip() {
                 .withIntervalOffsetMinutes(0L)
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
-        AccessToWaterTimeSeriesIdentifier data = new AccessToWaterTimeSeriesIdentifier.Builder()
+        TypedTimeSeriesIdentifiers data = new TypedTimeSeriesIdentifiers.Builder()
                 .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
-                .withTimeSeriesIdDescriptor(tsDescriptor)
-                .withTsType("STAGE")
+                .withTypeToTsId("STAGE", tsDescriptor)
                 .build();
 
         ContentType contentType = new ContentType(Formats.JSON);
         String json = Formats.format(contentType, data);
-        AccessToWaterTimeSeriesIdentifier deserialized = Formats.parseContent(contentType, json, AccessToWaterTimeSeriesIdentifier.class);
+        TypedTimeSeriesIdentifiers deserialized = Formats.parseContent(contentType, json, TypedTimeSeriesIdentifiers.class);
         DTOMatch.assertMatch(data, deserialized);
     }
 
@@ -126,17 +119,16 @@ void createAccessToWaterTimeSeriesData_deserialize() throws Exception {
                 .withIntervalOffsetMinutes(0L)
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
-        AccessToWaterTimeSeriesIdentifier expected = new AccessToWaterTimeSeriesIdentifier.Builder()
+        TypedTimeSeriesIdentifiers expected = new TypedTimeSeriesIdentifiers.Builder()
                 .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
-                .withTimeSeriesIdDescriptor(tsDescriptor)
-                .withTsType("STAGE")
+                .withTypeToTsId("STAGE", tsDescriptor)
                 .build();
 
-        InputStream resource = this.getClass().getResourceAsStream("/cwms/cda/data/dto/access_to_water_time_series_data.json");
+        InputStream resource = this.getClass().getResourceAsStream("/cwms/cda/data/dto/typed_time_series_identifiers.json");
         assertNotNull(resource);
         String json = IOUtils.toString(resource, StandardCharsets.UTF_8);
         ContentType contentType = new ContentType(Formats.JSON);
-        AccessToWaterTimeSeriesIdentifier deserialized = Formats.parseContent(contentType, json, AccessToWaterTimeSeriesIdentifier.class);
+        TypedTimeSeriesIdentifiers deserialized = Formats.parseContent(contentType, json, TypedTimeSeriesIdentifiers.class);
         DTOMatch.assertMatch(expected, deserialized);
     }
 }

cwms-data-api/src/test/java/cwms/cda/helpers/DTOMatch.java

@@ -24,11 +24,12 @@
 
 package cwms.cda.helpers;
 
-import cwms.cda.data.dto.AccessToWaterTimeSeriesIdentifier;
 import cwms.cda.data.dto.CwmsIdTimeExtentsEntry;
 import cwms.cda.data.dto.TimeExtents;
 import cwms.cda.data.dto.TimeSeriesExtents;
 import cwms.cda.data.dto.TimeSeriesIdentifierDescriptor;
+import cwms.cda.data.dto.TypedTimeSeriesIdentifiers;
+import cwms.cda.data.dto.TypedTimeSeriesIdentifiersList;
 import cwms.cda.data.dto.location.kind.Lock;
 import cwms.cda.data.dto.CwmsDTOBase;
 import cwms.cda.data.dto.location.kind.GateChange;
@@ -603,14 +604,6 @@ public static void assertMatch(CwmsIdTimeExtentsEntry first, CwmsIdTimeExtentsEn
         );
     }
 
-    public static void assertMatch(AccessToWaterTimeSeriesIdentifier first, AccessToWaterTimeSeriesIdentifier second) {
-        assertAll(
-                () -> assertMatch(first.getTimeSeriesIdDescriptor(), second.getTimeSeriesIdDescriptor()),
-                () -> assertEquals(first.getTsType(), second.getTsType()),
-                () -> assertMatch(first.getLocationId(), second.getLocationId())
-        );
-    }
-
     public static void assertMatch(TimeSeriesIdentifierDescriptor tsDescriptor, TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor) {
         assertAll(
                 () -> assertEquals(tsDescriptor.getIntervalOffsetMinutes(), timeSeriesIdDescriptor.getIntervalOffsetMinutes(), "Identifier does not match"),
@@ -620,6 +613,20 @@ public static void assertMatch(TimeSeriesIdentifierDescriptor tsDescriptor, Time
         );
     }
 
+    public static void assertMatch(TypedTimeSeriesIdentifiers first, TypedTimeSeriesIdentifiers second)
+    {
+        assertAll(
+                () -> assertMatch(first.getLocationId(), second.getLocationId()),
+                () -> assertEquals(first.getTypeToTsIdMap().size(), second.getTypeToTsIdMap().size(), "Type to TS ID map sizes do not match"),
+                () -> first.getTypeToTsIdMap().forEach((type, tsId) -> {
+                    if (!second.getTypeToTsIdMap().containsKey(type)) {
+                        fail("tsType " + type + " not found in both tsType to tsId maps");
+                    }
+                    assertMatch(tsId, second.getTypeToTsIdMap().get(type));
+                })
+        );
+    }
+
     @FunctionalInterface
     public interface AssertMatchMethod<T>{
         void assertMatch(T first, T second);

cwms-data-api/src/test/resources/cwms/cda/data/dto/access_to_water_time_series_data.json

@@ -0,0 +1,15 @@
+{
+  "location-id": {
+    "name": "VANL",
+    "office-id": "SWT"
+  },
+  "type-to-ts-id-map": {
+    "STAGE": {
+      "office-id": "SWT",
+      "time-series-id": "VANL.Stage.Inst.15Minutes.0.Ccp-Rev",
+      "timezone-name": "UTC",
+      "interval-offset-minutes": 0,
+      "active": true
+    }
+  }
+}