com.powsybl.cgmes.conversion.NamingStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-cgmes-conversion Show documentation

Conversion between CGMES and IIDM Network definitions

There is a newer version: 6.6.0

Show newest version

/**
 * Copyright (c) 2017-2018, 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/.
 */

package com.powsybl.cgmes.conversion;

import com.powsybl.commons.PowsyblException;
import com.powsybl.commons.datasource.DataSource;
import com.powsybl.iidm.network.Identifiable;

import java.nio.file.Path;

/**
 * @author Luma Zamarreño 
 */
public interface NamingStrategy {

    String getName();

    String getGeographicalTag(String geo);

    String getIidmId(String type, String id);

    String getCgmesId(Identifiable identifiable);

    default String getCgmesId(Identifiable identifiable, String subObject) {
        return identifiable.getId() + "_" + subObject;
    }

    default String getCgmesIdFromAlias(Identifiable identifiable, String aliasType) {
        return identifiable.getAliasFromType(aliasType).orElseThrow(() -> new PowsyblException("Missing alias " + aliasType + " in " + identifiable.getId()));
    }

    default String getCgmesIdFromProperty(Identifiable identifiable, String propertyName) {
        return identifiable.getProperty(propertyName);
    }

    default String getCgmesId(String identifier) {
        return identifier;
    }

    String getName(String type, String name);

    void readIdMapping(Identifiable identifiable, String type);

    void writeIdMapping(Path path);

    void writeIdMapping(String mappingFileName, DataSource ds);

    final class Identity implements NamingStrategy {

        @Override
        public String getName() {
            return NamingStrategyFactory.IDENTITY;
        }

        @Override
        public String getGeographicalTag(String geo) {
            return geo;
        }

        @Override
        public String getIidmId(String type, String id) {
            return id;
        }

        @Override
        public String getCgmesId(Identifiable identifiable) {
            return identifiable.getId();
        }

        @Override
        public String getName(String type, String name) {
            return name;
        }

        @Override
        public void readIdMapping(Identifiable identifiable, String type) {
            // do nothing
        }

        @Override
        public void writeIdMapping(Path path) {
            // do nothing
        }

        @Override
        public void writeIdMapping(String mappingFileName, DataSource ds) {
            // do nothing
        }
    }
}