CGMES metadata model interface and implementation (#2988)

Signed-off-by: Luma <zamarrenolm@aia.es>
powsybl · Apr 29, 2024 · d736135 · d736135
1 parent af6271c
commit d736135
Show file tree

Hide file tree

Showing 4 changed files with 176 additions and 102 deletions.
diff --git a/...gmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/CgmesExportContext.java b/...gmes-conversion/src/main/java/com/powsybl/cgmes/conversion/export/CgmesExportContext.java
@@ -15,10 +15,7 @@
 import com.powsybl.cgmes.conversion.naming.NamingStrategy;
 import com.powsybl.cgmes.conversion.naming.NamingStrategyFactory;
 import com.powsybl.cgmes.extensions.*;
-import com.powsybl.cgmes.model.CgmesMetadataModel;
-import com.powsybl.cgmes.model.CgmesNames;
-import com.powsybl.cgmes.model.CgmesNamespace;
-import com.powsybl.cgmes.model.CgmesSubset;
+import com.powsybl.cgmes.model.*;
 import com.powsybl.commons.report.ReportNode;
 import com.powsybl.iidm.network.*;
 import com.powsybl.iidm.network.Identifiable;
@@ -63,10 +60,10 @@ public class CgmesExportContext {
     private String boundaryTpId; // may be null
     private String businessProcess = DEFAULT_BUSINESS_PROCESS;
 
-    private final CgmesMetadataModel exportedEQModel = new CgmesMetadataModel(CgmesSubset.EQUIPMENT, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
-    private final CgmesMetadataModel exportedTPModel = new CgmesMetadataModel(CgmesSubset.TOPOLOGY, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
-    private final CgmesMetadataModel exportedSVModel = new CgmesMetadataModel(CgmesSubset.STATE_VARIABLES, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
-    private final CgmesMetadataModel exportedSSHModel = new CgmesMetadataModel(CgmesSubset.STEADY_STATE_HYPOTHESIS, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
+    private final CgmesMetadataModel exportedEQModel = new CgmesMetadataModelImpl(CgmesSubset.EQUIPMENT, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
+    private final CgmesMetadataModel exportedTPModel = new CgmesMetadataModelImpl(CgmesSubset.TOPOLOGY, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
+    private final CgmesMetadataModel exportedSVModel = new CgmesMetadataModelImpl(CgmesSubset.STATE_VARIABLES, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
+    private final CgmesMetadataModel exportedSSHModel = new CgmesMetadataModelImpl(CgmesSubset.STEADY_STATE_HYPOTHESIS, DEFAULT_MODELING_AUTHORITY_SET_VALUE);
 
     private NamingStrategy namingStrategy = new NamingStrategy.Identity();
 

diff --git a/...s-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsAdderImpl.java b/...s-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsAdderImpl.java
@@ -8,6 +8,7 @@
 package com.powsybl.cgmes.extensions;
 
 import com.powsybl.cgmes.model.CgmesMetadataModel;
+import com.powsybl.cgmes.model.CgmesMetadataModelImpl;
 import com.powsybl.cgmes.model.CgmesSubset;
 import com.powsybl.commons.PowsyblException;
 import com.powsybl.commons.extensions.AbstractExtensionAdder;
@@ -93,7 +94,7 @@ public CgmesMetadataModelsAdderImpl add() {
             if (profiles.isEmpty()) {
                 throw new PowsyblException("Model must contain at least one profile");
             }
-            models.add(new CgmesMetadataModel(subset, modelingAuthoritySet)
+            models.add(new CgmesMetadataModelImpl(subset, modelingAuthoritySet)
                     .setId(id)
                     .setDescription(description)
                     .setVersion(version)

diff --git a/cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/CgmesMetadataModel.java b/cgmes/cgmes-model/src/main/java/com/powsybl/cgmes/model/CgmesMetadataModel.java
@@ -26,71 +26,45 @@
  *
  * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
  */
-public class CgmesMetadataModel {
-
-    private final CgmesSubset subset;
-    private String id;
-    private String description;
-    private int version;
-    private String modelingAuthoritySet;
-    private final Set<String> profiles = new HashSet<>();
-    private final Set<String> dependentOn = new HashSet<>();
-    private final Set<String> supersedes = new HashSet<>();
-
-    public CgmesMetadataModel(CgmesSubset subset, String modelingAuthoritySet) {
-        this.subset = subset;
-        this.modelingAuthoritySet = modelingAuthoritySet;
-        this.version = 1;
-        this.description = subset.getIdentifier() + " Model";
-    }
+public interface CgmesMetadataModel {
 
     /**
      * The CGMES instance file (subset) that the model refers to: EQ, SSH, ...
      *
      * @return the subset of the CGMES the model refers to
      */
-    public CgmesSubset getSubset() {
-        return subset;
-    }
+    CgmesSubset getSubset();
 
     /**
      * The unique identifier for the model.
      * A model identifier should change if the data contained in the model has changed.
      *
      * @return the identifier of the model
      */
-    public String getId() {
-        return id;
-    }
+    String getId();
 
     /**
      * A description for the model.
      *
      * @return the description of the model
      */
-    public String getDescription() {
-        return description;
-    }
+    String getDescription();
 
     /**
      * The version number for the model.
      * The version number should change if the data contained in the model has changed.
      *
      * @return the version number of the model
      */
-    public int getVersion() {
-        return version;
-    }
+    int getVersion();
 
     /**
      * A reference to the organisation role / modeling authority set responsible for producing the model contents.
      * It is a URN/URI.
      *
      * @return the URN/URI of the modeling authority set producing the model
      */
-    public String getModelingAuthoritySet() {
-        return modelingAuthoritySet;
-    }
+    String getModelingAuthoritySet();
 
     /**
      * <p>References to the profiles used in the model.
@@ -101,142 +75,95 @@ public String getModelingAuthoritySet() {
      *
      * @return the URN/URIs of profiles describing the data in the model
      */
-    public Set<String> getProfiles() {
-        return profiles;
-    }
+    Set<String> getProfiles();
 
     /**
      * References to other models that the model depends on.
      *
      * @return the identifiers of the models the model depends on
      */
-    public Set<String> getDependentOn() {
-        return dependentOn;
-    }
+    Set<String> getDependentOn();
 
     /**
      * References to other models that are superseded by this model.
      *
      * @return the identifiers of the models this model supersedes
      */
-    public Set<String> getSupersedes() {
-        return supersedes;
-    }
+    Set<String> getSupersedes();
 
     /**
      * Set the given model version.
      * @param version The version to set for the model.
      * @return The model with the new version set.
      */
-    public CgmesMetadataModel setVersion(int version) {
-        this.version = version;
-        return this;
-    }
+    CgmesMetadataModelImpl setVersion(int version);
 
     /**
      * Set the given model id.
      * @param id The id to set for the model.
      * @return The model with the new id set.
      */
-    public CgmesMetadataModel setId(String id) {
-        this.id = id;
-        return this;
-    }
+    CgmesMetadataModelImpl setId(String id);
 
     /**
      * Remove any existing profile and set the given model profile.
      * @param profile The profile to set for the model.
      * @return The model with the new profile set.
      */
-    public CgmesMetadataModel setProfile(String profile) {
-        Objects.requireNonNull(profile);
-        this.profiles.clear();
-        this.profiles.add(profile);
-        return this;
-    }
+    CgmesMetadataModelImpl setProfile(String profile);
 
     /**
      * Extend model profiles with the given ones.
      * @param profiles The profiles to add for the model.
      * @return The model with the new profiles added.
      */
-    public CgmesMetadataModel addProfiles(Collection<String> profiles) {
-        this.profiles.addAll(profiles);
-        return this;
-    }
+    CgmesMetadataModelImpl addProfiles(Collection<String> profiles);
 
     /**
      * Set the given model description.
      * @param description The description to set for the model.
      * @return The model with the new description set.
      */
-    public CgmesMetadataModel setDescription(String description) {
-        this.description = description;
-        return this;
-    }
+    CgmesMetadataModelImpl setDescription(String description);
 
     /**
      * Add the given model id to the set of ids this model supersedes
      * @param id The additional model id this model should supersede.
      * @return The model with an updated set of values this model supersedes.
      */
-    public CgmesMetadataModel addSupersedes(String id) {
-        addIfNonEmpty(id, this.supersedes);
-        return this;
-    }
+    CgmesMetadataModelImpl addSupersedes(String id);
 
     /**
      * Add the given model id to the set of ids this model depends on.
      * @param id The additional model id this model should depend on.
      * @return The model with an updated set of values this model depends on.
      */
-    public CgmesMetadataModel addDependentOn(String id) {
-        addIfNonEmpty(id, this.dependentOn);
-        return this;
-    }
+    CgmesMetadataModelImpl addDependentOn(String id);
 
     /**
      * Add the given model ids to the set of ids this model depends on.
      * @param dependentOn The additional model ids this model should depend on.
      * @return The model with an updated set of values this model depends on.
      */
-    public CgmesMetadataModel addDependentOn(Collection<String> dependentOn) {
-        this.dependentOn.addAll(dependentOn);
-        return this;
-    }
+    CgmesMetadataModelImpl addDependentOn(Collection<String> dependentOn);
 
     /**
      * Add the given model ids to the set of ids this model supersedes.
      * @param supersedes The additional model ids this model should supersede.
      * @return The model with an updated set of values this model supersedes.
      */
-    public CgmesMetadataModel addSupersedes(Collection<String> supersedes) {
-        this.supersedes.addAll(supersedes);
-        return this;
-    }
+    CgmesMetadataModelImpl addSupersedes(Collection<String> supersedes);
 
     /**
      * Set the given modeling authority set.
      * @param modelingAuthoritySet The modeling authority set to set for the model.
      * @return The model with the new modeling authority set defined.
      */
-    public CgmesMetadataModel setModelingAuthoritySet(String modelingAuthoritySet) {
-        this.modelingAuthoritySet = modelingAuthoritySet;
-        return this;
-    }
+    CgmesMetadataModelImpl setModelingAuthoritySet(String modelingAuthoritySet);
 
     /**
      * Remove all the model ids this model depends on.
      * @return The model with an empty set of values this model depends on.
      */
-    public CgmesMetadataModel clearDependencies() {
-        this.dependentOn.clear();
-        return this;
-    }
-
-    private static void addIfNonEmpty(String id, Collection<String> ids) {
-        if (id != null && !id.isEmpty()) {
-            ids.add(id);
-        }
-    }
+    CgmesMetadataModelImpl clearDependencies();
 }