com.farao_community.farao.ra_optimisation.converter.RaoComputationResultExporters Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 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.farao_community.farao.ra_optimisation.converter;

import com.farao_community.farao.ra_optimisation.RaoComputationResult;
import com.powsybl.commons.PowsyblException;

import java.io.IOException;
import java.io.OutputStream;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.ServiceLoader;

/**
 * A utility class to work with remedial actions optimisation result exporters
 *
 * @author Sebastien Murgey {@literal }
 */
public final class RaoComputationResultExporters {

    private RaoComputationResultExporters() {
    }

    /**
     * Get all supported formats.
     *
     * @return the supported formats
     */
    public static Collection getFormats() {
        List formats = new ArrayList<>();
        for (RaoComputationResultExporter e : ServiceLoader.load(RaoComputationResultExporter.class)) {
            formats.add(e.getFormat());
        }
        return formats;
    }

    /**
     * Get the exporter for the specified format
     *
     * @param format The export format
     *
     * @return The exporter for the specified format or null if this format is not supported
     */
    public static RaoComputationResultExporter getExporter(String format) {
        Objects.requireNonNull(format);
        for (RaoComputationResultExporter e : ServiceLoader.load(RaoComputationResultExporter.class)) {
            if (format.equals(e.getFormat())) {
                return e;
            }
        }
        return null;
    }

    public static void export(RaoComputationResult result, Path path, String format) {
        Objects.requireNonNull(path);

        try (OutputStream os = Files.newOutputStream(path)) {
            export(result, os, format);
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

    public static void export(RaoComputationResult result, OutputStream os, String format) {
        RaoComputationResultExporter exporter = getExporter(format);
        if (exporter == null) {
            throw new PowsyblException("Unsupported format: " + format + " [" + getFormats() + "]");
        }

        exporter.export(result, os);
    }
}