CGMES metadata models extension

cgmes/cgmes-completion/src/main/java/com/powsybl/cgmes/completion/CreateMissingContainersPreProcessor.java

@@ -220,7 +220,7 @@ private static void writeHeader(Network network, XMLStreamWriter writer, CgmesEx
         String euNamespace = context.getCim().getEuNamespace();
         CgmesExportUtil.writeRdfRoot(cimNamespace, context.getCim().getEuPrefix(), euNamespace, writer);
         if (context.getCimVersion() >= 16) {
-            CgmesExportUtil.writeModelDescription(network, CgmesSubset.EQUIPMENT, writer, context.getEqModelDescription(), context);
+            CgmesExportUtil.writeModelDescription(network, CgmesSubset.EQUIPMENT, writer, context.getExportedEQModel(), context);
         }
     }
 

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/CgmesExport.java

@@ -11,6 +11,7 @@
 import com.powsybl.cgmes.conversion.export.*;
 import com.powsybl.cgmes.conversion.naming.NamingStrategy;
 import com.powsybl.cgmes.conversion.naming.NamingStrategyFactory;
+import com.powsybl.cgmes.model.CgmesMetadataModel;
 import com.powsybl.cgmes.model.CgmesNamespace;
 import com.powsybl.commons.config.PlatformConfig;
 import com.powsybl.commons.datasource.DataSource;
@@ -116,16 +117,16 @@ public void export(Network network, Properties params, DataSource ds, ReportNode
             masUri = sourcingActor.get("masUri");
         }
 
-        context.getEqModelDescription().setModelingAuthoritySet(masUri);
-        context.getTpModelDescription().setModelingAuthoritySet(masUri);
-        context.getSshModelDescription().setModelingAuthoritySet(masUri);
-        context.getSvModelDescription().setModelingAuthoritySet(masUri);
+        context.getExportedEQModel().setModelingAuthoritySet(masUri);
+        context.getExportedTPModel().setModelingAuthoritySet(masUri);
+        context.getExportedSSHModel().setModelingAuthoritySet(masUri);
+        context.getExportedSVModel().setModelingAuthoritySet(masUri);
         String modelDescription = Parameter.readString(getFormat(), params, MODEL_DESCRIPTION_PARAMETER, defaultValueConfig);
         if (modelDescription != null) {
-            context.getEqModelDescription().setDescription(modelDescription);
-            context.getTpModelDescription().setDescription(modelDescription);
-            context.getSshModelDescription().setDescription(modelDescription);
-            context.getSvModelDescription().setDescription(modelDescription);
+            context.getExportedEQModel().setDescription(modelDescription);
+            context.getExportedTPModel().setDescription(modelDescription);
+            context.getExportedSSHModel().setDescription(modelDescription);
+            context.getExportedSVModel().setDescription(modelDescription);
         }
         String cimVersionParam = Parameter.readString(getFormat(), params, CIM_VERSION_PARAMETER, defaultValueConfig);
         if (cimVersionParam != null) {
@@ -134,10 +135,10 @@ public void export(Network network, Properties params, DataSource ds, ReportNode
 
         String modelVersion = Parameter.readString(getFormat(), params, MODEL_VERSION_PARAMETER, defaultValueConfig);
         if (modelVersion != null) {
-            context.getEqModelDescription().setVersion(Integer.parseInt(modelVersion));
-            context.getTpModelDescription().setVersion(Integer.parseInt(modelVersion));
-            context.getSshModelDescription().setVersion(Integer.parseInt(modelVersion));
-            context.getSvModelDescription().setVersion(Integer.parseInt(modelVersion));
+            context.getExportedEQModel().setVersion(Integer.parseInt(modelVersion));
+            context.getExportedTPModel().setVersion(Integer.parseInt(modelVersion));
+            context.getExportedSSHModel().setVersion(Integer.parseInt(modelVersion));
+            context.getExportedSVModel().setVersion(Integer.parseInt(modelVersion));
         }
 
         try {
@@ -149,24 +150,24 @@ public void export(Network network, Properties params, DataSource ds, ReportNode
                     EquipmentExport.write(network, writer, context);
                 }
             } else {
-                addProfilesIdentifiers(network, "EQ", context.getEqModelDescription());
-                context.getEqModelDescription().addId(context.getNamingStrategy().getCgmesId(network));
+                addSubsetIdentifiers(network, "EQ", context.getExportedEQModel());
+                context.getExportedEQModel().setId(context.getNamingStrategy().getCgmesId(network));
             }
             if (profiles.contains("TP")) {
                 try (OutputStream out = new BufferedOutputStream(ds.newOutputStream(filenameTp, false))) {
                     XMLStreamWriter writer = XmlUtil.initializeWriter(true, INDENT, out);
                     TopologyExport.write(network, writer, context);
                 }
             } else {
-                addProfilesIdentifiers(network, "TP", context.getTpModelDescription());
+                addSubsetIdentifiers(network, "TP", context.getExportedTPModel());
             }
             if (profiles.contains("SSH")) {
                 try (OutputStream out = new BufferedOutputStream(ds.newOutputStream(filenameSsh, false))) {
                     XMLStreamWriter writer = XmlUtil.initializeWriter(true, INDENT, out);
                     SteadyStateHypothesisExport.write(network, writer, context);
                 }
             } else {
-                addProfilesIdentifiers(network, "SSH", context.getSshModelDescription());
+                addSubsetIdentifiers(network, "SSH", context.getExportedSSHModel());
             }
             if (profiles.contains("SV")) {
                 try (OutputStream out = new BufferedOutputStream(ds.newOutputStream(filenameSv, false))) {
@@ -198,8 +199,8 @@ private String getBoundaryId(String profile, Network network, Properties params,
         return id;
     }
 
-    private static void addProfilesIdentifiers(Network network, String profile, CgmesExportContext.ModelDescription description) {
-        description.setIds(network.getPropertyNames().stream()
+    private static void addSubsetIdentifiers(Network network, String profile, CgmesMetadataModel description) {
+        description.addDependentOn(network.getPropertyNames().stream()
                 .filter(p -> p.startsWith(Conversion.CGMES_PREFIX_ALIAS_PROPERTIES + profile + "_ID"))
                 .map(network::getProperty)
                 .toList());

cgmes/cgmes-conversion/src/main/java/com/powsybl/cgmes/conversion/Conversion.java

@@ -33,6 +33,7 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 import java.util.function.Supplier;
+import java.util.stream.Stream;
 
 import static com.powsybl.cgmes.conversion.CgmesReports.importedCgmesNetworkReport;
 import static com.powsybl.cgmes.conversion.Conversion.Config.StateProfile.SSH;
@@ -156,8 +157,7 @@ public Network convert(ReportNode reportNode) {
         Network network = createNetwork();
         Context context = createContext(network, reportNode);
         assignNetworkProperties(context);
-        addCgmesSvMetadata(network, context);
-        addCgmesSshMetadata(network, context);
+        addMetadataModels(network, context);
         addCimCharacteristics(network);
         BaseVoltageMappingAdder bvAdder = network.newExtension(BaseVoltageMappingAdder.class);
         cgmes.baseVoltages().forEach(bv -> bvAdder.addBaseVoltage(bv.getId("BaseVoltage"), bv.asDouble("nominalVoltage"), isBoundaryBaseVoltage(bv.getLocal("graph"))));
@@ -439,36 +439,72 @@ private void assignNetworkProperties(Context context) {
         LOG.info("network forecastDistance : {}", context.network().getForecastDistance());
     }
 
-    private void addCgmesSvMetadata(Network network, Context context) {
-        PropertyBags svDescription = cgmes.fullModel(CgmesSubset.STATE_VARIABLES.getProfile());
-        if (svDescription != null && !svDescription.isEmpty()) {
-            CgmesSvMetadataAdder adder = network.newExtension(CgmesSvMetadataAdder.class)
-                    .setDescription(svDescription.get(0).get("description"))
-                    .setSvVersion(readVersion(svDescription, context))
-                    .setModelingAuthoritySet(svDescription.get(0).get("modelingAuthoritySet"));
-            svDescription.pluckLocals("DependentOn").forEach(adder::addDependency);
-            adder.add();
+    /**
+     * Read the model header (the FullModel node) that holds metadata information.
+     * The metadata will be stored in the {@link CgmesMetadataModels} extension.
+     * @param network The network described by the model header and that will hold the extension.
+     * @param context The conversion context.
+     */
+    private void addMetadataModels(Network network, Context context) {
+        PropertyBags ps = cgmes.fullModels();
+        if (ps.isEmpty()) {
+            return;
         }
+        CgmesMetadataModelsAdder modelsAdder = network.newExtension(CgmesMetadataModelsAdder.class);
+        for (PropertyBag p : ps) {
+            CgmesMetadataModelsAdder.ModelAdder modelAdder = modelsAdder.newModel()
+                .setId(p.getId("FullModel"))
+                .setSubset(subsetFromGraph(p.getLocal("graph")))
+                .setDescription(p.getId("description"))
+                .setVersion(readVersion(p, context))
+                .setModelingAuthoritySet(p.getId("modelingAuthoritySet"));
+            addMetadataModelReferences(p, "profileList", modelAdder::addProfile);
+            addMetadataModelReferences(p, "dependentOnList", modelAdder::addDependentOn);
+            addMetadataModelReferences(p, "supersedesList", modelAdder::addSupersedes);
+            modelAdder.add();
+        }
+        modelsAdder.add();
     }
 
-    private void addCgmesSshMetadata(Network network, Context context) {
-        PropertyBags sshDescription = cgmes.fullModel(CgmesSubset.STEADY_STATE_HYPOTHESIS.getProfile());
-        if (sshDescription != null && !sshDescription.isEmpty()) {
-            CgmesSshMetadataAdder adder = network.newExtension(CgmesSshMetadataAdder.class)
-                    .setId(sshDescription.get(0).get("FullModel"))
-                    .setDescription(sshDescription.get(0).get("description"))
-                    .setSshVersion(readVersion(sshDescription, context))
-                    .setModelingAuthoritySet(sshDescription.get(0).get("modelingAuthoritySet"));
-            sshDescription.pluckLocals("DependentOn").forEach(adder::addDependency);
-            adder.add();
+    /**
+     * Add references (profiles, dependencies, supersedes) to the {@link CgmesMetadataModel} being created by the adder.
+     * @param p The property bag holding the references.
+     * @param refsProperty The property name to look for in the property bag.
+     *                     The property value must be split to retrieve the complete list of references.
+     * @param adder The method in the adder that will add the references to the model.
+     */
+    private void addMetadataModelReferences(PropertyBag p, String refsProperty, Function<String, CgmesMetadataModelsAdder.ModelAdder> adder) {
+        String refs = p.get(refsProperty);
+        if (refs != null && !refs.isEmpty()) {
+            for (String ref : refs.split(" ")) {
+                adder.apply(ref);
+            }
         }
     }
 
-    private int readVersion(PropertyBags propertyBags, Context context) {
+    /**
+     * Retrieve the subset from the graph.
+     * @param graph The file name. It shall contain the subset identifier.
+     * @return The {@link CgmesSubset} corresponding to the graph.
+     */
+    private CgmesSubset subsetFromGraph(String graph) {
+        return Stream.of(CgmesSubset.values())
+                .filter(subset -> subset.isValidName(graph))
+                .findFirst()
+                .orElse(CgmesSubset.UNKNOWN);
+    }
+
+    /**
+     * Retrieve the version number from the property bag.
+     * @param propertyBag The bag where to look for a version property.
+     * @param context The conversion context.
+     * @return The version number if found and is a proper integer, else the default value: 1.
+     */
+    private int readVersion(PropertyBag propertyBag, Context context) {
         try {
-            return propertyBags.get(0).asInt("version");
+            return propertyBag.asInt("version");
         } catch (NumberFormatException e) {
-            context.fixed("Version", "The version is expected to be an integer: " + propertyBags.get(0).get("version") + ". Fixed to 1");
+            context.fixed("Version", "The version is expected to be an integer: " + propertyBag.get("version") + ". Fixed to 1");
             return 1;
         }
     }