Water Supply Accounting DTO

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

@@ -0,0 +1,75 @@
+/*
+ *
+ * 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 java.time.Instant;
+import java.util.Map;
+
+
+@JsonDeserialize(builder = PumpAccounting.Builder.class)
+public final class PumpAccounting extends CwmsDTOBase {
+    @JsonProperty(required = true)
+    private final CwmsId pumpLocation;
+    @JsonProperty(required = true)
+    private final Map<Instant, PumpTransfer> pumpTransfers;
+
+    private PumpAccounting(Builder builder) {
+        this.pumpLocation = builder.pumpLocation;
+        this.pumpTransfers = builder.pumpTransfers;
+    }
+
+    public CwmsId getPumpLocation() {
+        return this.pumpLocation;
+    }
+
+    public Map<Instant, PumpTransfer> getPumpTransfers() {
+        return this.pumpTransfers;
+    }
+
+    public static final class Builder {
+        private CwmsId pumpLocation;
+        private Map<Instant, PumpTransfer> pumpTransfers;
+
+        public Builder withPumpLocation(CwmsId pumpLocation) {
+            this.pumpLocation = pumpLocation;
+            return this;
+        }
+
+        public Builder withPumpTransfers(Map<Instant, PumpTransfer> pumpTransfers) {
+            this.pumpTransfers = pumpTransfers;
+            return this;
+        }
+
+        public PumpAccounting build() {
+            return new PumpAccounting(this);
+        }
+    }
+}

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

@@ -0,0 +1,98 @@
+/*
+ *
+ * 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 java.time.Instant;
+
+@JsonDeserialize(builder = PumpTransfer.Builder.class)
+public final class PumpTransfer extends CwmsDTOBase {
+    @JsonProperty(required = true)
+    private final String transferTypeDisplay;
+    @JsonProperty(required = true)
+    private final Double flow;
+    @JsonProperty(required = true)
+    private final Instant transferDate;
+    private final String comment;
+
+    private PumpTransfer(Builder builder) {
+        this.transferTypeDisplay = builder.transferTypeDisplay;
+        this.flow = builder.flow;
+        this.transferDate = builder.transferDate;
+        this.comment = builder.comment;
+    }
+
+    public String getTransferTypeDisplay() {
+        return this.transferTypeDisplay;
+    }
+
+    public Double getFlow() {
+        return this.flow;
+    }
+
+    public Instant getTransferDate() {
+        return this.transferDate;
+    }
+
+    public String getComment() {
+        return this.comment;
+    }
+
+    public static final class Builder {
+        private String transferTypeDisplay;
+        private Double flow;
+        private Instant transferDate;
+        private String comment;
+
+        public Builder withTransferTypeDisplay(String transferTypeDisplay) {
+            this.transferTypeDisplay = transferTypeDisplay;
+            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 PumpTransfer build() {
+            return new PumpTransfer(this);
+        }
+    }
+}

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

@@ -0,0 +1,122 @@
+/*
+ *
+ * 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.Map;
+
+@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 Map<String, PumpAccounting> pumpInAccounting;
+    private final Map<String, PumpAccounting> pumpOutAccounting;
+    private final Map<String, PumpAccounting> pumpBelowAccounting;
+
+    private WaterSupplyAccounting(Builder builder) {
+        this.contractName = builder.contractName;
+        this.waterUser = builder.waterUser;
+        this.pumpBelowAccounting = builder.pumpBelowAccounting;
+        this.pumpInAccounting = builder.pumpInAccounting;
+        this.pumpOutAccounting = builder.pumpOutAccounting;
+    }
+
+    public String getContractName() {
+        return this.contractName;
+    }
+
+    public WaterUser getWaterUser() {
+        return this.waterUser;
+    }
+
+    public Map<String, PumpAccounting> getPumpInAccounting() {
+        return this.pumpInAccounting;
+    }
+
+    public Map<String, PumpAccounting> getPumpOutAccounting() {
+        return this.pumpOutAccounting;
+    }
+
+    public Map<String, PumpAccounting> getPumpBelowAccounting() {
+        return this.pumpBelowAccounting;
+    }
+
+    public static final class Builder {
+        private String contractName;
+        private WaterUser waterUser;
+        private Map<String, PumpAccounting> pumpInAccounting;
+        private Map<String, PumpAccounting> pumpOutAccounting;
+        private Map<String, PumpAccounting> pumpBelowAccounting;
+
+        public Builder withContractName(String contractName) {
+            this.contractName = contractName;
+            return this;
+        }
+
+        public Builder withWaterUser(WaterUser waterUser) {
+            this.waterUser = waterUser;
+            return this;
+        }
+
+        public Builder withPumpInAccounting(
+                Map<String, PumpAccounting> pumpInAccounting) {
+            this.pumpInAccounting = pumpInAccounting;
+            return this;
+        }
+
+        public Builder withPumpOutAccounting(
+                Map<String, PumpAccounting> pumpOutAccounting) {
+            this.pumpOutAccounting = pumpOutAccounting;
+            return this;
+        }
+
+        public Builder withPumpBelowAccounting(
+                Map<String,  PumpAccounting> pumpBelowAccounting) {
+            this.pumpBelowAccounting = pumpBelowAccounting;
+            return this;
+        }
+
+        public WaterSupplyAccounting build() {
+            return new WaterSupplyAccounting(this);
+        }
+    }
+}