Water Supply Accounting DTO

cwms-data-api/src/main/java/cwms/cda/data/dto/watersupply/PumpAccounting.java

@@ -0,0 +1,113 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 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.watersupply;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import cwms.cda.data.dto.CwmsDTOBase;
+import cwms.cda.data.dto.CwmsId;
+import cwms.cda.data.dto.LookupType;
+import java.time.Instant;
+
+
+@JsonDeserialize(builder = PumpAccounting.Builder.class)
+public final class PumpAccounting extends CwmsDTOBase {
+    @JsonProperty(required = true)
+    private final CwmsId pumpLocation;
+    @JsonProperty(required = true)
+    private final LookupType transferType;
+    @JsonProperty(required = true)
+    private final Double flow;
+    @JsonProperty(required = true)
+    private final Instant transferDate;
+    private final String comment;
+
+    private PumpAccounting(Builder builder) {
+        this.pumpLocation = builder.pumpLocation;
+        this.transferType = builder.transferType;
+        this.flow = builder.flow;
+        this.transferDate = builder.transferDate;
+        this.comment = builder.comment;
+    }
+
+    public CwmsId getPumpLocation() {
+        return this.pumpLocation;
+    }
+
+    public LookupType getTransferType() {
+        return this.transferType;
+    }
+
+    public Double getFlow() {
+        return this.flow;
+    }
+
+    public Instant getTransferDate() {
+        return this.transferDate;
+    }
+
+    public String getComment() {
+        return this.comment;
+    }
+
+    public static final class Builder {
+        private CwmsId pumpLocation;
+        private LookupType transferType;
+        private Double flow;
+        private Instant transferDate;
+        private String comment;
+
+        public Builder withPumpLocation(CwmsId pumpLocation) {
+            this.pumpLocation = pumpLocation;
+            return this;
+        }
+
+        public Builder withTransferType(LookupType transferType) {
+            this.transferType = transferType;
+            return this;
+        }
+
+        public Builder withFlow(Double flow) {
+            this.flow = flow;
+            return this;
+        }
+
+        public Builder withTransferDate(Instant transferDate) {
+            this.transferDate = transferDate;
+            return this;
+        }
+
+        public Builder withComment(String comment) {
+            this.comment = comment;
+            return this;
+        }
+
+        public PumpAccounting build() {
+            return new PumpAccounting(this);
+        }
+    }
+}

cwms-data-api/src/main/java/cwms/cda/data/dto/watersupply/WaterSupplyAccounting.java

@@ -0,0 +1,96 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 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.watersupply;
+
+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.data.dto.CwmsDTOBase;
+import cwms.cda.formatters.Formats;
+import cwms.cda.formatters.annotations.FormattableWith;
+import cwms.cda.formatters.json.JsonV1;
+import java.util.List;
+
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class,
+        aliases = {Formats.DEFAULT, Formats.JSON})
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonDeserialize(builder = WaterSupplyAccounting.Builder.class)
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class)
+@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
+public final class WaterSupplyAccounting extends CwmsDTOBase {
+    @JsonProperty(required = true)
+    private final String contractName;
+    @JsonProperty(required = true)
+    private final WaterUser waterUser;
+    private final List<PumpAccounting> pumpAccounting;
+
+    private WaterSupplyAccounting(Builder builder) {
+        this.contractName = builder.contractName;
+        this.waterUser = builder.waterUser;
+        this.pumpAccounting = builder.pumpAccounting;
+    }
+
+    public String getContractName() {
+        return this.contractName;
+    }
+
+    public WaterUser getWaterUser() {
+        return this.waterUser;
+    }
+
+    public List<PumpAccounting> getPumpAccounting() {
+        return this.pumpAccounting;
+    }
+
+    public static final class Builder {
+        private String contractName;
+        private WaterUser waterUser;
+        private List<PumpAccounting> pumpAccounting;
+
+        public Builder withContractName(String contractName) {
+            this.contractName = contractName;
+            return this;
+        }
+
+        public Builder withWaterUser(WaterUser waterUser) {
+            this.waterUser = waterUser;
+            return this;
+        }
+
+        public Builder withPumpAccounting(
+                List<PumpAccounting> pumpAccounting) {
+            this.pumpAccounting = pumpAccounting;
+            return this;
+        }
+
+        public WaterSupplyAccounting build() {
+            return new WaterSupplyAccounting(this);
+        }
+    }
+}

cwms-data-api/src/test/java/cwms/cda/data/dto/watersupply/PumpAccountingTest.java

@@ -0,0 +1,142 @@
+/*
+ *
+ * MIT License
+ *
+ * Copyright (c) 2024 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.watersupply;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import cwms.cda.api.errors.FieldException;
+import cwms.cda.data.dto.CwmsId;
+import cwms.cda.data.dto.LookupType;
+import cwms.cda.formatters.Formats;
+import cwms.cda.helpers.DTOMatch;
+import org.junit.jupiter.api.Test;
+import org.testcontainers.shaded.org.apache.commons.io.IOUtils;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+
+
+class PumpAccountingTest {
+    private static final String OFFICE = "SPK";
+
+    @Test
+    void testWaterSupplyPumpAccountingSerializationRoundTrip() {
+        WaterSupplyAccounting pumpAccounting = buildTestAccounting();
+        String serialized = Formats.format(Formats.parseHeader(Formats.JSONV1, WaterSupplyAccounting.class),
+                pumpAccounting);
+        WaterSupplyAccounting deserialized = Formats.parseContent(Formats.parseHeader(Formats.JSONV1,
+            WaterSupplyAccounting.class), serialized, WaterSupplyAccounting.class);
+        DTOMatch.assertMatch(pumpAccounting, deserialized);
+    }
+
+    @Test
+    void testWaterSupplyPumpAccountingSerializationRoundTripFromFile() throws Exception {
+        WaterSupplyAccounting pumpAccounting = buildTestAccounting();
+        InputStream resource = this.getClass().getResourceAsStream(
+            "/cwms/cda/data/dto/watersupply/water_supply_accounting.json");
+        assertNotNull(resource);
+        String serialized = IOUtils.toString(resource, StandardCharsets.UTF_8);
+        WaterSupplyAccounting deserialized = Formats.parseContent(Formats.parseHeader(Formats.JSONV1,
+                WaterSupplyAccounting.class), serialized, WaterSupplyAccounting.class);
+        DTOMatch.assertMatch(pumpAccounting, deserialized);
+    }
+
+    @Test
+    void testValidate() {
+        assertAll(
+            () -> {
+                PumpAccounting pumpAccounting = new PumpAccounting.Builder()
+                        .withPumpLocation(new CwmsId.Builder().withOfficeId(OFFICE).withName("Test Pump").build())
+                        .withTransferType(new LookupType.Builder().withActive(true).withTooltip("Test Tool Tip").withOfficeId(OFFICE)
+                        .withDisplayValue("Test Transfer Type").build()).withFlow(1.0)
+                        .withTransferDate(Instant.ofEpochSecond(10000012648112L)).withComment("Test Comment").build();
+                assertDoesNotThrow(pumpAccounting::validate, "Expected validation to pass");
+            },
+            () -> {
+                PumpAccounting pumpAccounting = new PumpAccounting.Builder()
+                        .withPumpLocation(null).withTransferType(new LookupType.Builder().withActive(true)
+                                .withTooltip("Test Tool Tip").withOfficeId(OFFICE)
+                                .withDisplayValue("Test Transfer Type").build())
+                        .withFlow(1.0).withTransferDate(Instant.ofEpochSecond(10000012648112L))
+                        .withComment("Test Comment").build();
+                assertThrows(FieldException.class, pumpAccounting::validate, "Expected validation to "
+                    + "fail due to null location");
+            },
+            () -> {
+                PumpAccounting pumpAccounting = new PumpAccounting.Builder()
+                       .withPumpLocation(new CwmsId.Builder()
+                                        .withOfficeId(OFFICE).withName("Test Pump").build()).withTransferType(null)
+                        .withFlow(1.0).withTransferDate(Instant.ofEpochSecond(10000012648112L))
+                        .withComment("Test Comment").build();
+                assertThrows(FieldException.class, pumpAccounting::validate, "Expected validation to "
+                    + "fail due to null transfer type");
+            },
+            () -> {
+                PumpAccounting pumpAccounting = new PumpAccounting.Builder()
+                        .withPumpLocation(new CwmsId.Builder()
+                                        .withOfficeId(OFFICE).withName("Test Pump").build())
+                        .withTransferType(new LookupType.Builder().withActive(true).withTooltip("Test Tool Tip").
+                                withOfficeId(OFFICE).withDisplayValue("Test Transfer Type").build()).withFlow(null)
+                        .withTransferDate(Instant.ofEpochSecond(10000012648112L)).withComment("Test Comment").build();
+                assertThrows(FieldException.class, pumpAccounting::validate, "Expected validation to "
+                    + "fail due to null flow value");
+            },
+            () -> {
+                PumpAccounting pumpAccounting = new PumpAccounting.Builder()
+                        .withPumpLocation(new CwmsId.Builder().withOfficeId(OFFICE).withName("Test Pump").build())
+                        .withTransferType(new LookupType.Builder().withActive(true).withTooltip("Test Tool Tip")
+                                .withOfficeId(OFFICE).withDisplayValue("Test Transfer Type").build())
+                        .withFlow(1.0).withTransferDate(null).withComment("Test Comment").build();
+                assertThrows(FieldException.class, pumpAccounting::validate, "Expected validation to "
+                    + "fail due to null transfer date");
+            }
+        );
+    }
+
+    private WaterSupplyAccounting buildTestAccounting() {
+        return new WaterSupplyAccounting.Builder().withWaterUser(new WaterUser.Builder().withEntityName("Test Entity")
+                .withWaterRight("Test Water Right").withProjectId(new CwmsId.Builder().withOfficeId(OFFICE)
+                        .withName("Test Location").build()).build())
+                .withContractName("Test Contract").withPumpAccounting(buildTestPumpAccountingList())
+                .build();
+    }
+
+    private List<PumpAccounting> buildTestPumpAccountingList() {
+        List<PumpAccounting> retList = new ArrayList<>();
+        retList.add(new PumpAccounting.Builder().withPumpLocation(new CwmsId.Builder().withOfficeId(OFFICE)
+                .withName("Test Location-Test Pump").build()).withTransferType(new LookupType.Builder().withActive(true)
+                        .withTooltip("Test Tool Tip").withOfficeId(OFFICE).withDisplayValue("Test Transfer Type").build())
+                .withFlow(1.0).withTransferDate(Instant.ofEpochMilli(10000012648000L)).withComment("Test Comment").build());
+        retList.add(new PumpAccounting.Builder().withPumpLocation(new CwmsId.Builder().withOfficeId(OFFICE)
+                .withName("Test Location-Test Pump 2").build()).withTransferType(new LookupType.Builder().withActive(true)
+                        .withTooltip("Test Tool Tip 2").withOfficeId(OFFICE).withDisplayValue("Test Transfer Type 2").build())
+                .withFlow(2.0).withTransferDate(Instant.ofEpochMilli(10000012648000L)).withComment("Test Comment 2").build());
+        return retList;
+    }
+}