DataFileTag.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;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.persistence.Column;
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
 */
@Entity
@Table(indexes = {@Index(columnList="datafile_id")})
public class DataFileTag implements Serializable {
    private static final long serialVersionUID = 1L;
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    /*
     * DataFile to which this tag belongs.
     */
     @ManyToOne
     @JoinColumn(nullable=false)
     private DataFile dataFile;
     
     
    // TODO: 
    // add a mechanism for defining tags in the database, in addition to 
    // these built-in tags (?). 
    // -- L.A. 4.0 beta 9
    public enum TagType {Survey, TimeSeries, Panel, Event, Genomics, Network, Geospatial};
    
    private static final Map<TagType, String> TagTypeToLabels = new HashMap<>();
    
    private static final Map<String, TagType> TagLabelToTypes = new HashMap<>();
    
    
    static {
        TagTypeToLabels.put(TagType.Survey, "Survey");
        TagTypeToLabels.put(TagType.TimeSeries, "Time Series");
        TagTypeToLabels.put(TagType.Panel, "Panel");
        TagTypeToLabels.put(TagType.Event, "Event");
        TagTypeToLabels.put(TagType.Genomics, "Genomics");
        TagTypeToLabels.put(TagType.Network, "Network");
        TagTypeToLabels.put(TagType.Geospatial, "Geospatial");
    }
    
    static {
        TagLabelToTypes.put("Survey", TagType.Survey);
        TagLabelToTypes.put("Time Series", TagType.TimeSeries);
        TagLabelToTypes.put("Panel", TagType.Panel);
        TagLabelToTypes.put("Event", TagType.Event);
        TagLabelToTypes.put("Genomics", TagType.Genomics);
        TagLabelToTypes.put("Network", TagType.Network);
        TagLabelToTypes.put("Geospatial", TagType.Geospatial);
    }
    
    public static List<String> listTags() {
        List<String> retlist = new ArrayList();
        
        for(TagType t : TagType.values()) {
            retlist.add(TagTypeToLabels.get(t));
        }
        
        return retlist;
    }
    
    @Column( nullable = false )
    private TagType type; 
    
    public DataFile getDataFile() {
        return this.dataFile;
    }
    
    public void setDataFile(DataFile dataFile) {
        this.dataFile = dataFile;
    }
    
    public TagType getType() {
        return this.type;
    }
    
    
    public void setType(TagType type) {
        this.type = type;
    }
    
    public void setTypeByLabel(String label) {
        TagType tagtype = TagLabelToTypes.get(label);
        
        if (tagtype == null) {
            throw new IllegalArgumentException("Unknown DataFile Tag: "+label);
        }
        
        this.type = tagtype; 
    }
    
    public String getTypeLabel() {
        if (this.type != null) {
            return TagTypeToLabels.get(this.type);
        }
        
        return null; 
    }
    
    /**
     * Is this a geospatial tag, e.g. TagType.Geospatial
     * @return 
     */
    public boolean isGeospatialTag(){
        if (this.type == null){
            return false;
        }
        if (this.type == TagType.Geospatial){
            return true;
        }
        return false;
    }
    
    @Override
    public int hashCode() {
        int hash = 0;
        hash += (id != null ? id.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object object) {
        // TODO: Warning - this method won't work in the case the id fields are not set
        if (!(object instanceof DataFileTag)) {
            return false;
        }
        DataFileTag other = (DataFileTag) object;
        if ((this.id == null && other.id != null) || (this.id != null && !this.id.equals(other.id))) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "edu.harvard.iq.dataverse.DataFileTag[ id=" + id + " ]";
    }
    
}