Water Supply Accounting DTO

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

@@ -0,0 +1,92 @@
+/*
+ *
+ * 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.formatters.Formats;
+import cwms.cda.formatters.annotations.FormattableWith;
+import cwms.cda.formatters.json.JsonV1;
+
+@JsonDeserialize(builder = PumpColumn.Builder.class)
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class,
+        aliases = {Formats.DEFAULT, Formats.JSON})
+public final class PumpColumn extends CwmsDTOBase {
+    @JsonProperty(value = "name", required = true)
+    private final String name;
+    @JsonProperty(value = "ordinal", required = true)
+    private final int ordinal;
+    @JsonProperty(value = "datatype", required = true)
+    private final String dataType;
+
+    private PumpColumn(Builder builder) {
+        name = builder.name;
+        ordinal = builder.ordinal;
+        dataType = builder.dataType;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public int getOrdinal() {
+        return ordinal;
+    }
+
+    public String getDataType() {
+        return dataType;
+    }
+
+    public static class Builder {
+        @JsonProperty("name")
+        private String name;
+        @JsonProperty("ordinal")
+        private int ordinal;
+        @JsonProperty("datatype")
+        private String dataType;
+
+        public Builder withName(String name) {
+            this.name = name;
+            return this;
+        }
+
+        public Builder withOrdinal(int ordinal) {
+            this.ordinal = ordinal;
+            return this;
+        }
+
+        public Builder withDataType(String dataType) {
+            this.dataType = dataType;
+            return this;
+        }
+
+        public PumpColumn build() {
+            return new PumpColumn(this);
+        }
+    }
+}

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

@@ -0,0 +1,83 @@
+/*
+ *
+ * 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.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import cwms.cda.data.dto.CwmsId;
+
+@JsonDeserialize(builder = PumpLocation.Builder.class)
+@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
+public final class PumpLocation {
+    private final CwmsId pumpIn;
+    private final CwmsId pumpOut;
+    private final CwmsId pumpBelow;
+
+    private PumpLocation(Builder builder) {
+        this.pumpIn = builder.pumpIn;
+        this.pumpOut = builder.pumpOut;
+        this.pumpBelow = builder.pumpBelow;
+    }
+
+    public CwmsId getPumpIn() {
+        return this.pumpIn;
+    }
+
+    public CwmsId getPumpOut() {
+        return this.pumpOut;
+    }
+
+    public CwmsId getPumpBelow() {
+        return this.pumpBelow;
+    }
+
+    public static final class Builder {
+        private CwmsId pumpIn;
+        private CwmsId pumpOut;
+        private CwmsId pumpBelow;
+
+        public Builder withPumpIn(CwmsId pumpIn) {
+            this.pumpIn = pumpIn;
+            return this;
+        }
+
+        public Builder withPumpOut(CwmsId pumpOut) {
+            this.pumpOut = pumpOut;
+            return this;
+        }
+
+        public Builder withPumpBelow(CwmsId pumpBelow) {
+            this.pumpBelow = pumpBelow;
+            return this;
+        }
+
+        public PumpLocation build() {
+            return new PumpLocation(this);
+        }
+    }
+}

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

@@ -0,0 +1,74 @@
+/*
+ *
+ * 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.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.PropertyNamingStrategies;
+import com.fasterxml.jackson.databind.annotation.JsonNaming;
+import cwms.cda.data.dto.CwmsDTOBase;
+
+@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
+@JsonFormat(shape = JsonFormat.Shape.ARRAY)
+public final class PumpTransfer extends CwmsDTOBase {
+    @JsonProperty(required = true, index = 0)
+    private final PumpType pumpType;
+    @JsonProperty(required = true, index = 1)
+    private final String transferTypeDisplay;
+    @JsonProperty(required = true, index = 2)
+    private final Double flow;
+    @JsonProperty(required = true, index = 3)
+    private final String comment;
+
+    @JsonCreator
+    public PumpTransfer(@JsonProperty("pump-type") PumpType pumpType,
+            @JsonProperty("transfer-type-display") String transferTypeDisplay,
+            @JsonProperty("flow") Double flow, @JsonProperty("comment") String comment) {
+        this.transferTypeDisplay = transferTypeDisplay;
+        this.flow = flow;
+        this.comment = comment;
+        this.pumpType = pumpType;
+    }
+
+    public String getTransferTypeDisplay() {
+        return this.transferTypeDisplay;
+    }
+
+    public Double getFlow() {
+        return this.flow;
+    }
+
+    public PumpType getPumpType() {
+        return this.pumpType;
+    }
+
+    public String getComment() {
+        return this.comment;
+    }
+
+}

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

@@ -0,0 +1,146 @@
+/*
+ *
+ * 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.JsonIgnoreProperties;
+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 io.swagger.v3.oas.annotations.media.Schema;
+import java.time.Instant;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+@FormattableWith(contentType = Formats.JSONV1, formatter = JsonV1.class,
+        aliases = {Formats.DEFAULT, Formats.JSON})
+@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;
+    @JsonProperty(required = true)
+    private final PumpLocation pumpLocations;
+    @Schema(name = "data-columns")
+    @JsonProperty(required = true, value = "data-columns")
+    private final List<PumpColumn> pumpColumn;
+    private final Map<Instant, List<PumpTransfer>> pumpAccounting;
+
+    private WaterSupplyAccounting(Builder builder) {
+        this.contractName = builder.contractName;
+        this.waterUser = builder.waterUser;
+        this.pumpLocations = builder.pumpLocations;
+        this.pumpAccounting = builder.pumpAccounting;
+        this.pumpColumn = buildPumpColumns();
+    }
+
+    public String getContractName() {
+        return this.contractName;
+    }
+
+    public WaterUser getWaterUser() {
+        return this.waterUser;
+    }
+
+    public List<PumpColumn> getPumpColumn() {
+        return this.pumpColumn;
+    }
+
+    public Map<Instant, List<PumpTransfer>> getPumpAccounting() {
+        return this.pumpAccounting;
+    }
+
+    public PumpLocation getPumpLocations() {
+        return this.pumpLocations;
+    }
+
+    @JsonIgnoreProperties("data-columns")
+    public static final class Builder {
+        private String contractName;
+        private WaterUser waterUser;
+        private Map<Instant, List<PumpTransfer>> pumpAccounting;
+        private PumpLocation pumpLocations;
+
+        public Builder withContractName(String contractName) {
+            this.contractName = contractName;
+            return this;
+        }
+
+        public Builder withWaterUser(WaterUser waterUser) {
+            this.waterUser = waterUser;
+            return this;
+        }
+
+        public Builder withPumpAccounting(
+                Map<Instant, List<PumpTransfer>> pumpAccounting) {
+            this.pumpAccounting = pumpAccounting;
+            return this;
+        }
+
+        public Builder withPumpLocations(
+                PumpLocation pumpLocations) {
+            this.pumpLocations = pumpLocations;
+            return this;
+        }
+
+        public WaterSupplyAccounting build() {
+            return new WaterSupplyAccounting(this);
+        }
+    }
+
+    private List<PumpColumn> buildPumpColumns() {
+        List<PumpColumn> retVal = new ArrayList<>();
+        retVal.add(new PumpColumn.Builder()
+                .withName("pump-type")
+                .withOrdinal(1)
+                .withDataType(String.class.getTypeName())
+                .build());
+        retVal.add(new PumpColumn.Builder()
+                .withName("transfer-type-display")
+                .withOrdinal(2)
+                .withDataType(String.class.getTypeName())
+                .build());
+        retVal.add(new PumpColumn.Builder()
+                .withName("flow").withOrdinal(3)
+                .withDataType(Double.class.getTypeName())
+                .build());
+        retVal.add(new PumpColumn.Builder()
+                .withName("comment")
+                .withOrdinal(4)
+                .withDataType(String.class.getTypeName())
+                .build());
+        return retVal;
+    }
+}