Merge pull request #61 from opengisch/extended-models

Improvement of Project Creation with extended INTERLIS Models

README.md

@@ -91,8 +91,10 @@ Is enforced with pre-commit. To use, make:
 ```
 pip install pre-commit
 pre-commit install
-```00
+```
+
 And to run it over all the files (with infile changes):
+
 ```
 pre-commit run --color=always --all-file
 ```

modelbaker/dataobjects/layers.py

@@ -31,7 +31,8 @@
 )
 from qgis.PyQt.QtCore import QCoreApplication, QSettings
 
-from ..generator.config import IGNORED_FIELDNAMES
+from ..generator.config import BASKET_FIELDNAMES, IGNORED_FIELDNAMES
+from ..utils.globals import OptimizeStrategy
 from .form import Form, FormFieldWidget, FormRelationWidget, FormTab
 
 
@@ -54,6 +55,9 @@ def __init__(
         is_basket_table=False,
         is_dataset_table=False,
         ili_name=None,
+        is_relevant=True,
+        all_topics=[],  # all the topics this class (or an instance of it) are located
+        relevant_topics=[],  # the topics of the most extended instance of it only
         definitionfile=None,
         qmlstylefile=None,
         styles={},
@@ -99,6 +103,10 @@ def __init__(
                     f"{self.ili_name.split('.')[0]}.{self.ili_name.split('.')[1]}"
                 )
 
+        self.is_relevant = is_relevant
+        self.all_topics = all_topics
+        self.relevant_topics = relevant_topics
+
         self.definitionfile = definitionfile
         self.qmlstylefile = qmlstylefile
         self.styles = styles
@@ -123,6 +131,9 @@ def dump(self):
         definition["coordinateprecision"] = self.coordinate_precision
         definition["modeltopicname"] = self.model_topic_name
         definition["ili_name"] = self.ili_name
+        definition["is_relevant"] = self.is_relevant
+        definition["all_topics"] = self.all_topics
+        definition["relevant_topics"] = self.relevant_topics
         definition["definitionfile"] = self.definitionfile
         definition["qmlstylefile"] = self.qmlstylefile
         definition["styles"] = self.styles
@@ -141,6 +152,9 @@ def load(self, definition):
         self.coordinate_precision = definition["coordinateprecision"]
         self.model_topic_name = definition["modeltopicname"]
         self.ili_name = definition["ili_name"]
+        self.is_relevant = definition["is_relevant"]
+        self.all_topics = definition["all_topics"]
+        self.relevant_topics = definition["relevant_topics"]
         self.definitionfile = definition["definitionfile"]
         self.qmlstylefile = definition["qmlstylefile"]
         self.styles = definition["styles"]
@@ -250,6 +264,11 @@ def post_generate(self, project):
             relations_to_add = []
             for relation in project.relations:
                 if relation.referenced_layer == self:
+                    if (
+                        not relation.referencing_layer.is_relevant
+                        and project.optimize_strategy == OptimizeStrategy.GROUP
+                    ):
+                        continue
 
                     # 1:n relation will be added only if does not point to a pure link table
                     if (
@@ -263,13 +282,12 @@ def post_generate(self, project):
                             if nm_relation == relation:
                                 continue
 
-                            if nm_relation.referenced_layer == self:
+                            if nm_relation.referenced_layer.ili_name == self.ili_name:
                                 continue
 
-                            # relations to the same table with different geometries should not be added
                             if (
-                                self.srid
-                                and nm_relation.referenced_layer.srid == self.srid
+                                not nm_relation.referenced_layer.is_relevant
+                                and project.optimize_strategy == OptimizeStrategy.GROUP
                             ):
                                 continue
 
@@ -332,7 +350,7 @@ def isPureLinkTable(self, project):
 
         remaining_fields = set()
         for field in self.fields:
-            if field.name not in IGNORED_FIELDNAMES:
+            if field.name not in IGNORED_FIELDNAMES + BASKET_FIELDNAMES:
                 remaining_fields.add(field.name)
 
         # Remove all fields that are referencing fields

modelbaker/dataobjects/project.py

@@ -33,6 +33,7 @@
 from qgis.PyQt.QtCore import QObject, pyqtSignal
 from qgis.PyQt.QtXml import QDomDocument
 
+from ..utils.globals import OptimizeStrategy
 from .layers import Layer
 from .legend import LegendGroup
 from .relations import Relation
@@ -43,7 +44,13 @@
 class Project(QObject):
     layer_added = pyqtSignal(str)
 
-    def __init__(self, auto_transaction=True, evaluate_default_values=True, context={}):
+    def __init__(
+        self,
+        auto_transaction=True,
+        evaluate_default_values=True,
+        context={},
+        optimize_strategy=OptimizeStrategy.NONE,
+    ):
         QObject.__init__(self)
         self.crs = None
         self.name = "Not set"
@@ -57,6 +64,7 @@ def __init__(self, auto_transaction=True, evaluate_default_values=True, context=
         self.layouts = {}
         self.mapthemes = {}
         self.context = context
+        self.optimize_strategy = optimize_strategy
 
         # {Layer_class_name: {dbattribute: {Layer_class, cardinality, Layer_domain, key_field, value_field]}
         self.bags_of_enum = dict()

modelbaker/dbconnector/db_connector.py

@@ -76,6 +76,7 @@ def get_tables_info(self):
                 extent [a string: "xmin;ymin;xmax;ymax"]
                 table_alias
                 model
+                relevance
         """
         return []
 

modelbaker/dbconnector/gpkg_connector.py

@@ -140,7 +140,77 @@ def _get_tables_info(self):
                     GROUP BY tablename
                 )  as coord_decimals,
                 substr(c.iliname, 0, instr(c.iliname, '.')) AS model,
-                attrs.sqlname as attribute_name, """
+                attrs.sqlname as attribute_name,
+                {relevance_field},
+                {topics},""".format(
+                relevance_field="""CASE WHEN c.iliname IN (
+                            -- used to get the class names from the full names
+                            WITH names AS (
+                            WITH class_level_name AS(
+                                WITH topic_level_name AS (
+                                    SELECT
+                                    thisClass as fullname,
+                                    substr(thisClass, 0, instr(thisClass, '.')) as model,
+                                    substr(ltrim(thisClass,substr(thisClass, 0, instr(thisClass, '.'))),2) as topicclass
+                                    FROM T_ILI2DB_INHERITANCE
+                                )
+                                SELECT *, ltrim(topicclass,substr(topicclass, 0, instr(topicclass, '.'))) as class_with_dot
+                                FROM topic_level_name
+                            )
+                            SELECT fullname, model, topicclass, substr(class_with_dot, instr(class_with_dot,'.')+1) as class
+                            FROM class_level_name
+                            )
+                            SELECT i.baseClass as base
+                            FROM T_ILI2DB_INHERITANCE i
+                            LEFT JOIN names extend_names
+                            ON thisClass = extend_names.fullname
+                            LEFT JOIN names base_names
+                            ON baseClass = base_names.fullname
+                            -- it's extended
+                            WHERE baseClass IS NOT NULL
+                            -- in a different model
+                            AND base_names.model != extend_names.model
+                            AND (
+                                -- with the same name
+                                base_names.class = extend_names.class
+                                OR
+                                -- multiple times in the same extended model
+                                (SELECT MAX(count) FROM (SELECT COUNT(baseClass) AS count FROM T_ILI2DB_INHERITANCE JOIN names extend_names ON thisClass = extend_names.fullname WHERE baseClass = i.baseClass GROUP BY baseClass, extend_names.model) AS counts )>1
+                            )
+                        )
+                        THEN FALSE ELSE TRUE END AS relevance""",
+                # topics - where this class or an instance of it is located - are emitted by going recursively through the inheritance table.
+                # if something of this topic where the current class is located has been extended, it gets the next child topic.
+                # the relevant topics for optimization are the ones that are not more extended (or in the very last class).
+                topics="""(SELECT group_concat(childTopic) FROM {topic_pedigree}) as all_topics,
+                        (SELECT group_concat(childTopic) FROM {topic_pedigree} WHERE NOT is_a_base) as relevant_topics""".format(
+                    topic_pedigree="""(WITH RECURSIVE children(is_a_base, childTopic, baseTopic) AS (
+                        SELECT
+                        (CASE
+                            WHEN substr( thisClass, 0, instr(substr( thisClass, instr(thisClass, '.')+1), '.')+instr(thisClass, '.')) IN (SELECT substr( i.baseClass, 0, instr(substr( i.baseClass, instr(i.baseClass, '.')+1), '.')+instr(i.baseClass, '.')) FROM T_ILI2DB_INHERITANCE i WHERE substr( i.thisClass, 0, instr(i.thisClass, '.') ) != substr( i.baseClass, 0, instr(i.baseClass, '.')))
+                            THEN TRUE
+                            ELSE FALSE
+                        END) AS is_a_base,
+                        substr( thisClass, 0, instr(substr( thisClass, instr(thisClass, '.')+1), '.')+instr(thisClass, '.')) as childTopic,
+                        substr( baseClass, 0, instr(substr( baseClass, instr(baseClass, '.')+1), '.')+instr(baseClass, '.')) as baseTopic
+                        FROM T_ILI2DB_INHERITANCE
+                        WHERE baseTopic = substr( c.iliname, 0, instr(substr( c.iliname, instr(c.iliname, '.')+1), '.')+instr(c.iliname, '.'))
+                        UNION
+                        SELECT
+                        (CASE
+                            WHEN substr( thisClass, 0, instr(substr( thisClass, instr(thisClass, '.')+1), '.')+instr(thisClass, '.')) IN (SELECT substr( i.baseClass, 0, instr(substr( i.baseClass, instr(i.baseClass, '.')+1), '.')+instr(i.baseClass, '.')) FROM T_ILI2DB_INHERITANCE i WHERE substr( i.thisClass, 0, instr(i.thisClass, '.')) != substr( i.baseClass, 0,instr(i.baseClass, '.')))
+                            THEN TRUE
+                            ELSE FALSE
+                        END) AS is_a_base,
+                        substr( inheritance.thisClass, 0, instr(substr( inheritance.thisClass, instr(inheritance.thisClass, '.')+1), '.')+instr(inheritance.thisClass, '.')) as childTopic ,
+                        substr( inheritance.baseClass, 0, instr(substr( inheritance.baseClass, instr(baseClass, '.')+1), '.')+instr(inheritance.baseClass, '.')) as baseTopic FROM children
+                        JOIN T_ILI2DB_INHERITANCE as inheritance
+                        ON substr( inheritance.baseClass, 0, instr(substr( inheritance.baseClass, instr(inheritance.baseClass, '.')+1), '.')+instr(inheritance.baseClass, '.')) = children.childTopic -- when the childTopic is as well the baseTopic of another childTopic
+                        WHERE substr( inheritance.thisClass, 0, instr(substr( inheritance.thisClass, instr(inheritance.thisClass, '.')+1), '.')+instr(inheritance.thisClass, '.')) != children.childTopic --break the recursion when the coming childTopic will be the same
+                    )
+                    SELECT childTopic, baseTopic, is_a_base FROM children)"""
+                ),
+            )
             interlis_joins = """LEFT JOIN T_ILI2DB_TABLE_PROP p
                    ON p.tablename = s.name
                       AND p.tag = 'ch.ehi.ili2db.tableKind'
@@ -151,7 +221,6 @@ def _get_tables_info(self):
                    ON s.name == c.sqlname
                 LEFT JOIN t_ili2db_attrname attrs
                    ON c.iliname = attrs.iliname """
-
         try:
             cursor.execute(
                 """
@@ -755,12 +824,26 @@ def get_topics_info(self):
             cursor.execute(
                 """
                     SELECT DISTINCT substr(CN.IliName, 0, instr(CN.IliName, '.')) as model,
-                    substr(substr(CN.IliName, instr(CN.IliName, '.')+1),0, instr(substr(CN.IliName, instr(CN.IliName, '.')+1),'.')) as topic
+                    substr(substr(CN.IliName, instr(CN.IliName, '.')+1),0, instr(substr(CN.IliName, instr(CN.IliName, '.')+1),'.')) as topic,
+                    {relevance}
                     FROM T_ILI2DB_CLASSNAME as CN
                     JOIN T_ILI2DB_TABLE_PROP as TP
                     ON CN.sqlname = TP.tablename
 					WHERE topic != '' and TP.setting != 'ENUM'
-                """
+                """.format(
+                    # it's relevant, when it's not extended
+                    # relevance is emitted by going recursively through the inheritance table. If nothing on this topic is extended, it is relevant. Otherwise it's not.
+                    relevance="""
+                        CASE WHEN (WITH RECURSIVE children(childTopic, baseTopic) AS (
+                        SELECT substr( thisClass, 0, instr(substr( thisClass, instr(thisClass, '.')+1), '.')+instr(thisClass, '.')) as childTopic , substr( baseClass, 0, instr(substr( baseClass, instr(baseClass, '.')+1), '.')+instr(baseClass, '.')) as baseTopic
+                        FROM T_ILI2DB_INHERITANCE
+                        WHERE baseTopic = substr( CN.IliName, 0, instr(substr( CN.IliName, instr(CN.IliName, '.')+1), '.')+instr(CN.IliName, '.')) -- model.topic
+                        UNION
+                        SELECT substr( inheritance.thisClass, 0, instr(substr( inheritance.thisClass, instr(inheritance.thisClass, '.')+1), '.')+instr(inheritance.thisClass, '.')) as childTopic , substr( inheritance.baseClass, 0, instr(substr( inheritance.baseClass, instr(baseClass, '.')+1), '.')+instr(inheritance.baseClass, '.')) as baseTopic FROM children
+                        JOIN T_ILI2DB_INHERITANCE as inheritance ON substr( inheritance.baseClass, 0, instr(substr( inheritance.baseClass, instr(baseClass, '.')+1), '.')+instr(inheritance.baseClass, '.')) = children.childTopic
+                        )SELECT count(childTopic) FROM children)>0 THEN FALSE ELSE TRUE END AS relevance
+                    """
+                )
             )
             contents = cursor.fetchall()
             cursor.close()