aswi2020vldc-gitlab/src/main/java/vldc/aswi/domain/parameter/ParameterInConfiguration.java @ 9714fae3

package vldc.aswi.domain.parameter;

import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import vldc.aswi.domain.*;
import vldc.aswi.validators.operator.value.OperatorValueConstraint;

import javax.persistence.*;
import java.util.List;

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

    /** Specific configuration in which is this parameterConfiguration presented. */
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "konfigurace_id")
    private Configuration configuration;

    /** Specific parameter of configuration, which is used as template. */
    @ManyToOne(fetch=FetchType.EAGER)
    @JoinColumn(name = "parametr_id")
    private Parameter parameter;

    /** Value of used operator. */
    @Column(name = "hodnota_operatoru")
    private String operatorValue;

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

    /** Specific location in which this parameterConfiguration will be used. */
    @ManyToOne(fetch=FetchType.EAGER)
    @JoinColumn(name = "umisteni_id")
    private Location location;

    /** User-defined name of this parameterConfiguration. */
    @Column(name = "nazev_sloupce")
    private String columnName;

    /** Specific operator which will be aplied onto data. */
    @ManyToOne(fetch=FetchType.LAZY)
    @JoinColumn(name = "operator_id")
    private Operator operator;

    /**
     * Creating new table with M:N relationship between ParameterInConfiguration and Function.
     * On every ParameterInConfiguration can be applied 0 - every function.
     */
    @ManyToMany(cascade = CascadeType.PERSIST)
    @JoinTable(
            name = "Parametr_konfigurace_ma_Funkce",
            joinColumns = @JoinColumn(name = "parametr_konfigurace_id"),
            inverseJoinColumns = @JoinColumn(name = "funkce_id")
    )
    private List<Function> functions;

    /**
     * Constructor.
     * @param operatorValue - Value of used operator.
     * @param columnName - User-defined name of this parameterConfiguration.
     */
    public ParameterInConfiguration(String operatorValue, String columnName) {
        this.setOperatorValue(operatorValue);
        this.setColumnName(columnName);
    }

    /**
     * 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);
    }

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

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

    /**
     * Compare two parameters in configuration by parameterOrder from 0 to X.
     * @param parameterInConfiguration - Compared parameter in configuration.
     * @return difference between orders
     */
    @Override
    public int compareTo(ParameterInConfiguration parameterInConfiguration) {
        return (this.getParameterOrder() - parameterInConfiguration.getParameterOrder());
    }
}