def run_aggregate(self,
relation: QgsRelation,
features: [QgsFeature],
data=None):
if len(features) == 0:
return
conditions = []
for referencing, referenced in relation.fieldPairs().items():
break
field = relation.referencedLayer().fields().field(referenced)
quote = "" if field.isNumeric() else "'"
for feature in features:
base_condition = '{fk} = {quote}{parent_id}{quote}'.format(
fk=referencing,
parent_id=feature.attribute(referenced),
quote=quote,
)
condition = "( {filter} AND {field} = aggregate(layer:='{lyr}', aggregate:='{agg}', expression:={field}, filter:={filter}) )".format(
filter=base_condition,
field=data[1],
lyr=relation.referencingLayer().id(),
agg=data[0])
conditions.append(condition)
expression = ' OR '.join(conditions)
self.iface.showAttributeTable(relation.referencingLayer(), expression)
def show_children(self,
relation: QgsRelation,
features: [QgsFeature],
data=None):
"""
:param relation: the relation
:param features: the list of feature on the referenced layer
:return:
"""
if len(features) == 0:
return
# works only for single key relation
for referencing, referenced in relation.fieldPairs().items():
break
expression = '{fk} IN ({parent_ids})'.format(
fk=referencing,
parent_ids=', '.join([
"{escape_referenced}{referenced}{escape_referenced}".format(
referenced=str(f.attribute(referenced)),
escape_referenced="'" if not relation.referencedLayer(
).fields().field(referenced).isNumeric() else '')
for f in features
]))
self.iface.showAttributeTable(relation.referencingLayer(), expression)
def create(layer_wrapper: LayerWrapper, relation_manager: QgsRelationManager,
relation: QgsRelation) -> 'RelationalLayerWrapper':
referencing_layer: QgsVectorLayer = relation.referencingLayer()
try:
other_relation: QgsRelation = [r for r in relation_manager.referencingRelations(referencing_layer)
if r.id() != relation.id()][0]
except KeyError:
raise QaavaLayerError(tr('Relation error'), bar_msg(
tr('Relation {} does not contain referencing another layer', relation.name())))
relation_layer_wrapper = LayerWrapper.from_qgs_layer(referencing_layer)
a_pk: QgsField = referencing_layer.fields().toList()[relation.referencingFields()[0]]
m_pk_a: QgsField = layer_wrapper.get_layer().fields().toList()[relation.referencedFields()[0]]
fw_m_a = FieldWrapper.from_layer_wrapper(relation_layer_wrapper, a_pk, set(), '')
fw_a = FieldWrapper.from_layer_wrapper(layer_wrapper, m_pk_a, set(), '')
other_layer: QgsVectorLayer = other_relation.referencedLayer()
b_pk = other_layer.fields().toList()[other_relation.referencedFields()[0]]
m_pk_b = referencing_layer.fields().toList()[other_relation.referencingFields()[0]]
fw_m_b = FieldWrapper.from_layer_wrapper(relation_layer_wrapper, m_pk_b, set(), '')
other_layer_wrapper = LayerWrapper.from_qgs_layer(other_layer, relation_layer_wrapper, fw_m_b)
fw_b = FieldWrapper.from_layer_wrapper(other_layer_wrapper, b_pk, set(), '')
return RelationalLayerWrapper(referencing_layer.name(), other_layer.name(), layer_wrapper, fw_m_a,
fw_a, fw_m_b, fw_b)
def testDuplicateFeature(self):
""" test duplicating a feature """
project = QgsProject().instance()
# LAYERS
# - add first layer (parent)
layer1 = QgsVectorLayer("Point?field=fldtxt:string&field=pkid:integer",
"parentlayer", "memory")
# > check first layer (parent)
self.assertTrue(layer1.isValid())
# - set the value for the copy
layer1.setDefaultValueDefinition(1, QgsDefaultValue("rand(1000,2000)"))
# > check first layer (parent)
self.assertTrue(layer1.isValid())
# - add second layer (child)
layer2 = QgsVectorLayer(
"Point?field=fldtxt:string&field=id:integer&field=foreign_key:integer",
"childlayer", "memory")
# > check second layer (child)
self.assertTrue(layer2.isValid())
# - add layers
project.addMapLayers([layer1, layer2])
# FEATURES
# - add 2 features on layer1 (parent)
l1f1orig = QgsFeature()
l1f1orig.setFields(layer1.fields())
l1f1orig.setAttributes(["F_l1f1", 100])
l1f2orig = QgsFeature()
l1f2orig.setFields(layer1.fields())
l1f2orig.setAttributes(["F_l1f2", 101])
# > check by adding features
self.assertTrue(layer1.dataProvider().addFeatures([l1f1orig,
l1f2orig]))
# add 4 features on layer2 (child)
l2f1orig = QgsFeature()
l2f1orig.setFields(layer2.fields())
l2f1orig.setAttributes(["F_l2f1", 201, 100])
l2f2orig = QgsFeature()
l2f2orig.setFields(layer2.fields())
l2f2orig.setAttributes(["F_l2f2", 202, 100])
l2f3orig = QgsFeature()
l2f3orig.setFields(layer2.fields())
l2f3orig.setAttributes(["F_l2f3", 203, 100])
l2f4orig = QgsFeature()
l2f4orig.setFields(layer2.fields())
l2f4orig.setAttributes(["F_l2f4", 204, 101])
# > check by adding features
self.assertTrue(layer2.dataProvider().addFeatures(
[l2f1orig, l2f2orig, l2f3orig, l2f4orig]))
# RELATION
# - create the relationmanager
relMgr = project.relationManager()
# - create the relation
rel = QgsRelation()
rel.setId('rel1')
rel.setName('childrel')
rel.setReferencingLayer(layer2.id())
rel.setReferencedLayer(layer1.id())
rel.addFieldPair('foreign_key', 'pkid')
rel.setStrength(QgsRelation.Composition)
# > check relation
self.assertTrue(rel.isValid())
# - add relation
relMgr.addRelation(rel)
# > check if referencedLayer is layer1
self.assertEqual(rel.referencedLayer(), layer1)
# > check if referencingLayer is layer2
self.assertEqual(rel.referencingLayer(), layer2)
# > check if the layers are correct in relation when loading from relationManager
relations = project.relationManager().relations()
relation = relations[list(relations.keys())[0]]
# > check if referencedLayer is layer1
self.assertEqual(relation.referencedLayer(), layer1)
# > check if referencingLayer is layer2
self.assertEqual(relation.referencingLayer(), layer2)
# > check the relatedfeatures
'''
# testoutput 1
print( "\nAll Features and relations")
featit=layer1.getFeatures()
f=QgsFeature()
while featit.nextFeature(f):
print( f.attributes())
childFeature = QgsFeature()
relfeatit=rel.getRelatedFeatures(f)
while relfeatit.nextFeature(childFeature):
print( childFeature.attributes() )
print( "\n--------------------------")
print( "\nFeatures on layer1")
for f in layer1.getFeatures():
print( f.attributes() )
print( "\nFeatures on layer2")
for f in layer2.getFeatures():
print( f.attributes() )
'''
# DUPLICATION
# - duplicate feature l1f1orig with children
layer1.startEditing()
results = QgsVectorLayerUtils.duplicateFeature(layer1, l1f1orig,
project, 0)
# > check if name is name of duplicated (pk is different)
result_feature = results[0]
self.assertEqual(result_feature.attribute('fldtxt'),
l1f1orig.attribute('fldtxt'))
# > check duplicated child layer
result_layer = results[1].layers()[0]
self.assertEqual(result_layer, layer2)
# > check duplicated child features
self.assertTrue(results[1].duplicatedFeatures(result_layer))
'''
# testoutput 2
print( "\nFeatures on layer1 (after duplication)")
for f in layer1.getFeatures():
print( f.attributes() )
print( "\nFeatures on layer2 (after duplication)")
for f in layer2.getFeatures():
print( f.attributes() )
print( "\nAll Features and relations")
featit=layer1.getFeatures()
f=QgsFeature()
while featit.nextFeature(f):
print( f.attributes())
childFeature = QgsFeature()
relfeatit=rel.getRelatedFeatures(f)
while relfeatit.nextFeature(childFeature):
print( childFeature.attributes() )
'''
# > compare text of parent feature
self.assertEqual(result_feature.attribute('fldtxt'),
l1f1orig.attribute('fldtxt'))
# - create copyValueList
childFeature = QgsFeature()
relfeatit = rel.getRelatedFeatures(result_feature)
copyValueList = []
while relfeatit.nextFeature(childFeature):
copyValueList.append(childFeature.attribute('fldtxt'))
# - create origValueList
childFeature = QgsFeature()
relfeatit = rel.getRelatedFeatures(l1f1orig)
origValueList = []
while relfeatit.nextFeature(childFeature):
origValueList.append(childFeature.attribute('fldtxt'))
# - check if the ids are still the same
self.assertEqual(copyValueList, origValueList)
def testDuplicateFeature(self):
""" test duplicating a feature """
project = QgsProject().instance()
# LAYERS
# - add first layer (parent)
layer1 = QgsVectorLayer("Point?field=fldtxt:string&field=pkid:integer",
"parentlayer", "memory")
# > check first layer (parent)
self.assertTrue(layer1.isValid())
# - set the value for the copy
layer1.setDefaultValueDefinition(1, QgsDefaultValue("rand(1000,2000)"))
# > check first layer (parent)
self.assertTrue(layer1.isValid())
# - add second layer (child)
layer2 = QgsVectorLayer("Point?field=fldtxt:string&field=id:integer&field=foreign_key:integer",
"childlayer", "memory")
# > check second layer (child)
self.assertTrue(layer2.isValid())
# - add layers
project.addMapLayers([layer1, layer2])
# FEATURES
# - add 2 features on layer1 (parent)
l1f1orig = QgsFeature()
l1f1orig.setFields(layer1.fields())
l1f1orig.setAttributes(["F_l1f1", 100])
l1f2orig = QgsFeature()
l1f2orig.setFields(layer1.fields())
l1f2orig.setAttributes(["F_l1f2", 101])
# > check by adding features
self.assertTrue(layer1.dataProvider().addFeatures([l1f1orig, l1f2orig]))
# add 4 features on layer2 (child)
l2f1orig = QgsFeature()
l2f1orig.setFields(layer2.fields())
l2f1orig.setAttributes(["F_l2f1", 201, 100])
l2f2orig = QgsFeature()
l2f2orig.setFields(layer2.fields())
l2f2orig.setAttributes(["F_l2f2", 202, 100])
l2f3orig = QgsFeature()
l2f3orig.setFields(layer2.fields())
l2f3orig.setAttributes(["F_l2f3", 203, 100])
l2f4orig = QgsFeature()
l2f4orig.setFields(layer2.fields())
l2f4orig.setAttributes(["F_l2f4", 204, 101])
# > check by adding features
self.assertTrue(layer2.dataProvider().addFeatures([l2f1orig, l2f2orig, l2f3orig, l2f4orig]))
# RELATION
# - create the relationmanager
relMgr = project.relationManager()
# - create the relation
rel = QgsRelation()
rel.setId('rel1')
rel.setName('childrel')
rel.setReferencingLayer(layer2.id())
rel.setReferencedLayer(layer1.id())
rel.addFieldPair('foreign_key', 'pkid')
rel.setStrength(QgsRelation.Composition)
# > check relation
self.assertTrue(rel.isValid())
# - add relation
relMgr.addRelation(rel)
# > check if referencedLayer is layer1
self.assertEqual(rel.referencedLayer(), layer1)
# > check if referencingLayer is layer2
self.assertEqual(rel.referencingLayer(), layer2)
# > check if the layers are correct in relation when loading from relationManager
relations = project.relationManager().relations()
relation = relations[list(relations.keys())[0]]
# > check if referencedLayer is layer1
self.assertEqual(relation.referencedLayer(), layer1)
# > check if referencingLayer is layer2
self.assertEqual(relation.referencingLayer(), layer2)
# > check the relatedfeatures
'''
# testoutput 1
print( "\nAll Features and relations")
featit=layer1.getFeatures()
f=QgsFeature()
while featit.nextFeature(f):
print( f.attributes())
childFeature = QgsFeature()
relfeatit=rel.getRelatedFeatures(f)
while relfeatit.nextFeature(childFeature):
print( childFeature.attributes() )
print( "\n--------------------------")
print( "\nFeatures on layer1")
for f in layer1.getFeatures():
print( f.attributes() )
print( "\nFeatures on layer2")
for f in layer2.getFeatures():
print( f.attributes() )
'''
# DUPLICATION
# - duplicate feature l1f1orig with children
layer1.startEditing()
results = QgsVectorLayerUtils.duplicateFeature(layer1, l1f1orig, project, 0)
# > check if name is name of duplicated (pk is different)
result_feature = results[0]
self.assertEqual(result_feature.attribute('fldtxt'), l1f1orig.attribute('fldtxt'))
# > check duplicated child layer
result_layer = results[1].layers()[0]
self.assertEqual(result_layer, layer2)
# > check duplicated child features
self.assertTrue(results[1].duplicatedFeatures(result_layer))
'''
# testoutput 2
print( "\nFeatures on layer1 (after duplication)")
for f in layer1.getFeatures():
print( f.attributes() )
print( "\nFeatures on layer2 (after duplication)")
for f in layer2.getFeatures():
print( f.attributes() )
print( "\nAll Features and relations")
featit=layer1.getFeatures()
f=QgsFeature()
while featit.nextFeature(f):
print( f.attributes())
childFeature = QgsFeature()
relfeatit=rel.getRelatedFeatures(f)
while relfeatit.nextFeature(childFeature):
print( childFeature.attributes() )
'''
# > compare text of parent feature
self.assertEqual(result_feature.attribute('fldtxt'), l1f1orig.attribute('fldtxt'))
# - create copyValueList
childFeature = QgsFeature()
relfeatit = rel.getRelatedFeatures(result_feature)
copyValueList = []
while relfeatit.nextFeature(childFeature):
copyValueList.append(childFeature.attribute('fldtxt'))
# - create origValueList
childFeature = QgsFeature()
relfeatit = rel.getRelatedFeatures(l1f1orig)
origValueList = []
while relfeatit.nextFeature(childFeature):
origValueList.append(childFeature.attribute('fldtxt'))
# - check if the ids are still the same
self.assertEqual(copyValueList, origValueList)
def batch_insert(self,
relation: QgsRelation,
features: [QgsFeature],
data=None):
"""
:param relation: the relation
:param features: the list of feature on the referenced layer
:return:
"""
layer = relation.referencingLayer()
if not layer.isEditable():
self.iface.messageBar().pushMessage(
'Relation Batch Insert',
self.tr('layer "{layer}" is not editable').format(
layer=layer.name()), Qgis.Warning)
return
if len(features) < 1:
self.iface.messageBar().pushMessage(
'Relation Batch Insert',
self.
tr('There is no features to batch insert for. Select some in layer "{layer}" first.'
).format(layer=relation.referencedLayer().name()),
Qgis.Warning)
return
default_values = {}
orignal_cfg = {}
first_feature_created = False
referencing_feature = QgsFeature()
features_written = 0
ok = True
for referenced_feature in features:
# define values for the referencing field over the possible several field pairs
for referencing_field, referenced_field in relation.fieldPairs(
).items():
referencing_field_index = relation.referencingLayer().fields(
).indexFromName(referencing_field)
# disabled the widgets for the referenced feature in the form (since it will be replaced)
if not first_feature_created:
default_values[
referencing_field_index] = referenced_feature[
referenced_field]
orignal_cfg[
referencing_field_index] = layer.editorWidgetSetup(
referencing_field_index)
layer.setEditorWidgetSetup(
referencing_field_index,
QgsEditorWidgetSetup('Hidden', {}))
else:
# it has been created at previous iteration
referencing_feature[
referencing_field_index] = referenced_feature[
referenced_field]
if not first_feature_created:
# show form for the feature with disabled widgets for the referencing fields
ok, referencing_feature = self.iface.vectorLayerTools(
).addFeature(layer, default_values, QgsGeometry())
if not ok:
break
# restore widget config of the layer
for index, cfg in orignal_cfg.items():
layer.setEditorWidgetSetup(index, cfg)
first_feature_created = True
else:
ok = layer.addFeature(referencing_feature)
if not ok:
break
features_written += 1
if ok:
self.iface.messageBar().pushMessage(
'Relation Batch Insert',
self.tr('{count} features were written to "{layer}"').format(
count=features_written, layer=layer.name()))
else:
self.iface.messageBar().pushMessage(
'Relation Batch Insert',
self.tr('There was an error while inserting features, '
'{count} features were written to "{layer}", '
'{expected_count} were expected.').format(
count=features_written,
layer=layer.name(),
expected_count=len(features)), Qgis.Critical)
def import_in_qgis(gmlas_uri, provider, schema=None):
"""Imports layers from a GMLAS file in QGIS with relations and editor widgets
@param gmlas_uri connection parameters
@param provider name of the QGIS provider that handles gmlas_uri parameters (postgresql or spatialite)
@param schema name of the PostgreSQL schema where tables and metadata tables are
"""
if schema is not None:
schema_s = schema + "."
else:
schema_s = ""
ogr.UseExceptions()
drv = ogr.GetDriverByName(provider)
ds = drv.Open(gmlas_uri)
if ds is None:
raise RuntimeError("Problem opening {}".format(gmlas_uri))
# get list of layers
sql = "select o.*, g.f_geometry_column, g.srid from {}_ogr_layers_metadata o left join geometry_columns g on g.f_table_name = o.layer_name".format(
schema_s)
couches = ds.ExecuteSQL(sql)
layers = {}
for f in couches:
ln = f.GetField("layer_name")
if ln not in layers:
layers[ln] = {
"uid": f.GetField("layer_pkid_name"),
"category": f.GetField("layer_category"),
"xpath": f.GetField("layer_xpath"),
"parent_pkid": f.GetField("layer_parent_pkid_name"),
"srid": f.GetField("srid"),
"geometry_column": f.GetField("f_geometry_column"),
"1_n": [], # 1:N relations
"layer_id": None,
"layer_name": ln,
"layer": None,
"fields": [],
}
else:
# additional geometry columns
g = f.GetField("f_geometry_column")
k = "{} ({})".format(ln, g)
layers[k] = dict(layers[ln])
layers[k]["geometry_column"] = g
# collect fields with xlink:href
href_fields = {}
for ln, layer in layers.items():
layer_name = layer["layer_name"]
for f in ds.ExecuteSQL(
"select field_name, field_xpath from {}_ogr_fields_metadata where layer_name='{}'"
.format(schema_s, layer_name)):
field_name, field_xpath = f.GetField("field_name"), f.GetField(
"field_xpath")
if field_xpath and field_xpath.endswith("@xlink:href"):
if ln not in href_fields:
href_fields[ln] = []
href_fields[ln].append(field_name)
# with unknown srid, don't ask for each layer, set to a default
settings = QgsSettings()
projection_behavior = settings.value("Projections/defaultBehavior")
projection_default = settings.value("Projections/layerDefaultCrs")
settings.setValue("Projections/defaultBehavior", "useGlobal")
settings.setValue("Projections/layerDefaultCrs", "EPSG:4326")
# add layers
crs = QgsCoordinateReferenceSystem("EPSG:4326")
for ln in sorted(layers.keys()):
lyr = layers[ln]
g_column = lyr["geometry_column"] or None
couches = _qgis_layer(
gmlas_uri,
schema,
lyr["layer_name"],
g_column,
provider,
ln,
lyr["xpath"],
lyr["uid"],
)
if not couches.isValid():
raise RuntimeError("Problem loading layer {} with {}".format(
ln, couches.source()))
if g_column is not None:
if lyr["srid"]:
crs = QgsCoordinateReferenceSystem("EPSG:{}".format(
lyr["srid"]))
couches.setCrs(crs)
QgsProject.instance().addMapLayer(couches)
layers[ln]["layer_id"] = couches.id()
layers[ln]["layer"] = couches
# save fields which represent a xlink:href
if ln in href_fields:
couches.setCustomProperty("href_fields", href_fields[ln])
# save gmlas_uri
couches.setCustomProperty("ogr_uri", gmlas_uri)
couches.setCustomProperty("ogr_schema", schema)
# change icon the layer has a custom viewer
xpath = no_ns(couches.customProperty("xpath", ""))
for viewer_cls, _ in get_custom_viewers().values():
tag = no_prefix(viewer_cls.xml_tag())
if tag == xpath:
lg = CustomViewerLegend(viewer_cls.name(), viewer_cls.icon())
couches.setLegend(lg)
# restore settings
settings.setValue("Projections/defaultBehavior", projection_behavior)
settings.setValue("Projections/layerDefaultCrs", projection_default)
# add 1:1 relations
relations_1_1 = []
sql = """
select
layer_name, field_name, field_related_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.parent_element_name = f.field_name
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs=1
""".format(schema_s)
couches = ds.ExecuteSQL(sql)
if couches is not None:
for f in couches:
rel = QgsRelation()
rel.setId("1_1_" + f.GetField("layer_name") + "_" +
f.GetField("field_name"))
rel.setName("1_1_" + f.GetField("layer_name") + "_" +
f.GetField("field_name"))
# parent layer
rel.setReferencingLayer(
layers[f.GetField("layer_name")]["layer_id"])
# child layer
rel.setReferencedLayer(
layers[f.GetField("field_related_layer")]["layer_id"])
# parent, child
rel.addFieldPair(f.GetField("field_name"),
f.GetField("child_pkid"))
# rel.generateId()
if rel.isValid():
relations_1_1.append(rel)
# add 1:N relations
relations_1_n = []
sql = """
select
layer_name, r.parent_pkid, field_related_layer as child_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs>1
-- junctions - 1st way
union all
select
layer_name, r.parent_pkid, field_junction_layer as child_layer, 'parent_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
-- junctions - 2nd way
union all
select
field_related_layer as layer_name, r.child_pkid, field_junction_layer as child_layer, 'child_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
""".format(schema_s)
couches = ds.ExecuteSQL(sql)
if couches is not None:
for f in couches:
parent_layer = f.GetField("layer_name")
child_layer = f.GetField("child_layer")
if parent_layer not in layers or child_layer not in layers:
continue
rel = QgsRelation()
rel.setId("1_n_" + f.GetField("layer_name") + "_" +
f.GetField("child_layer") + "_" +
f.GetField("parent_pkid") + "_" +
f.GetField("child_pkid"))
rel.setName(f.GetField("child_layer"))
# parent layer
rel.setReferencedLayer(layers[parent_layer]["layer_id"])
# child layer
rel.setReferencingLayer(layers[child_layer]["layer_id"])
# parent, child
rel.addFieldPair(f.GetField("child_pkid"),
f.GetField("parent_pkid"))
# rel.addFieldPair(f.GetField('child_pkid'), 'ogc_fid')
if rel.isValid():
relations_1_n.append(rel)
# add relation to layer
layers[f.GetField("layer_name")]["1_n"].append(rel)
for rel in relations_1_1 + relations_1_n:
QgsProject.instance().relationManager().addRelation(rel)
# add "show form" option to 1:1 relations
for rel in relations_1_1:
couches = rel.referencingLayer()
idx = rel.referencingFields()[0]
s = QgsEditorWidgetSetup(
"RelationReference",
{
"AllowNULL": False,
"ReadOnly": True,
"Relation": rel.id(),
"OrderByValue": False,
"MapIdentification": False,
"AllowAddFeatures": False,
"ShowForm": True,
},
)
couches.setEditorWidgetSetup(idx, s)
# setup form for layers
for layer, lyr in layers.items():
couche = lyr["layer"]
fc = couche.editFormConfig()
fc.clearTabs()
fc.setLayout(QgsEditFormConfig.TabLayout)
# Add fields
c = QgsAttributeEditorContainer("Main", fc.invisibleRootContainer())
c.setIsGroupBox(False) # a tab
for idx, f in enumerate(couche.fields()):
c.addChildElement(QgsAttributeEditorField(f.name(), idx, c))
fc.addTab(c)
# Add 1:N relations
c_1_n = QgsAttributeEditorContainer("1:N links",
fc.invisibleRootContainer())
c_1_n.setIsGroupBox(False) # a tab
fc.addTab(c_1_n)
for rel in lyr["1_n"]:
c_1_n.addChildElement(
QgsAttributeEditorRelation(rel.name(), rel, c_1_n))
couche.setEditFormConfig(fc)
install_viewer_on_feature_form(couche)
class LinkerDock(QDockWidget, Ui_linker, SettingDialog):
def __init__(self, iface):
# QGIS
self.iface = iface
self.settings = MySettings()
self.linkRubber = QgsRubberBand(self.iface.mapCanvas())
self.featureHighlight = None
# Relation management
self.relationManager = QgsProject.instance().relationManager()
self.relationManager.changed.connect(self.loadRelations)
self.relation = QgsRelation()
self.referencingFeature = QgsFeature()
self.relationWidgetWrapper = None
self.editorContext = QgsAttributeEditorContext()
self.editorContext.setVectorLayerTools(self.iface.vectorLayerTools())
# GUI
QDockWidget.__init__(self)
self.setupUi(self)
SettingDialog.__init__(self, MySettings(), False, True)
self.drawButton.setChecked(self.settings.value("drawEnabled"))
self.relationReferenceWidget.setAllowMapIdentification(True)
self.relationReferenceWidget.setEmbedForm(False)
self.mapTool = QgsMapToolIdentifyFeature(self.iface.mapCanvas())
self.mapTool.setButton(self.identifyReferencingFeatureButton)
# Connect signal/slot
self.relationComboBox.currentIndexChanged.connect(self.currentRelationChanged)
self.mapTool.featureIdentified.connect(self.setReferencingFeature)
# load relations at start
self.loadRelations()
def showEvent(self, QShowEvent):
self.drawLink()
def closeEvent(self, e):
self.iface.mapCanvas().unsetMapTool(self.mapTool)
self.linkRubber.reset()
self.deleteHighlight()
self.deleteWrapper()
self.disconnectLayer()
def disconnectLayer(self):
if self.relation.isValid():
self.relation.referencingLayer().editingStarted.disconnect(self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.disconnect(self.relationEditableChanged)
self.relation.referencingLayer().attributeValueChanged.disconnect(self.layerValueChangedOutside)
def runForFeature(self, relationId, layer, feature):
index = self.relationComboBox.findData(relationId)
self.relationComboBox.setCurrentIndex(index)
self.setReferencingFeature(feature)
self.show()
if not layer.isEditable():
self.iface.messageBar().pushMessage("Link It", "Cannot set a new related feature since %s is not editable" % layer.name(), QgsMessageBar.WARNING, 4)
else:
self.relationReferenceWidget.mapIdentification()
@pyqtSlot(name="on_identifyReferencingFeatureButton_clicked")
def activateMapTool(self):
self.iface.mapCanvas().setMapTool(self.mapTool)
def deactivateMapTool(self):
self.iface.mapCanvas().unsetMapTool(self.mapTool)
def loadRelations(self):
self.deleteWrapper()
self.disconnectLayer()
self.relation = QgsRelation()
self.referencingFeature = QgsFeature()
self.relationComboBox.currentIndexChanged.disconnect(self.currentRelationChanged)
self.relationComboBox.clear()
for relation in self.relationManager.referencedRelations():
if relation.referencingLayer().hasGeometryType():
self.relationComboBox.addItem(relation.name(), relation.id())
self.relationComboBox.setCurrentIndex(-1)
self.relationComboBox.currentIndexChanged.connect(self.currentRelationChanged)
self.currentRelationChanged(-1)
def currentRelationChanged(self, index):
# disconnect previous relation
if self.relation.isValid():
try:
self.relation.referencingLayer().editingStarted.disconnect(self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.disconnect(self.relationEditableChanged)
self.relation.referencingLayer().attributeValueChanged.disconnect(self.layerValueChangedOutside)
except TypeError:
pass
self.referencingFeatureLayout.setEnabled(index >= 0)
relationId = self.relationComboBox.itemData(index)
self.relation = self.relationManager.relation(relationId)
self.mapTool.setLayer(self.relation.referencingLayer())
self.setReferencingFeature()
# connect
if self.relation.isValid():
self.relation.referencingLayer().editingStarted.connect(self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.connect(self.relationEditableChanged)
self.relation.referencingLayer().attributeValueChanged.connect(self.layerValueChangedOutside)
def setReferencingFeature(self, feature=QgsFeature()):
self.deactivateMapTool()
self.referencingFeature = QgsFeature(feature)
self.deleteWrapper()
# disable relation reference widget if no referencing feature
self.referencedFeatureLayout.setEnabled(feature.isValid())
# set line edit
if not self.relation.isValid() or not feature.isValid():
self.referencingFeatureLineEdit.clear()
return
self.referencingFeatureLineEdit.setText("%s" % feature.id())
fieldIdx = self.referencingFieldIndex()
widgetConfig = self.relation.referencingLayer().editorWidgetV2Config(fieldIdx)
self.relationWidgetWrapper = QgsEditorWidgetRegistry.instance().create("RelationReference",
self.relation.referencingLayer(),
fieldIdx,
widgetConfig,
self.relationReferenceWidget,
self,
self.editorContext)
self.relationWidgetWrapper.setEnabled(self.relation.referencingLayer().isEditable())
self.relationWidgetWrapper.setValue(feature[fieldIdx])
self.relationWidgetWrapper.valueChanged.connect(self.foreignKeyChanged)
# override field definition to allow map identification
self.relationReferenceWidget.setAllowMapIdentification(True)
self.relationReferenceWidget.setEmbedForm(False)
# update drawn link
self.highlightReferencingFeature()
self.drawLink()
def deleteWrapper(self):
if self.relationWidgetWrapper is not None:
self.relationWidgetWrapper.valueChanged.disconnect(self.foreignKeyChanged)
self.relationWidgetWrapper.setValue(None)
del self.relationWidgetWrapper
self.relationWidgetWrapper = None
def foreignKeyChanged(self, newKey):
if not self.relation.isValid() or not self.relation.referencingLayer().isEditable() or not self.referencingFeature.isValid():
self.drawLink()
return
if not self.relation.referencingLayer().editBuffer().changeAttributeValue(self.referencingFeature.id(), self.referencingFieldIndex(), newKey):
self.iface.messageBar().pushMessage("Link It", "Cannot change attribute value.", QgsMessageBar.CRITICAL)
self.drawLink()
def relationEditableChanged(self):
if self.relationWidgetWrapper is not None:
self.relationWidgetWrapper.setEnabled(self.relation.isValid() and self.relation.referencingLayer().isEditable())
def layerValueChangedOutside(self, fid, fieldIdx, value):
if not self.relation.isValid() or not self.referencingFeature.isValid() or self.relationWidgetWrapper is None:
return
# not the correct feature
if fid != self.referencingFeature.id():
return
# not the correct field
if fieldIdx != self.referencingFieldIndex():
return
# widget already has this value
if value == self.relationWidgetWrapper.value():
return
self.relationWidgetWrapper.valueChanged.disconnect(self.foreignKeyChanged)
self.relationWidgetWrapper.setValue(value)
self.relationWidgetWrapper.valueChanged.connect(self.foreignKeyChanged)
def referencingFieldIndex(self):
if not self.relation.isValid():
return -1
fieldName = self.relation.fieldPairs().keys()[0]
fieldIdx = self.relation.referencingLayer().fieldNameIndex(fieldName)
return fieldIdx
@pyqtSlot(bool, name="on_drawButton_toggled")
def drawLink(self):
self.settings.setValue("drawEnabled", self.drawButton.isChecked())
self.linkRubber.reset()
if not self.drawButton.isChecked() or not self.referencingFeature.isValid() or not self.relation.isValid():
return
referencedFeature = self.relationReferenceWidget.referencedFeature()
if not referencedFeature.isValid():
return
p1 = self.centroid(self.relation.referencedLayer(), referencedFeature)
p2 = self.centroid(self.relation.referencingLayer(), self.referencingFeature)
geom = arc(p1, p2)
self.linkRubber.setToGeometry(geom, None)
self.linkRubber.setWidth(self.settings.value("rubberWidth"))
self.linkRubber.setColor(self.settings.value("rubberColor"))
self.linkRubber.setLineStyle(Qt.DashLine)
def centroid(self, layer, feature):
geom = feature.geometry()
if geom.type() == QGis.Line:
geom = geom.interpolate(geom.length()/2)
else:
geom = geom.centroid()
return self.iface.mapCanvas().mapSettings().layerToMapCoordinates(layer, geom.asPoint())
@pyqtSlot(name="on_highlightReferencingFeatureButton_clicked")
def highlightReferencingFeature(self):
self.deleteHighlight()
if not self.relation.isValid() or not self.referencingFeature.isValid():
return
self.featureHighlight = QgsHighlight(self.iface.mapCanvas(), self.referencingFeature.geometry(), self.relation.referencingLayer())
settings = QSettings()
color = QColor( settings.value("/Map/highlight/color", QGis.DEFAULT_HIGHLIGHT_COLOR.name()))
alpha = int(settings.value("/Map/highlight/colorAlpha", QGis.DEFAULT_HIGHLIGHT_COLOR.alpha()))
bbuffer = float(settings.value("/Map/highlight/buffer", QGis.DEFAULT_HIGHLIGHT_BUFFER_MM))
minWidth = float(settings.value("/Map/highlight/minWidth", QGis.DEFAULT_HIGHLIGHT_MIN_WIDTH_MM))
self.featureHighlight.setColor(color)
color.setAlpha(alpha)
self.featureHighlight.setFillColor(color)
self.featureHighlight.setBuffer(bbuffer)
self.featureHighlight.setMinWidth(minWidth)
self.featureHighlight.show()
timer = QTimer(self)
timer.setSingleShot(True)
timer.timeout.connect(self.deleteHighlight)
timer.start(3000)
def deleteHighlight(self):
if self.featureHighlight:
del self.featureHighlight
self.featureHighlight = None
def import_in_qgis(gmlas_uri, provider, schema = None):
"""Imports layers from a GMLAS file in QGIS with relations and editor widgets
@param gmlas_uri connection parameters
@param provider name of the QGIS provider that handles gmlas_uri parameters (postgresql or spatialite)
@param schema name of the PostgreSQL schema where tables and metadata tables are
"""
if schema is not None:
schema_s = schema + "."
else:
schema_s = ""
ogr.UseExceptions()
drv = ogr.GetDriverByName(provider)
ds = drv.Open(gmlas_uri)
if ds is None:
raise RuntimeError("Problem opening {}".format(gmlas_uri))
# get list of layers
sql = "select o.*, g.f_geometry_column, g.srid from {}_ogr_layers_metadata o left join geometry_columns g on g.f_table_name = o.layer_name".format(schema_s)
l = ds.ExecuteSQL(sql)
layers = {}
for f in l:
ln = f.GetField("layer_name")
if ln not in layers:
layers[ln] = {
'uid': f.GetField("layer_pkid_name"),
'category': f.GetField("layer_category"),
'xpath': f.GetField("layer_xpath"),
'parent_pkid': f.GetField("layer_parent_pkid_name"),
'srid': f.GetField("srid"),
'geometry_column': f.GetField("f_geometry_column"),
'1_n' : [], # 1:N relations
'layer_id': None,
'layer_name' : ln,
'layer': None,
'fields' : []}
else:
# additional geometry columns
g = f.GetField("f_geometry_column")
k = "{} ({})".format(ln, g)
layers[k] = dict(layers[ln])
layers[k]["geometry_column"] = g
# collect fields with xlink:href
href_fields = {}
for ln, layer in layers.items():
layer_name = layer["layer_name"]
for f in ds.ExecuteSQL("select field_name, field_xpath from {}_ogr_fields_metadata where layer_name='{}'".format(schema_s, layer_name)):
field_name, field_xpath = f.GetField("field_name"), f.GetField("field_xpath")
if field_xpath and field_xpath.endswith("@xlink:href"):
if ln not in href_fields:
href_fields[ln] = []
href_fields[ln].append(field_name)
# with unknown srid, don't ask for each layer, set to a default
settings = QgsSettings()
projection_behavior = settings.value("Projections/defaultBehavior")
projection_default = settings.value("Projections/layerDefaultCrs")
settings.setValue("Projections/defaultBehavior", "useGlobal")
settings.setValue("Projections/layerDefaultCrs", "EPSG:4326")
# add layers
crs = QgsCoordinateReferenceSystem("EPSG:4326")
for ln in sorted(layers.keys()):
lyr = layers[ln]
g_column = lyr["geometry_column"] or None
l = _qgis_layer(gmlas_uri, schema, lyr["layer_name"], g_column, provider, ln, lyr["xpath"], lyr["uid"])
if not l.isValid():
raise RuntimeError("Problem loading layer {} with {}".format(ln, l.source()))
if g_column is not None:
if lyr["srid"]:
crs = QgsCoordinateReferenceSystem("EPSG:{}".format(lyr["srid"]))
l.setCrs(crs)
QgsProject.instance().addMapLayer(l)
layers[ln]['layer_id'] = l.id()
layers[ln]['layer'] = l
# save fields which represent a xlink:href
if ln in href_fields:
l.setCustomProperty("href_fields", href_fields[ln])
# save gmlas_uri
l.setCustomProperty("ogr_uri", gmlas_uri)
l.setCustomProperty("ogr_schema", schema)
# change icon the layer has a custom viewer
xpath = no_ns(l.customProperty("xpath", ""))
for viewer_cls, _ in get_custom_viewers().values():
tag = no_prefix(viewer_cls.xml_tag())
if tag == xpath:
lg = CustomViewerLegend(viewer_cls.name(), viewer_cls.icon())
l.setLegend(lg)
# restore settings
settings.setValue("Projections/defaultBehavior", projection_behavior)
settings.setValue("Projections/layerDefaultCrs", projection_default)
# add 1:1 relations
relations_1_1 = []
sql = """
select
layer_name, field_name, field_related_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.parent_element_name = f.field_name
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs=1
""".format(schema_s)
l = ds.ExecuteSQL(sql)
if l is not None:
for f in l:
rel = QgsRelation()
rel.setId('1_1_' + f.GetField('layer_name') + '_' + f.GetField('field_name'))
rel.setName('1_1_' + f.GetField('layer_name') + '_' + f.GetField('field_name'))
# parent layer
rel.setReferencingLayer(layers[f.GetField('layer_name')]['layer_id'])
# child layer
rel.setReferencedLayer(layers[f.GetField('field_related_layer')]['layer_id'])
# parent, child
rel.addFieldPair(f.GetField('field_name'), f.GetField('child_pkid'))
#rel.generateId()
if rel.isValid():
relations_1_1.append(rel)
# add 1:N relations
relations_1_n = []
sql = """
select
layer_name, r.parent_pkid, field_related_layer as child_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs>1
-- junctions - 1st way
union all
select
layer_name, r.parent_pkid, field_junction_layer as child_layer, 'parent_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
-- junctions - 2nd way
union all
select
field_related_layer as layer_name, r.child_pkid, field_junction_layer as child_layer, 'child_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
""".format(schema_s)
l = ds.ExecuteSQL(sql)
if l is not None:
for f in l:
parent_layer = f.GetField("layer_name")
child_layer = f.GetField("child_layer")
if parent_layer not in layers or child_layer not in layers:
continue
rel = QgsRelation()
rel.setId('1_n_' + f.GetField('layer_name') + '_' + f.GetField('child_layer') + '_' + f.GetField('parent_pkid') + '_' + f.GetField('child_pkid'))
rel.setName(f.GetField('child_layer'))
# parent layer
rel.setReferencedLayer(layers[parent_layer]['layer_id'])
# child layer
rel.setReferencingLayer(layers[child_layer]['layer_id'])
# parent, child
rel.addFieldPair(f.GetField('child_pkid'), f.GetField('parent_pkid'))
#rel.addFieldPair(f.GetField('child_pkid'), 'ogc_fid')
if rel.isValid():
relations_1_n.append(rel)
# add relation to layer
layers[f.GetField('layer_name')]['1_n'].append(rel)
for rel in relations_1_1 + relations_1_n:
QgsProject.instance().relationManager().addRelation(rel)
# add "show form" option to 1:1 relations
for rel in relations_1_1:
l = rel.referencingLayer()
idx = rel.referencingFields()[0]
s = QgsEditorWidgetSetup("RelationReference", {'AllowNULL': False,
'ReadOnly': True,
'Relation': rel.id(),
'OrderByValue': False,
'MapIdentification': False,
'AllowAddFeatures': False,
'ShowForm': True})
l.setEditorWidgetSetup(idx, s)
# setup form for layers
for layer, lyr in layers.items():
l = lyr['layer']
fc = l.editFormConfig()
fc.clearTabs()
fc.setLayout(QgsEditFormConfig.TabLayout)
# Add fields
c = QgsAttributeEditorContainer("Main", fc.invisibleRootContainer())
c.setIsGroupBox(False) # a tab
for idx, f in enumerate(l.fields()):
c.addChildElement(QgsAttributeEditorField(f.name(), idx, c))
fc.addTab(c)
# Add 1:N relations
c_1_n = QgsAttributeEditorContainer("1:N links", fc.invisibleRootContainer())
c_1_n.setIsGroupBox(False) # a tab
fc.addTab(c_1_n)
for rel in lyr['1_n']:
c_1_n.addChildElement(QgsAttributeEditorRelation(rel.name(), rel, c_1_n))
l.setEditFormConfig(fc)
install_viewer_on_feature_form(l)
class LinkerDock(QDockWidget, Ui_linker, SettingDialog):
def __init__(self, iface):
# QGIS
self.iface = iface
self.settings = MySettings()
self.linkRubber = QgsRubberBand(self.iface.mapCanvas())
self.featureHighlight = None
# Relation management
self.relationManager = QgsProject.instance().relationManager()
self.relationManager.changed.connect(self.loadRelations)
self.relation = QgsRelation()
self.referencingFeature = QgsFeature()
self.relationWidgetWrapper = None
self.editorContext = QgsAttributeEditorContext()
self.editorContext.setVectorLayerTools(self.iface.vectorLayerTools())
# GUI
QDockWidget.__init__(self)
self.setupUi(self)
SettingDialog.__init__(self, MySettings(), False, True)
self.drawButton.setChecked(self.settings.value("drawEnabled"))
self.relationReferenceWidget.setAllowMapIdentification(True)
self.relationReferenceWidget.setEmbedForm(False)
self.mapTool = QgsMapToolIdentifyFeature(self.iface.mapCanvas())
self.mapTool.setButton(self.identifyReferencingFeatureButton)
# Connect signal/slot
self.relationComboBox.currentIndexChanged.connect(
self.currentRelationChanged)
self.mapTool.featureIdentified.connect(self.setReferencingFeature)
# load relations at start
self.loadRelations()
def showEvent(self, QShowEvent):
self.drawLink()
def closeEvent(self, e):
self.iface.mapCanvas().unsetMapTool(self.mapTool)
self.linkRubber.reset()
self.deleteHighlight()
self.deleteWrapper()
self.disconnectLayer()
def disconnectLayer(self):
if self.relation.isValid():
self.relation.referencingLayer().editingStarted.disconnect(
self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.disconnect(
self.relationEditableChanged)
self.relation.referencingLayer().attributeValueChanged.disconnect(
self.layerValueChangedOutside)
def runForFeature(self, relationId, layer, feature):
index = self.relationComboBox.findData(relationId)
self.relationComboBox.setCurrentIndex(index)
self.setReferencingFeature(feature)
self.show()
if not layer.isEditable():
self.iface.messageBar().pushMessage(
"Link It",
"Cannot set a new related feature since %s is not editable" %
layer.name(), QgsMessageBar.WARNING, 4)
else:
self.relationReferenceWidget.mapIdentification()
@pyqtSlot(name="on_identifyReferencingFeatureButton_clicked")
def activateMapTool(self):
self.iface.mapCanvas().setMapTool(self.mapTool)
def deactivateMapTool(self):
self.iface.mapCanvas().unsetMapTool(self.mapTool)
def loadRelations(self):
self.deleteWrapper()
self.disconnectLayer()
self.relation = QgsRelation()
self.referencingFeature = QgsFeature()
self.relationComboBox.currentIndexChanged.disconnect(
self.currentRelationChanged)
self.relationComboBox.clear()
for relation in self.relationManager.referencedRelations():
if relation.referencingLayer().hasGeometryType():
self.relationComboBox.addItem(relation.name(), relation.id())
self.relationComboBox.setCurrentIndex(-1)
self.relationComboBox.currentIndexChanged.connect(
self.currentRelationChanged)
self.currentRelationChanged(-1)
def currentRelationChanged(self, index):
# disconnect previous relation
if self.relation.isValid():
try:
self.relation.referencingLayer().editingStarted.disconnect(
self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.disconnect(
self.relationEditableChanged)
self.relation.referencingLayer(
).attributeValueChanged.disconnect(
self.layerValueChangedOutside)
except TypeError:
pass
self.referencingFeatureLayout.setEnabled(index >= 0)
relationId = self.relationComboBox.itemData(index)
self.relation = self.relationManager.relation(relationId)
self.mapTool.setLayer(self.relation.referencingLayer())
self.setReferencingFeature()
# connect
if self.relation.isValid():
self.relation.referencingLayer().editingStarted.connect(
self.relationEditableChanged)
self.relation.referencingLayer().editingStopped.connect(
self.relationEditableChanged)
self.relation.referencingLayer().attributeValueChanged.connect(
self.layerValueChangedOutside)
def setReferencingFeature(self, feature=QgsFeature()):
self.deactivateMapTool()
self.referencingFeature = QgsFeature(feature)
self.deleteWrapper()
# disable relation reference widget if no referencing feature
self.referencedFeatureLayout.setEnabled(feature.isValid())
# set line edit
if not self.relation.isValid() or not feature.isValid():
self.referencingFeatureLineEdit.clear()
return
self.referencingFeatureLineEdit.setText("%s" % feature.id())
fieldIdx = self.referencingFieldIndex()
widgetConfig = self.relation.referencingLayer().editorWidgetV2Config(
fieldIdx)
self.relationWidgetWrapper = QgsEditorWidgetRegistry.instance().create(
"RelationReference", self.relation.referencingLayer(), fieldIdx,
widgetConfig, self.relationReferenceWidget, self,
self.editorContext)
self.relationWidgetWrapper.setEnabled(
self.relation.referencingLayer().isEditable())
self.relationWidgetWrapper.setValue(feature[fieldIdx])
self.relationWidgetWrapper.valueChanged.connect(self.foreignKeyChanged)
# override field definition to allow map identification
self.relationReferenceWidget.setAllowMapIdentification(True)
self.relationReferenceWidget.setEmbedForm(False)
# update drawn link
self.highlightReferencingFeature()
self.drawLink()
def deleteWrapper(self):
if self.relationWidgetWrapper is not None:
self.relationWidgetWrapper.valueChanged.disconnect(
self.foreignKeyChanged)
self.relationWidgetWrapper.setValue(None)
del self.relationWidgetWrapper
self.relationWidgetWrapper = None
def foreignKeyChanged(self, newKey):
if not self.relation.isValid() or not self.relation.referencingLayer(
).isEditable() or not self.referencingFeature.isValid():
self.drawLink()
return
if not self.relation.referencingLayer().editBuffer(
).changeAttributeValue(self.referencingFeature.id(),
self.referencingFieldIndex(), newKey):
self.iface.messageBar().pushMessage(
"Link It", "Cannot change attribute value.",
QgsMessageBar.CRITICAL)
self.drawLink()
def relationEditableChanged(self):
if self.relationWidgetWrapper is not None:
self.relationWidgetWrapper.setEnabled(
self.relation.isValid()
and self.relation.referencingLayer().isEditable())
def layerValueChangedOutside(self, fid, fieldIdx, value):
if not self.relation.isValid() or not self.referencingFeature.isValid(
) or self.relationWidgetWrapper is None:
return
# not the correct feature
if fid != self.referencingFeature.id():
return
# not the correct field
if fieldIdx != self.referencingFieldIndex():
return
# widget already has this value
if value == self.relationWidgetWrapper.value():
return
self.relationWidgetWrapper.valueChanged.disconnect(
self.foreignKeyChanged)
self.relationWidgetWrapper.setValue(value)
self.relationWidgetWrapper.valueChanged.connect(self.foreignKeyChanged)
def referencingFieldIndex(self):
if not self.relation.isValid():
return -1
fieldName = self.relation.fieldPairs().keys()[0]
fieldIdx = self.relation.referencingLayer().fieldNameIndex(fieldName)
return fieldIdx
@pyqtSlot(bool, name="on_drawButton_toggled")
def drawLink(self):
self.settings.setValue("drawEnabled", self.drawButton.isChecked())
self.linkRubber.reset()
if not self.drawButton.isChecked(
) or not self.referencingFeature.isValid(
) or not self.relation.isValid():
return
referencedFeature = self.relationReferenceWidget.referencedFeature()
if not referencedFeature.isValid():
return
p1 = self.centroid(self.relation.referencedLayer(), referencedFeature)
p2 = self.centroid(self.relation.referencingLayer(),
self.referencingFeature)
geom = arc(p1, p2)
self.linkRubber.setToGeometry(geom, None)
self.linkRubber.setWidth(self.settings.value("rubberWidth"))
self.linkRubber.setColor(self.settings.value("rubberColor"))
self.linkRubber.setLineStyle(Qt.DashLine)
def centroid(self, layer, feature):
geom = feature.geometry()
if geom.type() == QGis.Line:
geom = geom.interpolate(geom.length() / 2)
else:
geom = geom.centroid()
return self.iface.mapCanvas().mapSettings().layerToMapCoordinates(
layer, geom.asPoint())
@pyqtSlot(name="on_highlightReferencingFeatureButton_clicked")
def highlightReferencingFeature(self):
self.deleteHighlight()
if not self.relation.isValid() or not self.referencingFeature.isValid(
):
return
self.featureHighlight = QgsHighlight(
self.iface.mapCanvas(), self.referencingFeature.geometry(),
self.relation.referencingLayer())
settings = QSettings()
color = QColor(
settings.value("/Map/highlight/color",
QGis.DEFAULT_HIGHLIGHT_COLOR.name()))
alpha = int(
settings.value("/Map/highlight/colorAlpha",
QGis.DEFAULT_HIGHLIGHT_COLOR.alpha()))
bbuffer = float(
settings.value("/Map/highlight/buffer",
QGis.DEFAULT_HIGHLIGHT_BUFFER_MM))
minWidth = float(
settings.value("/Map/highlight/minWidth",
QGis.DEFAULT_HIGHLIGHT_MIN_WIDTH_MM))
self.featureHighlight.setColor(color)
color.setAlpha(alpha)
self.featureHighlight.setFillColor(color)
self.featureHighlight.setBuffer(bbuffer)
self.featureHighlight.setMinWidth(minWidth)
self.featureHighlight.show()
timer = QTimer(self)
timer.setSingleShot(True)
timer.timeout.connect(self.deleteHighlight)
timer.start(3000)
def deleteHighlight(self):
if self.featureHighlight:
del self.featureHighlight
self.featureHighlight = None
class DocumentModel(QAbstractTableModel):
DocumentIdRole = Qt.UserRole + 1
DocumentPathRole = Qt.UserRole + 2
DocumentNameRole = Qt.UserRole + 3
DocumentExistsRole = Qt.UserRole + 4
DocumentToolTipRole = Qt.UserRole + 5
DocumentIsImageRole = Qt.UserRole + 6
def __init__(self, parent: QObject = None):
super(DocumentModel, self).__init__(parent)
self._relation = QgsRelation()
self._nmRelation = QgsRelation()
self._documents_path = str()
self._document_filename = str()
self._feature = QgsFeature()
self._document_list = []
def init(self, relation: QgsRelation, nmRelation: QgsRelation,
feature: QgsFeature, documents_path: str, document_filename: str):
self._relation = relation
self._nmRelation = nmRelation
self._documents_path = documents_path
self._document_filename = document_filename
self._feature = feature
self.reloadData()
def rowCount(self, parent: QModelIndex = ...) -> int:
return len(self._document_list)
def columnCount(self, parent: QModelIndex = ...) -> int:
return 1
def headerData(self,
section: int,
orientation: Qt.Orientation,
role: int = ...):
return None
def flags(self, index: QModelIndex) -> Qt.ItemFlags:
flags = Qt.ItemIsEnabled | Qt.ItemIsSelectable | Qt.ItemIsEditable
return flags
def data(self, index: QModelIndex, role: int = ...):
if index.row() < 0 or index.row() >= self.rowCount(QModelIndex()):
return None
return self._document_list[index.row()][role]
def setData(self,
index: QModelIndex,
value,
role: int = Qt.EditRole) -> bool:
if index.row() < 0 or index.row() >= self.rowCount(QModelIndex()):
return False
return False
def roleNames(self):
return {
self.DocumentIdRole: b'DocumentId',
self.DocumentPathRole: b'DocumentPath',
self.DocumentNameRole: b'DocumentName',
self.DocumentExistsRole: b'DocumentExists',
self.DocumentToolTipRole: b'DocumentToolTip',
self.DocumentIsImageRole: b'DocumentIsImage'
}
def reloadData(self):
self.beginResetModel()
self._document_list = []
if self._relation.isValid() is False or self._feature.isValid(
) is False:
self.endResetModel()
return
feature_list = []
layer = self._relation.referencingLayer()
request = self._relation.getRelatedFeaturesRequest(self._feature)
for feature in layer.getFeatures(request):
feature_list.append(feature)
if self._nmRelation.isValid():
filters = []
for joinTableFeature in feature_list:
referencedFeatureRequest = self._nmRelation.getReferencedFeatureRequest(
joinTableFeature)
filterExpression = referencedFeatureRequest.filterExpression()
filters.append("(" + filterExpression.expression() + ")")
nmRequest = QgsFeatureRequest()
nmRequest.setFilterExpression(" OR ".join(filters))
feature_list = []
layer = self._nmRelation.referencedLayer()
for documentFeature in layer.getFeatures(nmRequest):
feature_list.append(documentFeature)
for documentFeature in feature_list:
documents_path = str()
if self._documents_path:
exp = QgsExpression(self._documents_path)
context = QgsExpressionContext()
context.appendScopes(
QgsExpressionContextUtils.globalProjectLayerScopes(layer))
context.setFeature(documentFeature)
documents_path = exp.evaluate(context)
document_filename = str()
if self._document_filename:
exp = QgsExpression(self._document_filename)
context = QgsExpressionContext()
context.appendScopes(
QgsExpressionContextUtils.globalProjectLayerScopes(layer))
context.setFeature(documentFeature)
document_filename = exp.evaluate(context)
file_info = QFileInfo(QDir(str(documents_path)),
str(document_filename))
# ToolTip
toolTipList = []
toolTipList.append("<ul>")
for field in documentFeature.fields():
index = documentFeature.fields().indexFromName(field.name())
toolTipList.append("<li><strong>{0}</strong>: {1}</li>".format(
field.displayName(), documentFeature[index]))
toolTipList.append("</ul>")
self._document_list.append({
self.DocumentIdRole:
documentFeature.id(),
self.DocumentPathRole:
file_info.filePath(),
self.DocumentNameRole:
file_info.fileName(),
self.DocumentExistsRole:
file_info.exists(),
self.DocumentToolTipRole:
"".join(toolTipList),
self.DocumentIsImageRole:
PreviewImageProvider.isMimeTypeSupported(file_info.filePath())
})
self.endResetModel()
def import_in_qgis(gmlas_uri, provider, schema=None):
"""Imports layers from a GMLAS file in QGIS with relations and editor widgets
@param gmlas_uri connection parameters
@param provider name of the QGIS provider that handles gmlas_uri parameters (postgresql or spatialite)
@param schema name of the PostgreSQL schema where tables and metadata tables are
"""
if schema is not None:
schema_s = schema + "."
else:
schema_s = ""
ogr.UseExceptions()
drv = ogr.GetDriverByName(provider)
ds = drv.Open(gmlas_uri)
if ds is None:
raise RuntimeError("Problem opening {}".format(gmlas_uri))
# get list of layers
sql = "select o.*, g.f_geometry_column, g.srid from {}_ogr_layers_metadata o left join geometry_columns g on g.f_table_name = o.layer_name".format(
schema_s)
l = ds.ExecuteSQL(sql)
layers = {}
for f in l:
ln = f.GetField("layer_name")
if ln not in layers:
layers[ln] = {
'uid': f.GetField("layer_pkid_name"),
'category': f.GetField("layer_category"),
'xpath': f.GetField("layer_xpath"),
'parent_pkid': f.GetField("layer_parent_pkid_name"),
'srid': f.GetField("srid"),
'geometry_column': f.GetField("f_geometry_column"),
'1_n': [], # 1:N relations
'layer_id': None,
'layer_name': ln,
'layer': None,
'fields': []
}
else:
# additional geometry columns
g = f.GetField("f_geometry_column")
k = "{} ({})".format(ln, g)
layers[k] = dict(layers[ln])
layers[k]["geometry_column"] = g
crs = QgsCoordinateReferenceSystem("EPSG:4326")
for ln in sorted(layers.keys()):
lyr = layers[ln]
g_column = lyr["geometry_column"] or None
l = _qgis_layer(gmlas_uri,
schema,
lyr["layer_name"],
g_column,
provider,
qgis_layer_name=ln)
if not l.isValid():
raise RuntimeError("Problem loading layer {} with {}".format(
ln, l.source()))
if lyr["srid"]:
crs = QgsCoordinateReferenceSystem("EPSG:{}".format(lyr["srid"]))
l.setCrs(crs)
QgsProject.instance().addMapLayer(l)
layers[ln]['layer_id'] = l.id()
layers[ln]['layer'] = l
# add 1:1 relations
relations_1_1 = []
sql = """
select
layer_name, field_name, field_related_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.parent_element_name = f.field_name
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs=1
""".format(schema_s)
l = ds.ExecuteSQL(sql)
if l is not None:
for f in l:
rel = QgsRelation()
rel.setId('1_1_' + f.GetField('layer_name') + '_' +
f.GetField('field_name'))
rel.setName('1_1_' + f.GetField('layer_name') + '_' +
f.GetField('field_name'))
# parent layer
rel.setReferencingLayer(
layers[f.GetField('layer_name')]['layer_id'])
# child layer
rel.setReferencedLayer(
layers[f.GetField('field_related_layer')]['layer_id'])
# parent, child
rel.addFieldPair(f.GetField('field_name'),
f.GetField('child_pkid'))
#rel.generateId()
if rel.isValid():
relations_1_1.append(rel)
# add 1:N relations
relations_1_n = []
sql = """
select
layer_name, r.parent_pkid, field_related_layer as child_layer, r.child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category in ('PATH_TO_CHILD_ELEMENT_WITH_LINK', 'PATH_TO_CHILD_ELEMENT_NO_LINK')
and field_max_occurs>1
-- junctions - 1st way
union all
select
layer_name, r.parent_pkid, field_junction_layer as child_layer, 'parent_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
-- junctions - 2nd way
union all
select
field_related_layer as layer_name, r.child_pkid, field_junction_layer as child_layer, 'child_pkid' as child_pkid
from
{0}_ogr_fields_metadata f
join {0}_ogr_layer_relationships r
on r.parent_layer = f.layer_name
and r.child_layer = f.field_related_layer
where
field_category = 'PATH_TO_CHILD_ELEMENT_WITH_JUNCTION_TABLE'
""".format(schema_s)
l = ds.ExecuteSQL(sql)
if l is not None:
for f in l:
rel = QgsRelation()
rel.setId('1_n_' + f.GetField('layer_name') + '_' +
f.GetField('child_layer') + '_' +
f.GetField('parent_pkid') + '_' +
f.GetField('child_pkid'))
rel.setName(f.GetField('child_layer'))
# parent layer
rel.setReferencedLayer(
layers[f.GetField('layer_name')]['layer_id'])
# child layer
rel.setReferencingLayer(
layers[f.GetField('child_layer')]['layer_id'])
# parent, child
rel.addFieldPair(f.GetField('child_pkid'),
f.GetField('parent_pkid'))
#rel.addFieldPair(f.GetField('child_pkid'), 'ogc_fid')
if rel.isValid():
relations_1_n.append(rel)
# add relation to layer
layers[f.GetField('layer_name')]['1_n'].append(rel)
QgsProject.instance().relationManager().setRelations(relations_1_1 +
relations_1_n)
# add "show form" option to 1:1 relations
for rel in relations_1_1:
l = rel.referencingLayer()
idx = rel.referencingFields()[0]
s = QgsEditorWidgetSetup(
"RelationReference", {
'AllowNULL': False,
'ReadOnly': True,
'Relation': rel.id(),
'OrderByValue': False,
'MapIdentification': False,
'AllowAddFeatures': False,
'ShowForm': True
})
l.setEditorWidgetSetup(idx, s)
# setup form for layers
for layer, lyr in layers.items():
l = lyr['layer']
fc = l.editFormConfig()
fc.clearTabs()
fc.setLayout(QgsEditFormConfig.TabLayout)
# Add fields
c = QgsAttributeEditorContainer("Main", fc.invisibleRootContainer())
c.setIsGroupBox(False) # a tab
for idx, f in enumerate(l.fields()):
c.addChildElement(QgsAttributeEditorField(f.name(), idx, c))
fc.addTab(c)
# Add 1:N relations
c_1_n = QgsAttributeEditorContainer("1:N links",
fc.invisibleRootContainer())
c_1_n.setIsGroupBox(False) # a tab
fc.addTab(c_1_n)
for rel in lyr['1_n']:
c_1_n.addChildElement(
QgsAttributeEditorRelation(rel.name(), rel, c_1_n))
l.setEditFormConfig(fc)
