com.powsybl.cgmes.conversion.elements.AbstractIdentifiedObjectConversion 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.elements;

import com.powsybl.cgmes.conversion.Context;
import com.powsybl.iidm.network.IdentifiableAdder;
import com.powsybl.triplestore.api.PropertyBag;
import com.powsybl.triplestore.api.PropertyBags;

/**
 * @author Luma Zamarreño 
 */
public abstract class AbstractIdentifiedObjectConversion extends AbstractObjectConversion {

    public AbstractIdentifiedObjectConversion(String type, PropertyBag properties, Context context) {
        super(type, properties, context);

        this.id = properties.getId(type);
        this.name = p.get("name");
        if (this.name == null) {
            missing("name");
        }
    }

    public AbstractIdentifiedObjectConversion(String type, PropertyBags propertiess, Context context) {
        super(type, propertiess, context);

        this.id = ps.get(0).getId(type);
        this.name = ps.get(0).get("name");
        if (this.name == null) {
            missing("name");
        }
    }

    public String id() {
        return this.id;
    }

    public String name() {
        return this.name;
    }

    public String iidmId() {
        return context.namingStrategy().getIidmId(type, id);
    }

    public String iidmName() {
        return context.namingStrategy().getName(type, name);
    }

    // Identification

    public void identify(IdentifiableAdder adder) {
        identify(adder, iidmId(), iidmName());
    }

    public void identify(IdentifiableAdder adder, String duplicatedTag) {
        identify(adder, iidmId() + duplicatedTag, iidmName() + duplicatedTag);
    }

    public void identify(IdentifiableAdder adder, String id, String name) {
        identify(context, adder, id, name);
    }

    public static void identify(Context context, IdentifiableAdder adder, String id, String name) {
        adder
                .setId(id)
                .setName(name)
                .setEnsureIdUnicity(context.config().isEnsureIdAliasUnicity());
    }

    @Override
    public String what() {
        if (name != null) {
            return String.format("%s %s (%s)", type, name, id);
        } else {
            return String.format("%s %s", type, id);
        }
    }

    @Override
    protected String complete(String what) {
        if (name != null) {
            return String.format("%s at %s %s (%s)", what, type, name, id);
        } else {
            return String.format("%s at %s %s", what, type, id);
        }
    }

    protected final String id;
    protected final String name;
}