com.powsybl.metrix.mapping.log.LimitLogBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-metrix-mapping Show documentation

There is a newer version: 2.6.0

Show newest version

/*
 * Copyright (c) 2021, 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.metrix.mapping.log;

import java.util.Objects;

/**
 * @author Valentin Berthault {@literal }
 */
public class LimitLogBuilder implements LogDescriptionBuilder {

    private String id;
    private String variableToChange;
    private String variable;
    private int nbViolation;
    private double oldValue;
    private double newValue;
    private String comparision;
    private String evolution;

    private static final String LIMIT_CHANGE = "limit change" + LABEL_SEPARATOR;

    public LimitLogBuilder id(String id) {
        this.id = Objects.requireNonNull(id);
        return this;
    }

    public LimitLogBuilder variable(String variable) {
        this.variable = Objects.requireNonNull(variable);
        return this;
    }

    public LimitLogBuilder nbViolation(int nbViolation) {
        this.nbViolation = nbViolation;
        return this;
    }

    public LimitLogBuilder variableToChange(String variableToChange) {
        this.variableToChange = Objects.requireNonNull(variableToChange);
        return this;
    }

    public LimitLogBuilder oldValue(double oldValue) {
        this.oldValue = oldValue;
        return this;
    }

    public LimitLogBuilder newValue(double newValue) {
        this.newValue = newValue;
        return this;
    }

    public LogContent build() {
        LogContent log = new LogContent();
        log.label = LIMIT_CHANGE + variableToChange;
        log.message = String.format("%s of %s%s%s for %s variants, %s%s%s to %s", variableToChange, id, comparision,
                variable, nbViolation, variableToChange, evolution, formatDouble(oldValue), formatDouble(newValue));
        return log;
    }

    public LimitLogBuilder isMin() {
        this.comparision = " higher than ";
        this.evolution = " decreased from ";
        return this;
    }

    public LimitLogBuilder isMax() {
        this.comparision = " lower than ";
        this.evolution = " increased from ";
        return this;
    }
}