add legal effects of master plan

Author: nmaarnio

arho_feature_template/core/models.py

@@ -578,6 +578,7 @@ class Plan:
     organisation_id: str | None = None
     general_regulations: list[RegulationGroup] = field(default_factory=list)
     documents: list[Document] = field(default_factory=list)
+    legal_effect_ids: list[str] = field(default_factory=list)
     geom: QgsGeometry | None = None
     id_: str | None = None
 

arho_feature_template/core/plan_manager.py

@@ -37,6 +37,7 @@
     DocumentLayer,
     LandUseAreaLayer,
     LandUsePointLayer,
+    LegalEffectAssociationLayer,
     LifeCycleLayer,
     LineLayer,
     OtherAreaLayer,
@@ -547,6 +548,15 @@ def save_plan(plan: Plan) -> QgsFeature | None:
             ):
                 iface.messageBar().pushCritical("", "Kaavamääräysryhmän assosiaation poistaminen epäonnistui.")
 
+        # Check for deleted legal effects
+        for association in LegalEffectAssociationLayer.get_dangling_associations(plan_id, plan.legal_effect_ids):
+            if not _delete_feature(
+                association,
+                LegalEffectAssociationLayer.get_from_project(),
+                "Oikeusvaikutuksen assosiaation poisto",
+            ):
+                iface.messageBar().pushCritical("", "Oikeusvaikutuksen assosiaation poistaminen epäonnistui.")
+
         # Check for documents to be deleted
         doc_layer = DocumentLayer.get_from_project()
         for doc_feature in DocumentLayer.get_documents_to_delete(plan.documents, plan.id_):
@@ -561,6 +571,10 @@ def save_plan(plan: Plan) -> QgsFeature | None:
                 continue  # Skip association saving if saving regulation group failed
             save_regulation_group_association(regulation_group_feature["id"], PlanLayer.name, plan_id)
 
+    # Save legal effect associations
+    for legal_effect_id in plan.legal_effect_ids:
+        save_legal_effect_association(plan_id, legal_effect_id)
+
     # Save documents
     for document in plan.documents:
         document.plan_id = plan_id
@@ -754,6 +768,19 @@ def save_type_of_verbal_regulation_association(regulation_id: str, verbal_regula
     return True
 
 
+def save_legal_effect_association(plan_id: str, legal_effect_id: str) -> bool:
+    if LegalEffectAssociationLayer.association_exists(plan_id, legal_effect_id):
+        return True
+    feature = LegalEffectAssociationLayer.feature_from(plan_id, legal_effect_id)
+    layer = LegalEffectAssociationLayer.get_from_project()
+
+    if not _save_feature(feature=feature, layer=layer, id_=None, edit_text="Oikeusvaikutuksen assosiaation lisäys"):
+        iface.messageBar().pushCritical("", "Oikeusvaikutuksen assosiaation tallentaminen epäonnistui.")
+        return False
+
+    return True
+
+
 def save_additional_information(additional_information: AdditionalInformation) -> QgsFeature | None:
     feature = AdditionalInformationLayer.feature_from_model(additional_information)
     layer = AdditionalInformationLayer.get_from_project()

arho_feature_template/gui/components/value_input_widgets.py

@@ -17,7 +17,7 @@
 
 from arho_feature_template.core.models import AttributeValue, AttributeValueDataType
 from arho_feature_template.gui.components.code_combobox import HierarchicalCodeComboBox
-from arho_feature_template.project.layers.code_layers import VerbalRegulationType
+from arho_feature_template.project.layers.code_layers import LegalEffectsLayer, VerbalRegulationType
 
 logger = logging.getLogger(__name__)
 
@@ -194,6 +194,44 @@ def get_value(self) -> str | None:
         return self.input_widget.value()
 
 
+class LegalEffectWidget(QWidget):
+    def __init__(
+        self,
+        with_add_btn: bool = False,  # noqa: FBT001, FBT002
+        with_del_btn: bool = False,  # noqa: FBT001, FBT002
+        parent=None,
+    ):
+        super().__init__(parent)
+
+        layout = QHBoxLayout()
+        layout.setContentsMargins(0, 0, 0, 0)
+        self.input_widget = HierarchicalCodeComboBox()
+        self.input_widget.populate_from_code_layer(LegalEffectsLayer)
+        layout.addWidget(self.input_widget)
+
+        self.add_btn: QPushButton | None = None
+        if with_add_btn:
+            self.add_btn = QPushButton()
+            self.add_btn.setMaximumWidth(30)
+            self.add_btn.setIcon(QgsApplication.getThemeIcon("mActionAdd.svg"))
+            layout.addWidget(self.add_btn)
+
+        self.del_btn: QPushButton | None = None
+        if with_del_btn:
+            self.del_btn = QPushButton()
+            self.del_btn.setMaximumWidth(30)
+            self.del_btn.setIcon(QgsApplication.getThemeIcon("mActionDeleteSelected.svg"))
+            layout.addWidget(self.del_btn)
+
+        self.setLayout(layout)
+
+    def set_value(self, value: str | None):
+        self.input_widget.set_value(value)
+
+    def get_value(self) -> str | None:
+        return self.input_widget.value()
+
+
 class ValueWidgetManager:
     def __init__(self, value: AttributeValue | None, default_value: AttributeValue):
         if value is None:

arho_feature_template/gui/dialogs/plan_attribute_form.py

@@ -1,23 +1,18 @@
 from __future__ import annotations
 
 from importlib import resources
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, cast
 
 from qgis.core import QgsApplication
 from qgis.PyQt import uic
-from qgis.PyQt.QtWidgets import (
-    QDialog,
-    QDialogButtonBox,
-    QLineEdit,
-    QPushButton,
-    QTextEdit,
-)
+from qgis.PyQt.QtWidgets import QDialog, QDialogButtonBox, QLabel, QLineEdit, QPushButton, QTextEdit
 
 from arho_feature_template.core.models import Document, Plan, RegulationGroup, RegulationGroupLibrary
 from arho_feature_template.gui.components.general_regulation_group_widget import GeneralRegulationGroupWidget
 
 # from arho_feature_template.gui.components.plan_regulation_group_widget import RegulationGroupWidget
 from arho_feature_template.gui.components.plan_document_widget import DocumentWidget
+from arho_feature_template.gui.components.value_input_widgets import LegalEffectWidget
 from arho_feature_template.project.layers.code_layers import (
     LifeCycleStatusLayer,
     OrganisationLayer,
@@ -26,7 +21,7 @@
 from arho_feature_template.utils.misc_utils import disconnect_signal
 
 if TYPE_CHECKING:
-    from qgis.PyQt.QtWidgets import QLineEdit, QPushButton, QTextEdit, QVBoxLayout
+    from qgis.PyQt.QtWidgets import QFormLayout, QLineEdit, QTextEdit, QVBoxLayout
 
     from arho_feature_template.gui.components.code_combobox import CodeComboBox, HierarchicalCodeComboBox
 
@@ -61,6 +56,8 @@ def __init__(self, plan: Plan, _regulation_group_libraries: list[RegulationGroup
 
         self.setupUi(self)
 
+        self.general_data_layout: QFormLayout
+
         self.plan = plan
         self.lifecycle_models = plan.lifecycles
 
@@ -87,10 +84,12 @@ def __init__(self, plan: Plan, _regulation_group_libraries: list[RegulationGroup
         self.name_line_edit.textChanged.connect(self._check_required_fields)
         self.organisation_combo_box.currentIndexChanged.connect(self._check_required_fields)
         self.plan_type_combo_box.currentIndexChanged.connect(self._check_required_fields)
+        self.plan_type_combo_box.currentIndexChanged.connect(self._update_legal_effect_widgets_visibility)
         self.lifecycle_status_combo_box.currentIndexChanged.connect(self._check_required_fields)
 
         self.scroll_area_spacer = None
         self.regulation_group_widgets: list[GeneralRegulationGroupWidget] = []
+        self.legal_effect_widgets: list[tuple[QLabel, LegalEffectWidget]] = []
         # self.regulation_groups_selection_widget = TreeWithSearchWidget()
         # self.regulation_groups_tree_layout.insertWidget(2, self.regulation_groups_selection_widget)
         # for library in regulation_group_libraries:
@@ -105,6 +104,12 @@ def __init__(self, plan: Plan, _regulation_group_libraries: list[RegulationGroup
         for document in plan.documents:
             self.add_document(document)
 
+        # Legal effects
+        for legal_effect_id in plan.legal_effect_ids:
+            self.add_legal_effect_widget(legal_effect_id)
+        if len(self.legal_effect_widgets) == 0:
+            self.add_legal_effect_widget()
+
         self.add_general_regulation_group_btn.clicked.connect(self.add_new_regulation_group)
         self.add_general_regulation_group_btn.setIcon(QgsApplication.getThemeIcon("mActionAdd.svg"))
 
@@ -115,6 +120,7 @@ def __init__(self, plan: Plan, _regulation_group_libraries: list[RegulationGroup
         self.button_box.accepted.connect(self._on_ok_clicked)
 
         self._check_required_fields()
+        self._update_legal_effect_widgets_visibility()
 
     def _check_required_fields(self) -> None:
         ok_button = self.button_box.button(QDialogButtonBox.Ok)
@@ -129,6 +135,53 @@ def _check_required_fields(self) -> None:
         else:
             ok_button.setEnabled(False)
 
+    def _update_legal_effect_widgets_visibility(self):
+        plan_type_id = self.plan_type_combo_box.value()
+        if PlanTypeLayer.is_general_plan_type(plan_type_id):
+            self._show_legal_effect_widgets()
+        else:
+            self._hide_legal_effect_widgets()
+
+    def _show_legal_effect_widgets(self):
+        for label, widget in self.legal_effect_widgets:
+            label.show()
+            widget.show()
+
+    def _hide_legal_effect_widgets(self):
+        for label, widget in self.legal_effect_widgets:
+            label.hide()
+            widget.hide()
+
+    def add_legal_effect_widget(self, legal_effect_id: str | None = None):
+        """
+        Adds a legal effect widget to the form.
+
+        If no legal widgets exist yet, includes an "add" button, otherwise a
+        "delete" button.
+        """
+        if len(self.legal_effect_widgets) == 0:
+            widget = LegalEffectWidget(with_add_btn=True)
+            btn = cast(QPushButton, widget.add_btn)
+            btn.clicked.connect(self.add_legal_effect_widget)
+        else:
+            widget = LegalEffectWidget(with_del_btn=True)
+            btn = cast(QPushButton, widget.del_btn)
+            btn.clicked.connect(lambda: self.delete_legal_effect_widget(widget))
+
+        if legal_effect_id:
+            widget.set_value(legal_effect_id)
+
+        label = QLabel("Oikeusvaikutus")
+        self.legal_effect_widgets.append((label, widget))
+        self.general_data_layout.addRow(label, widget)
+
+    def delete_legal_effect_widget(self, widget_to_delete: LegalEffectWidget):
+        for i, (label, widget) in enumerate(self.legal_effect_widgets):
+            if widget is widget_to_delete:
+                self.legal_effect_widgets.pop(i)
+                widget.deleteLater()
+                label.deleteLater()
+
     # --- COPIED FROM PLAN FEATURE FORM ---
 
     # def add_selected_plan_regulation_group(self, item: QTreeWidgetItem, column: int):
@@ -190,6 +243,11 @@ def delete_document(self, document_widget: DocumentWidget):
     # ---
 
     def into_model(self) -> Plan:
+        if PlanTypeLayer.is_general_plan_type(self.plan_type_combo_box.value()):
+            legal_effect_ids = [legal_effect_widget[1].get_value() for legal_effect_widget in self.legal_effect_widgets]
+        else:
+            legal_effect_ids = []
+
         return Plan(
             id_=self.plan.id_,
             name=self.name_line_edit.text(),
@@ -202,6 +260,7 @@ def into_model(self) -> Plan:
             matter_management_identifier=self.matter_management_identifier_line_edit.text() or None,
             lifecycle_status_id=self.lifecycle_status_combo_box.value(),
             general_regulations=[reg_group_widget.into_model() for reg_group_widget in self.regulation_group_widgets],
+            legal_effect_ids=[value for value in legal_effect_ids if value is not None],
             documents=[document_widget.into_model() for document_widget in self.document_widgets],
             geom=self.plan.geom,
         )

arho_feature_template/gui/dialogs/plan_attribute_form.ui

@@ -76,7 +76,7 @@
             <number>9</number>
            </property>
            <item>
-            <layout class="QFormLayout" name="formLayout">
+            <layout class="QFormLayout" name="general_data_layout">
              <item row="0" column="0">
               <widget class="QLabel" name="label">
                <property name="text">
@@ -246,8 +246,8 @@
            <rect>
             <x>0</x>
             <y>0</y>
-            <width>831</width>
-            <height>562</height>
+            <width>193</width>
+            <height>49</height>
            </rect>
           </property>
           <layout class="QVBoxLayout" name="regulations_layout">
@@ -301,8 +301,8 @@
            <rect>
             <x>0</x>
             <y>0</y>
-            <width>831</width>
-            <height>562</height>
+            <width>119</width>
+            <height>49</height>
            </rect>
           </property>
           <layout class="QVBoxLayout" name="documents_layout">

arho_feature_template/project/layers/code_layers.py

@@ -15,6 +15,14 @@ class PlanTypeLayer(AbstractCodeLayer):
     name = "Kaavalaji"
 
     category_only_codes: ClassVar[list[str]] = ["1", "2", "3"]  # "Maakuntakaava", "Asemakaava", "Yleiskaava"
+    general_plan_type_values: ClassVar[list[int]] = [2, 21, 22, 23, 24, 25]
+
+    @classmethod
+    def is_general_plan_type(cls, _id: str | None) -> bool:
+        if _id is None:
+            return False
+        attribute_value = cls.get_attribute_value_by_another_attribute_value("value", "id", _id)
+        return int(attribute_value) in cls.general_plan_type_values if attribute_value is not None else False
 
 
 class LifeCycleStatusLayer(AbstractCodeLayer):
@@ -123,4 +131,10 @@ class RetentionTimeLayer(AbstractCodeLayer):
     category_only_codes: ClassVar[list[str]] = []
 
 
+class LegalEffectsLayer(AbstractCodeLayer):
+    name = "Yleiskaavan oikeusvaikutus"
+
+    category_only_codes: ClassVar[list[str]] = []
+
+
 code_layers = AbstractCodeLayer.__subclasses__()

arho_feature_template/project/layers/plan_layers.py

@@ -120,6 +120,7 @@ def model_from_feature(cls, feature: QgsFeature) -> Plan:
                 for feat in general_regulation_features
                 if feat is not None
             ],
+            legal_effect_ids=list(LegalEffectAssociationLayer.get_legal_effect_ids_for_plan(feature["id"])),
             documents=[
                 DocumentLayer.model_from_feature(feat)
                 for feat in DocumentLayer.get_features_by_attribute_value("plan_id", feature["id"])
@@ -485,6 +486,44 @@ def get_dangling_associations(cls, regulation_id: str, updated_type_ids: list[st
         return [assoc for assoc in associations if assoc["type_of_verbal_plan_regulation_id"] not in updated_type_ids]
 
 
+class LegalEffectAssociationLayer(AbstractPlanLayer):
+    name = "Yleiskaavan oikeusvaikutusten assosiaatiot"
+    filter_template = None
+
+    @classmethod
+    def feature_from(cls, plan_id: str, legal_effect_id: str) -> QgsFeature | None:
+        layer = cls.get_from_project()
+
+        feature = QgsVectorLayerUtils.createFeature(layer)
+        feature["plan_id"] = plan_id
+        feature["legal_effects_of_master_plan_id"] = legal_effect_id
+        return feature
+
+    @classmethod
+    def association_exists(cls, plan_id: str, legal_effect_id: str) -> bool:
+        for feature in cls.get_features_by_attribute_value("plan_id", plan_id):
+            if feature["legal_effects_of_master_plan_id"] == legal_effect_id:
+                return True
+        return False
+
+    @classmethod
+    def get_associations_for_plan(cls, plan_id: str) -> Generator[QgsFeature]:
+        return cls.get_features_by_attribute_value("plan_id", plan_id)
+
+    @classmethod
+    def get_legal_effect_ids_for_plan(cls, plan_id: str) -> Generator[QgsFeature]:
+        return cls.get_attribute_values_by_another_attribute_value(
+            "legal_effects_of_master_plan_id", "plan_id", plan_id
+        )
+
+    @classmethod
+    def get_dangling_associations(cls, plan_id: str, updated_legal_effect_ids: list[str]) -> list[QgsFeature]:
+        associations = cls.get_associations_for_plan(plan_id)
+        return [
+            assoc for assoc in associations if assoc["legal_effects_of_master_plan_id"] not in updated_legal_effect_ids
+        ]
+
+
 class PlanPropositionLayer(AbstractPlanLayer):
     name = "Kaavasuositus"
     filter_template = Template(