com.powsybl.iidm.serde.AbstractSimpleIdentifiableSerDe Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2023, 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.iidm.serde;

import com.powsybl.commons.PowsyblException;
import com.powsybl.iidm.network.Identifiable;
import com.powsybl.iidm.network.IdentifiableAdder;
import com.powsybl.iidm.serde.util.IidmSerDeUtil;

/**
 * Abstract class for serializing/deserializing equipment that can and/or must be entirely created before reading their sub-elements.
 *
 * @author Miora Vedelago {@literal }
 */
abstract class AbstractSimpleIdentifiableSerDe, A extends IdentifiableAdder, P extends Identifiable> extends AbstractIdentifiableSerDe {

    protected abstract T readRootElementAttributes(A adder, P parent, NetworkDeserializerContext context);

    protected void readSubElement(String elementName, T identifiable, NetworkDeserializerContext context) {
        switch (elementName) {
            case PropertiesSerDe.ROOT_ELEMENT_NAME -> PropertiesSerDe.read(identifiable, context);
            case AliasesSerDe.ROOT_ELEMENT_NAME -> {
                IidmSerDeUtil.assertMinimumVersion(getRootElementName(), AliasesSerDe.ROOT_ELEMENT_NAME, IidmSerDeUtil.ErrorMessage.NOT_SUPPORTED, IidmVersion.V_1_3, context);
                AliasesSerDe.read(identifiable, context);
            }
            default -> throw new PowsyblException("Unknown element name '" + elementName + "' in '" + identifiable.getId() + "'");
        }
    }

    @Override
    public final void read(P parent, NetworkDeserializerContext context) {
        A adder = createAdder(parent);
        readIdentifierAttributes(adder, context);
        T identifiable = readRootElementAttributes(adder, parent, context);
        if (identifiable != null) {
            readSubElements(identifiable, context);
        } else {
            context.getReader().skipChildNodes();
        }
    }

    protected abstract void readSubElements(T identifiable, NetworkDeserializerContext context);
}