CWMSVUE-634 - Updated locationId to be a CwmsId, updated DTO match to include TimeSeriesIdentifierDescriptor

Author: rma-bryson

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

@@ -36,22 +36,21 @@
 @JsonDeserialize(builder = AccessToWaterTimeSeriesIdentifier.Builder.class)
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
-public final class AccessToWaterTimeSeriesIdentifier extends CwmsDTO {
+public final class AccessToWaterTimeSeriesIdentifier extends CwmsDTOBase {
     @JsonProperty(required = true)
-    private final String locationId;
+    private final CwmsId locationId;
     @JsonProperty(required = true)
     private final TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor;
     @JsonProperty(required = true)
     private final String tsType;
 
     private AccessToWaterTimeSeriesIdentifier(Builder builder) {
-        super(builder.officeId);
         this.locationId = builder.locationId;
         this.timeSeriesIdDescriptor = builder.timeSeriesIdDescriptor;
         this.tsType = builder.tsType;
     }
 
-    public String getLocationId() {
+    public CwmsId getLocationId() {
         return locationId;
     }
 
@@ -64,12 +63,11 @@ public String getTsType() {
     }
 
     public static class Builder {
-        private String locationId;
+        private CwmsId locationId;
         private TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor;
         private String tsType;
-        private String officeId;
 
-        public Builder withLocationId(String locationId) {
+        public Builder withLocationId(CwmsId locationId) {
             this.locationId = locationId;
             return this;
         }
@@ -84,11 +82,6 @@ public Builder withTsType(String tsType) {
             return this;
         }
 
-        public Builder withOfficeId(String officeId) {
-            this.officeId = officeId;
-            return this;
-        }
-
         public AccessToWaterTimeSeriesIdentifier build() {
             return new AccessToWaterTimeSeriesIdentifier(this);
         }

cwms-data-api/src/test/java/cwms/cda/data/dto/AccessToWaterTimeSeriesIdentifierTest.java

@@ -48,14 +48,13 @@ void createAccessToWaterTimeSeriesData_allFieldsProvided_success() {
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
         AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                .withOfficeId("SWT")
-                .withLocationId("VANL")
+                .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
                 .withTimeSeriesIdDescriptor(tsDescriptor)
                 .withTsType("STAGE")
                 .build();
 
         assertAll(
-                () -> assertEquals("VANL", item.getLocationId(), "The location ID does not match the provided value"),
+                () -> 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")
         );
@@ -73,7 +72,6 @@ void createAccessToWaterTimeSeriesData_missingField_throwsFieldException() {
         assertAll(
                 () -> assertThrows(FieldException.class, () -> {
                     AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withOfficeId("SWT")
                             .withTimeSeriesIdDescriptor(tsDescriptor)
                             .withTsType("STAGE")
                             .build();
@@ -82,30 +80,19 @@ void createAccessToWaterTimeSeriesData_missingField_throwsFieldException() {
 
                 () -> assertThrows(FieldException.class, () -> {
                     AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withOfficeId("SWT")
-                            .withLocationId("VANL")
+                            .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()
-                            .withOfficeId("SWT")
-                            .withLocationId("VANL")
-                            .withTimeSeriesIdDescriptor(tsDescriptor)
-                            .build();
-                    item.validate();
-                }, "The validate method should have thrown a FieldException because the time series type is missing"),
-
-                () -> assertThrows(FieldException.class, () -> {
-                    AccessToWaterTimeSeriesIdentifier item = new AccessToWaterTimeSeriesIdentifier.Builder()
-                            .withLocationId("VANL")
+                            .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
                             .withTimeSeriesIdDescriptor(tsDescriptor)
-                            .withTsType("STAGE")
                             .build();
                     item.validate();
-                }, "The validate method should have thrown a FieldException because the office id is missing")
+                }, "The validate method should have thrown a FieldException because the time series type is missing")
         );
     }
 
@@ -119,8 +106,7 @@ void createAccessToWaterTimeSeriesData_serialize_roundtrip() {
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
         AccessToWaterTimeSeriesIdentifier data = new AccessToWaterTimeSeriesIdentifier.Builder()
-                .withOfficeId("SWT")
-                .withLocationId("VANL")
+                .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
                 .withTimeSeriesIdDescriptor(tsDescriptor)
                 .withTsType("STAGE")
                 .build();
@@ -141,8 +127,7 @@ void createAccessToWaterTimeSeriesData_deserialize() throws Exception {
                 .withZoneId(ZoneId.of("UTC"))
                 .build();
         AccessToWaterTimeSeriesIdentifier expected = new AccessToWaterTimeSeriesIdentifier.Builder()
-                .withOfficeId("SWT")
-                .withLocationId("VANL")
+                .withLocationId(CwmsId.buildCwmsId("SWT", "VANL"))
                 .withTimeSeriesIdDescriptor(tsDescriptor)
                 .withTsType("STAGE")
                 .build();

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

@@ -607,11 +607,17 @@ public static void assertMatch(AccessToWaterTimeSeriesIdentifier first, AccessTo
         assertAll(
                 () -> assertMatch(first.getTimeSeriesIdDescriptor(), second.getTimeSeriesIdDescriptor()),
                 () -> assertEquals(first.getTsType(), second.getTsType()),
-                () -> assertEquals(first.getLocationId(), second.getLocationId())
+                () -> assertMatch(first.getLocationId(), second.getLocationId())
         );
     }
 
     public static void assertMatch(TimeSeriesIdentifierDescriptor tsDescriptor, TimeSeriesIdentifierDescriptor timeSeriesIdDescriptor) {
+        assertAll(
+                () -> assertEquals(tsDescriptor.getIntervalOffsetMinutes(), timeSeriesIdDescriptor.getIntervalOffsetMinutes(), "Identifier does not match"),
+                () -> assertEquals(tsDescriptor.getTimeSeriesId(), timeSeriesIdDescriptor.getTimeSeriesId(), "Part does not match"),
+                () -> assertEquals(tsDescriptor.getOfficeId(), timeSeriesIdDescriptor.getOfficeId(), "Time series type does not match"),
+                () -> assertEquals(tsDescriptor.getTimezoneName(), timeSeriesIdDescriptor.getTimezoneName(), "Office ID does not match")
+        );
     }
 
     @FunctionalInterface

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

@@ -1,6 +1,8 @@
 {
-  "office-id":"SWT",
-  "location-id": "VANL",
+  "location-id": {
+    "name": "VANL",
+    "office-id":"SWT"
+  },
   "time-series-id-descriptor": {
     "office-id": "SWT",
     "time-series-id": "VANL.Stage.Inst.15Minutes.0.Ccp-Rev",