SummaryStatistic.java

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

package edu.harvard.iq.dataverse.datavariable;

import java.io.Serializable;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Index;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;

/*
 *
 * @author Leonid Andreev
 *    
 * Largely based on the SummaryStatistic entity from the DVN v2-3;
 * original author: Ellen Kraffmiller (2006).
 * 
 */

@Entity
@Table(indexes = {@Index(columnList="datavariable_id")})
public class SummaryStatistic implements Serializable {
    /*
     * Simple constructor: 
     */
    public SummaryStatistic() {
    }
    
    /*
     * Definitions of class properties: 
     */
   
    private static final long serialVersionUID = 1L;
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    /*
     * DataVariable for which this range is defined.
     */
    @ManyToOne
    @JoinColumn(nullable=false)
    private DataVariable dataVariable;
    
    /*
     * type of this Summary Statistic value (for ex., "median", "mean", etc.)
     */
    
    public enum SummaryStatisticType {MEAN, MEDN, MODE, MIN, MAX, STDEV, VALD, INVD}; 
    
    //@ManyToOne
    //@JoinColumn(nullable=false)
    private SummaryStatisticType type;

    
    /*
     * value: string representation of this Summary Statistic value. 
     */
    private String value;

    
    /*
     * Getter and Setter methods:
     */
    
    
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }
    
    public SummaryStatisticType getType() {
        return this.type;
    }
    
    public void setType(SummaryStatisticType type) {
        this.type = type;
    }
    
    // This method returns the summary statistic type as a character
    // label used in the DDI.
    public String getTypeLabel() {
        if (isTypeMean()) {
            return "mean";
        }
        if (isTypeMedian()) {
            return "medn";
        }
        if (isTypeMode()) {
            return "mode";
        }
        if (isTypeMin()) {
            return "min";
        }
        if (isTypeMax()) {
            return "max";
        }
        if (isTypeStdDev()) {
            return "stdev";
        }
        if (isTypeValid()) {
            return "vald";
        }
        if (isTypeInvalid()) {
            return "invd";
        }
        
        return null; 
    }
    
    public void setTypeByLabel(String label) {
        if ("mean".equals(label)) {
            setTypeMean();
        }
        else if ("medn".equals(label)) {
            setTypeMedian();
        }
        else if ("mode".equals(label)) {
            setTypeMode();
        }
        else if ("min".equals(label)) {
            setTypeMin();
        }
        else if ("max".equals(label)) {
            setTypeMax();
        }
        else if ("stdev".equals(label)) {
            setTypeStdDev();
        }
        else if ("vald".equals(label)) {
            setTypeValid();
        }
        else if ("invd".equals(label)) {
            setTypeInvalid();
        }
    }
    
    public void setTypeMean() {
        this.type = SummaryStatisticType.MEAN;
    }
    
    public void setTypeMedian() {
        this.type = SummaryStatisticType.MEDN;
    }
    
    public void setTypeMode() {
        this.type = SummaryStatisticType.MODE;
    }
    
    public void setTypeMin() {
        this.type = SummaryStatisticType.MIN;
    }
    
    public void setTypeMax() {
        this.type = SummaryStatisticType.MAX;
    }
    
    public void setTypeStdDev() {
        this.type = SummaryStatisticType.STDEV;
    }
    
    public void setTypeValid() {
        this.type = SummaryStatisticType.VALD;
    }
    
    public void setTypeInvalid() {
        this.type = SummaryStatisticType.INVD;
    }
    
    
    public boolean isTypeMean() {
        return this.type == SummaryStatisticType.MEAN;
    }
    
    public boolean isTypeMedian() {
        return this.type == SummaryStatisticType.MEDN;
    }
    
    public boolean isTypeMode() {
        return this.type == SummaryStatisticType.MODE;
    }
    
    public boolean isTypeMin() {
        return this.type == SummaryStatisticType.MIN;
    }
    
    public boolean isTypeMax() {
        return this.type == SummaryStatisticType.MAX;
    }
    
    public boolean isTypeStdDev() {
        return this.type == SummaryStatisticType.STDEV;
    }
    
    public boolean isTypeValid() {
        return this.type == SummaryStatisticType.VALD;
    }
    
    public boolean isTypeInvalid() {
        return this.type == SummaryStatisticType.INVD;
    }
    

    public String getValue() {
        return this.value;
    }
    
    public void setValue(String value) {
        this.value = value;
    }
    public DataVariable getDataVariable() {
        return this.dataVariable;
    }

    public void setDataVariable(DataVariable dataVariable) {
        this.dataVariable = dataVariable;
    }
    
    
    /* 
     * Custom overrides for hashCode(), equals() and toString() methods:
     */
    
    
    @Override
    public int hashCode() {
        int hash = 0;
        hash += (this.id != null ? this.id.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object object) {
        if (!(object instanceof SummaryStatistic)) {
            return false;
        }
        
        SummaryStatistic other = (SummaryStatistic)object;
        if (this.id != other.id) {
            if (this.id == null || !this.id.equals(other.id)) {
                return false;
            }                    
        }
        return true;
    }
    
    @Override
    public String toString() {
        return "edu.harvard.iq.dataverse.SummaryStatistic[ value=" + value + " ]";
    }
    
}