CGMES metadata models extension

cgmes/cgmes-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModels.java

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.extensions;
+
+import com.powsybl.commons.extensions.Extension;
+import com.powsybl.iidm.network.Network;
+
+import java.util.Collection;
+import java.util.Optional;
+import java.util.Set;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+public interface CgmesMetadataModels extends Extension<Network> {
+
+    String NAME = "cgmesMetadataModels";
+
+    interface Model {
+        String getPart();
+
+        String getId();
+
+        String getDescription();
+
+        int getVersion();
+
+        String getModelingAuthoritySet();
+
+        Set<String> getProfiles();
+
+        Set<String> getDependentOn();
+
+        Set<String> getSupersedes();
+    }
+
+    Collection<Model> getModels();
+
+    Optional<Model> getModelForPart(String part);
+
+    Optional<Model> getModelForProfile(String profile);
+
+    @Override
+    default String getName() {
+        return NAME;
+    }
+}

cgmes/cgmes-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsAdder.java

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.extensions;
+
+import com.powsybl.commons.extensions.ExtensionAdder;
+import com.powsybl.iidm.network.Network;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+public interface CgmesMetadataModelsAdder extends ExtensionAdder<Network, CgmesMetadataModels> {
+
+    interface ModelAdder {
+        ModelAdder setPart(String part);
+
+        ModelAdder setId(String id);
+
+        ModelAdder setDescription(String description);
+
+        ModelAdder setVersion(int sshVersion);
+
+        ModelAdder setModelingAuthoritySet(String modelingAuthoritySet);
+
+        ModelAdder addProfile(String profile);
+
+        ModelAdder addDependentOn(String dependentOn);
+
+        ModelAdder addSupersedes(String supersedes);
+
+        CgmesMetadataModelsAdder add();
+    }
+
+    ModelAdder newModel();
+
+    @Override
+    default Class<CgmesMetadataModels> getExtensionClass() {
+        return CgmesMetadataModels.class;
+    }
+}

cgmes/cgmes-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsAdderImpl.java

@@ -0,0 +1,114 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.extensions;
+
+import com.powsybl.commons.PowsyblException;
+import com.powsybl.commons.extensions.AbstractExtensionAdder;
+import com.powsybl.iidm.network.Network;
+
+import java.util.*;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+class CgmesMetadataModelsAdderImpl extends AbstractExtensionAdder<Network, CgmesMetadataModels> implements CgmesMetadataModelsAdder {
+
+    class ModelAdderImpl implements ModelAdder {
+
+        private String part;
+        private String id;
+        private String description;
+        private int version = 0;
+        private String modelingAuthoritySet;
+        private final Set<String> profiles = new HashSet<>();
+        private final Set<String> dependentOn = new HashSet<>();
+        private final Set<String> supersedes = new HashSet<>();
+
+        @Override
+        public ModelAdder setPart(String part) {
+            this.part = part;
+            return this;
+        }
+
+        @Override
+        public ModelAdder setId(String id) {
+            this.id = id;
+            return this;
+        }
+
+        @Override
+        public ModelAdderImpl setDescription(String description) {
+            this.description = description;
+            return this;
+        }
+
+        @Override
+        public ModelAdderImpl setVersion(int version) {
+            this.version = version;
+            return this;
+        }
+
+        @Override
+        public ModelAdderImpl setModelingAuthoritySet(String modelingAuthoritySet) {
+            this.modelingAuthoritySet = modelingAuthoritySet;
+            return this;
+        }
+
+        @Override
+        public ModelAdder addProfile(String profile) {
+            profiles.add(Objects.requireNonNull(profile));
+            return this;
+        }
+
+        @Override
+        public ModelAdderImpl addDependentOn(String dependentOn) {
+            this.dependentOn.add(Objects.requireNonNull(dependentOn));
+            return this;
+        }
+
+        @Override
+        public ModelAdderImpl addSupersedes(String supersedes) {
+            this.supersedes.add(Objects.requireNonNull(supersedes));
+            return this;
+        }
+
+        @Override
+        public CgmesMetadataModelsAdderImpl add() {
+            if (id == null) {
+                throw new PowsyblException("Model id is undefined");
+            }
+            if (modelingAuthoritySet == null) {
+                throw new PowsyblException("Model modelingAuthoritySet is undefined");
+            }
+            if (profiles.isEmpty()) {
+                throw new PowsyblException("Model must contain at least one profile");
+            }
+            models.add(new CgmesMetadataModelsImpl.ModelImpl(part, id, description, version, modelingAuthoritySet, profiles, dependentOn, supersedes));
+            return CgmesMetadataModelsAdderImpl.this;
+        }
+    }
+
+    private final Set<CgmesMetadataModels.Model> models = new HashSet<>();
+
+    CgmesMetadataModelsAdderImpl(Network extendable) {
+        super(extendable);
+    }
+
+    @Override
+    public ModelAdder newModel() {
+        return new ModelAdderImpl();
+    }
+
+    @Override
+    protected CgmesMetadataModels createExtension(Network extendable) {
+        if (models.isEmpty()) {
+            throw new PowsyblException("Must contain at least one model");
+        }
+        return new CgmesMetadataModelsImpl(models);
+    }
+}

cgmes/cgmes-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsAdderImplProvider.java

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.extensions;
+
+import com.google.auto.service.AutoService;
+import com.powsybl.commons.extensions.ExtensionAdderProvider;
+import com.powsybl.iidm.network.Network;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+@AutoService(ExtensionAdderProvider.class)
+public class CgmesMetadataModelsAdderImplProvider implements
+        ExtensionAdderProvider<Network, CgmesMetadataModels, CgmesMetadataModelsAdderImpl> {
+
+    @Override
+    public String getImplementationName() {
+        return "Default";
+    }
+
+    @Override
+    public String getExtensionName() {
+        return CgmesMetadataModels.NAME;
+    }
+
+    @Override
+    public Class<? super CgmesMetadataModelsAdderImpl> getAdderClass() {
+        return CgmesMetadataModelsAdderImpl.class;
+    }
+
+    @Override
+    public CgmesMetadataModelsAdderImpl newAdder(Network extendable) {
+        return new CgmesMetadataModelsAdderImpl(extendable);
+    }
+}

cgmes/cgmes-extensions/src/main/java/com/powsybl/cgmes/extensions/CgmesMetadataModelsImpl.java

@@ -0,0 +1,109 @@
+/**
+ * Copyright (c) 2024, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * SPDX-License-Identifier: MPL-2.0
+ */
+package com.powsybl.cgmes.extensions;
+
+import com.powsybl.commons.extensions.AbstractExtension;
+import com.powsybl.iidm.network.Network;
+
+import java.util.*;
+
+/**
+ * @author Luma Zamarreño {@literal <zamarrenolm at aia.es>}
+ */
+class CgmesMetadataModelsImpl extends AbstractExtension<Network> implements CgmesMetadataModels {
+
+    static class ModelImpl implements Model {
+
+        private final String part;
+        private final String id;
+        private final String description;
+        private final int version;
+        private final String modelingAuthoritySet;
+        private final Set<String> profiles = new HashSet<>();
+        private final Set<String> dependentOn = new HashSet<>();
+        private final Set<String> supersedes = new HashSet<>();
+
+        ModelImpl(String part, String id, String description, int version, String modelingAuthoritySet,
+                  Set<String> profiles, Set<String> dependentOn, Set<String> supersedes) {
+            this.part = part;
+            this.id = id;
+            this.description = description;
+            this.version = version;
+            this.modelingAuthoritySet = modelingAuthoritySet;
+            this.profiles.addAll(profiles);
+            this.dependentOn.addAll(dependentOn);
+            this.supersedes.addAll(supersedes);
+        }
+
+        @Override
+        public String getPart() {
+            return part;
+        }
+
+        @Override
+        public String getId() {
+            return id;
+        }
+
+        @Override
+        public String getDescription() {
+            return description;
+        }
+
+        @Override
+        public int getVersion() {
+            return version;
+        }
+
+        @Override
+        public String getModelingAuthoritySet() {
+            return modelingAuthoritySet;
+        }
+
+        @Override
+        public Set<String> getProfiles() {
+            return Collections.unmodifiableSet(profiles);
+        }
+
+        @Override
+        public Set<String> getDependentOn() {
+            return Collections.unmodifiableSet(dependentOn);
+        }
+
+        @Override
+        public Set<String> getSupersedes() {
+            return Collections.unmodifiableSet(supersedes);
+        }
+    }
+
+    private final List<Model> models = new ArrayList<>();
+    private final Map<String, Model> partModel = new HashMap<>();
+    private final Map<String, Model> profileModel = new HashMap<>();
+
+    CgmesMetadataModelsImpl(Set<Model> models) {
+        this.models.addAll(models);
+        models.forEach(m -> partModel.put(m.getPart(), m));
+        models.forEach(m -> m.getProfiles().forEach(profile -> profileModel.put(profile, m)));
+    }
+
+    @Override
+    public Optional<Model> getModelForPart(String part) {
+        return Optional.ofNullable(partModel.get(part));
+    }
+
+    @Override
+    public Optional<Model> getModelForProfile(String profile) {
+        return Optional.ofNullable(profileModel.get(profile));
+    }
+
+    @Override
+    public Collection<Model> getModels() {
+        return Collections.unmodifiableCollection(models);
+    }
+
+}