eu.itesla_project.ucte.network.UcteNodeCode.java Source code

Introduction

Here is the source code for eu.itesla_project.ucte.network.UcteNodeCode.java

Source

/**
 * Copyright (c) 2016, All partners of the iTesla project (http://www.itesla-project.eu/consortium)
 * 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 eu.itesla_project.ucte.network;

import com.google.common.base.Strings;
import java.util.Objects;

/**
 *
 * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
 */
public class UcteNodeCode {

    private UcteCountryCode ucteCountryCode;
    private String geographicalSpot;
    private UcteVoltageLevelCode voltageLevelCode;
    private Character busbar;

    public UcteNodeCode(UcteCountryCode ucteCountryCode, String geographicalSpot,
            UcteVoltageLevelCode voltageLevelCode, Character busbar) {
        this.ucteCountryCode = ucteCountryCode;
        this.geographicalSpot = geographicalSpot;
        this.voltageLevelCode = voltageLevelCode;
        this.busbar = busbar;
    }

    /**
     * Gets UCTE country code.
     * @return UCTE country code
     */
    public UcteCountryCode getUcteCountryCode() {
        return ucteCountryCode;
    }

    /**
     * Sets UCTE country code.
     * @param ucteCountryCode UCTE country code
     */
    public void setUcteCountryCode(UcteCountryCode ucteCountryCode) {
        this.ucteCountryCode = ucteCountryCode;
    }

    /**
     * Gets short description of the geographical spot.
     * @return short description of the geographical spot
     */
    public String getGeographicalSpot() {
        return geographicalSpot;
    }

    /**
     * Sets short description of the geographical spot.
     * @param geographicalSpot short description of the geographical spot
     */
    public void setGeographicalSpot(String geographicalSpot) {
        this.geographicalSpot = geographicalSpot;
    }

    /**
     * Gets voltage level.
     * @return voltage level
     */
    public UcteVoltageLevelCode getVoltageLevelCode() {
        return voltageLevelCode;
    }

    /**
     * Sets voltage level.
     * @param voltageLevelCode voltage level
     */
    public void setVoltageLevelCode(UcteVoltageLevelCode voltageLevelCode) {
        this.voltageLevelCode = voltageLevelCode;
    }

    /**
     * Gets letter or figure for differentiating bus bars (optional).
     * @return letter or figure for differentiating bus bars
     */
    public Character getBusbar() {
        return busbar;
    }

    /**
     * Sets letter or figure for differentiating bus bars (optional).
     * @param busbar letter or figure for differentiating bus bars
     */
    public void setBusbar(Character busbar) {
        this.busbar = busbar;
    }

    @Override
    public int hashCode() {
        return Objects.hash(ucteCountryCode, geographicalSpot, voltageLevelCode, busbar);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof UcteNodeCode) {
            UcteNodeCode other = (UcteNodeCode) obj;
            return ucteCountryCode == other.ucteCountryCode && geographicalSpot.equals(other.geographicalSpot)
                    && voltageLevelCode == other.voltageLevelCode && Objects.equals(busbar, other.busbar);
        }
        return false;
    }

    @Override
    public String toString() {
        return ucteCountryCode.getUcteCode() + Strings.padEnd(geographicalSpot, 5, ' ') + voltageLevelCode.ordinal()
                + (busbar != null ? busbar : ' ');
    }

}