aswi2020vldc-gitlab/src/main/java/vldc/aswi/domain/parameter/Parameter.java @ 621e3fca

package vldc.aswi.domain.parameter;

import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import vldc.aswi.domain.*;
import javax.persistence.*;
import java.util.List;

/**
 * Domain entity representing Parameter in application.
 */
@Entity(name = "Parametr")
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
public class Parameter extends EntityParent implements Comparable<Parameter> {

    /** Name of parameter in SQL query. */
    @Column(name = "nazev")
    private String name;

    /** Admin-defined name of parameter, which will be used in assembly. */
    @Column(name = "nazev_select")
    private String nameOfSelect;

    /** Specific assembly, in which this parameter will be part of. */
    @ManyToOne(fetch = FetchType.EAGER)
    @JoinColumn(name = "sestava_id")
    private Assembly assembly;

    /** Specific type of parameter, which represents type of entry. */
    @ManyToOne(fetch=FetchType.EAGER)
    @JoinColumn(name = "parametr_typ_id")
    private ParameterType parameterType;

    /** Default value of this parameter. */
    @Column(name = "default_hodnota")
    private String defaultValue;

    /** Order of parameter. */
    @Column(name = "poradi")
    private int parameterOrder;

    /** List of parametersInConfiguration, which using this parameter. */
    @OneToMany(mappedBy = "parameter")
    private List<ParameterInConfiguration> parametersInConfiguration;

    /** List of parametersInConfiguration, which using this parameter. */
    @OneToMany(mappedBy = "parameter", fetch = FetchType.EAGER)
    private List<ParameterValue> parameterValues;

    /**
     * Creating new table with M:N relationship between Parameter and Location.
     * Specify which locations can be used for parameter.
     */
    @ManyToMany
    @JoinTable(
            name = "Parametr_ma_Umisteni",
            joinColumns = @JoinColumn(name = "parametr_id"),
            inverseJoinColumns = @JoinColumn(name = "umisteni_id")
    )
    private List<Location> locations;

    /**
     * Creating new table with M:N relationship between Parameter and Function.
     * Specify which functions can be used for parameter.
     */
    @ManyToMany
    @JoinTable(
            name = "Parametr_ma_Funkce",
            joinColumns = @JoinColumn(name = "parametr_id"),
            inverseJoinColumns = @JoinColumn(name = "funkce_id")
    )
    private List<Function> functions;

    /**
     * Creating new table with M:N relationship between Parameter and Operator.
     * Specify which operators can be used for parameter.
     */
    @ManyToMany
    @JoinTable(
            name = "Parametr_ma_Operator",
            joinColumns = @JoinColumn(name = "parametr_id"),
            inverseJoinColumns = @JoinColumn(name = "operator_id")
    )
    private List<Operator> operators;

    /**
     * Constructor.
     * @param name - Name of parameter in SQL query.
     * @param nameOfSelect - Admin-defined name of parameter, which will be used in assembly.
     * @param defaultValue - Default value of this parameter.
     */
    public Parameter(String name, String nameOfSelect, String defaultValue) {
        this.setName(name);
        this.setNameOfSelect(nameOfSelect);
        this.setDefaultValue(defaultValue);
    }

    /**
     * Overriding toString method to prevent StackOverflowError.
     * @return Object with zero parameters.
     */
    @Override
    public String toString() {
        return "Parameter[]";
    }

    /**
     * Equal method for comparing two objects.
     * @param obj - Comparing object.
     * @return true if objects are same.
     */
    @Override
    public boolean equals(Object obj) {
        return super.equals(obj);
    }

    /**
     * Remove function from parameter in 'Parametr_ma_Funkce' table.
     * @param function - Function to be removed.
     */
    public void removeFunction(Function function) {
        functions.remove(function);
        function.getParameters().remove(this);
    }

    /**
     * Remove operator from parameter in 'Parametr_ma_Operator' table.
     * @param operator - Operator to be removed.
     */
    public void removeOperator(Operator operator) {
        operators.remove(operator);
        operator.getParameters().remove(this);
    }

    /**
     * Remove location from parameter in 'Parametr_ma_Umisteni' table.
     * @param location - Location to be removed.
     */
    public void removeLocation(Location location) {
        locations.remove(location);
        location.getParameters().remove(this);
    }

    /**
     * Compare two parameters by parameterOrder from 0 to X.
     * @param parameter - Compared parameter.
     * @return 1 if current parameter is higher, -1 if lower.
     */
    @Override
    public int compareTo(Parameter parameter) {
        if (this.getParameterOrder() > parameter.getParameterOrder()) {
            return 1;
        }
        else {
            return -1;
        }
    }
}