com.zepben.evolve.database.sqlite.cim.diagram.DiagramCimWriter.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.diagram

import com.zepben.evolve.cim.iec61970.base.diagramlayout.Diagram
import com.zepben.evolve.cim.iec61970.base.diagramlayout.DiagramObject
import com.zepben.evolve.cim.iec61970.base.diagramlayout.DiagramObjectPoint
import com.zepben.evolve.database.sqlite.cim.CimWriter
import com.zepben.evolve.database.sqlite.cim.tables.iec61970.base.diagramlayout.TableDiagramObjectPoints
import com.zepben.evolve.database.sqlite.cim.tables.iec61970.base.diagramlayout.TableDiagramObjects
import com.zepben.evolve.database.sqlite.cim.tables.iec61970.base.diagramlayout.TableDiagrams
import com.zepben.evolve.database.sqlite.extensions.setNullableString
import com.zepben.evolve.services.diagram.DiagramService
import java.sql.SQLException

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

    // ###########################
    // # IEC61970 Diagram Layout #
    // ###########################

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

        insert.setNullableString(table.DIAGRAM_STYLE.queryIndex, diagram.diagramStyle.name)
        insert.setNullableString(table.ORIENTATION_KIND.queryIndex, diagram.orientationKind.name)

        return saveIdentifiedObject(table, insert, diagram, "diagram")
    }

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

        var status = true
        diagramObject.points.forEachIndexed { sequence, point ->
            status = status and saveDiagramObjectPoint(diagramObject, point, sequence)
        }

        insert.setNullableString(table.IDENTIFIED_OBJECT_MRID.queryIndex, diagramObject.identifiedObjectMRID)
        insert.setNullableString(table.DIAGRAM_MRID.queryIndex, diagramObject.diagram?.mRID)
        insert.setNullableString(table.STYLE.queryIndex, diagramObject.style)
        insert.setDouble(table.ROTATION.queryIndex, diagramObject.rotation)

        return status and saveIdentifiedObject(table, insert, diagramObject, "diagram object")
    }

    @Throws(SQLException::class)
    private fun saveDiagramObjectPoint(diagramObject: DiagramObject, diagramObjectPoint: DiagramObjectPoint, sequenceNumber: Int): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setNullableString(table.DIAGRAM_OBJECT_MRID.queryIndex, diagramObject.mRID)
        insert.setInt(table.SEQUENCE_NUMBER.queryIndex, sequenceNumber)
        insert.setDouble(table.X_POSITION.queryIndex, diagramObjectPoint.xPosition)
        insert.setDouble(table.Y_POSITION.queryIndex, diagramObjectPoint.yPosition)

        return insert.tryExecuteSingleUpdate("diagram object point")
    }

}