com.zepben.evolve.database.sqlite.cim.customer.CustomerCimWriter.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation
SDK for interaction with the evolve platform
There is a newer version: 0.24.0rc1
/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.database.sqlite.cim.customer

import com.zepben.evolve.cim.iec61968.common.Agreement
import com.zepben.evolve.cim.iec61968.customers.Customer
import com.zepben.evolve.cim.iec61968.customers.CustomerAgreement
import com.zepben.evolve.cim.iec61968.customers.PricingStructure
import com.zepben.evolve.cim.iec61968.customers.Tariff
import com.zepben.evolve.database.sqlite.cim.CimWriter
import com.zepben.evolve.database.sqlite.cim.tables.associations.TableCustomerAgreementsPricingStructures
import com.zepben.evolve.database.sqlite.cim.tables.associations.TablePricingStructuresTariffs
import com.zepben.evolve.database.sqlite.cim.tables.iec61968.common.TableAgreements
import com.zepben.evolve.database.sqlite.cim.tables.iec61968.customers.TableCustomerAgreements
import com.zepben.evolve.database.sqlite.cim.tables.iec61968.customers.TableCustomers
import com.zepben.evolve.database.sqlite.cim.tables.iec61968.customers.TablePricingStructures
import com.zepben.evolve.database.sqlite.cim.tables.iec61968.customers.TableTariffs
import com.zepben.evolve.database.sqlite.extensions.setNullableInt
import com.zepben.evolve.database.sqlite.extensions.setNullableString
import com.zepben.evolve.services.customer.CustomerService
import java.sql.PreparedStatement
import java.sql.SQLException

/**
 * A class for writing the [CustomerService] tables to the database.
 *
 * @property databaseTables The tables available in the database.
 */
class CustomerCimWriter(
    override val databaseTables: CustomerDatabaseTables
) : CimWriter(databaseTables) {

    // ###################
    // # IEC61968 Common #
    // ###################

    @Suppress("SameParameterValue")
    @Throws(SQLException::class)
    private fun saveAgreement(table: TableAgreements, insert: PreparedStatement, agreement: Agreement, description: String): Boolean {
        return saveDocument(table, insert, agreement, description)
    }

    // ######################
    // # IEC61968 Customers #
    // ######################

    /**
     * Save the [Customer] fields to [TableCustomers].
     *
     * @param customer The [Customer] instance to write to the database.
     *
     * @return true if the [Customer] was successfully written to the database, otherwise false.
     * @throws SQLException For any errors encountered writing to the database.
     */
    @Throws(SQLException::class)
    fun save(customer: Customer): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setNullableString(table.KIND.queryIndex, customer.kind.name)
        insert.setNullableInt(table.NUM_END_DEVICES.queryIndex, customer.numEndDevices)
        insert.setNullableString(table.SPECIAL_NEED.queryIndex, customer.specialNeed)

        return saveOrganisationRole(table, insert, customer, "customer")
    }

    /**
     * Save the [CustomerAgreement] fields to [TableCustomerAgreements].
     *
     * @param customerAgreement The [CustomerAgreement] instance to write to the database.
     *
     * @return true if the [CustomerAgreement] was successfully written to the database, otherwise false.
     * @throws SQLException For any errors encountered writing to the database.
     */
    @Throws(SQLException::class)
    fun save(customerAgreement: CustomerAgreement): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        var status = true
        customerAgreement.pricingStructures.forEach { status = status and saveAssociation(customerAgreement, it) }

        insert.setNullableString(table.CUSTOMER_MRID.queryIndex, customerAgreement.customer?.mRID)

        return status and saveAgreement(table, insert, customerAgreement, "customer agreement")
    }

    /**
     * Save the [PricingStructure] fields to [TablePricingStructures].
     *
     * @param pricingStructure The [PricingStructure] instance to write to the database.
     *
     * @return true if the [PricingStructure] was successfully written to the database, otherwise false.
     * @throws SQLException For any errors encountered writing to the database.
     */
    @Throws(SQLException::class)
    fun save(pricingStructure: PricingStructure): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        var status = true
        pricingStructure.tariffs.forEach { status = status and saveAssociation(pricingStructure, it) }

        return status and saveDocument(table, insert, pricingStructure, "pricing structure")
    }

    /**
     * Save the [Tariff] fields to [TableTariffs].
     *
     * @param tariff The [Tariff] instance to write to the database.
     *
     * @return true if the [Tariff] was successfully written to the database, otherwise false.
     * @throws SQLException For any errors encountered writing to the database.
     */
    @Throws(SQLException::class)
    fun save(tariff: Tariff): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        return saveDocument(table, insert, tariff, "tariff")
    }

    // ################
    // # Associations #
    // ################

    @Throws(SQLException::class)
    private fun saveAssociation(customerAgreement: CustomerAgreement, pricingStructure: PricingStructure): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setNullableString(table.CUSTOMER_AGREEMENT_MRID.queryIndex, customerAgreement.mRID)
        insert.setNullableString(table.PRICING_STRUCTURE_MRID.queryIndex, pricingStructure.mRID)

        return insert.tryExecuteSingleUpdate("customer agreement to pricing structure association")
    }

    @Throws(SQLException::class)
    private fun saveAssociation(pricingStructure: PricingStructure, tariff: Tariff): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setNullableString(table.PRICING_STRUCTURE_MRID.queryIndex, pricingStructure.mRID)
        insert.setNullableString(table.TARIFF_MRID.queryIndex, tariff.mRID)

        return insert.tryExecuteSingleUpdate("pricing structure to tariff association")
    }

}