FeatureCvTermProp.java

package org.gmod.schema.mapped;

import static javax.persistence.GenerationType.SEQUENCE;

import org.gmod.schema.utils.Rankable;
import org.gmod.schema.utils.propinterface.PropertyI;

import java.io.Serializable;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.SequenceGenerator;
import javax.persistence.Table;

/**
 * This represents a key/value pair attached to a FeatureCvTerm. The key is
 * itself a CvTerm, with a free-text value. The value may be null, for
 * properties that are merely flags. The collection of properties (of a
 * particular FeatureCvTerm) is ordered, with the <code>rank</code> serving to
 * define the ordering.
 * <p>
 * GMOD description: Extensible properties for feature to cvterm associations.
 * Examples: GO evidence codes; qualifiers; metadata such as the date on which
 * the entry was curated and the source of the association.
 * <p>
 * Database constraints:
 * <code>feature_cvtermprop_c1 unique (feature_cvterm_id, type_id, rank)</code>
 *
 * @author art
 */
@Entity
@Table(name = "feature_cvtermprop")
public class FeatureCvTermProp implements Serializable, PropertyI, Rankable {

    // Fields

    /**
     * Database unique primary key
     */
    @SequenceGenerator(name = "generator", sequenceName = "feature_cvtermprop_feature_cvtermprop_id_seq", allocationSize=1)
    @Id @GeneratedValue(strategy = SEQUENCE, generator = "generator")
    @Column(name = "feature_cvtermprop_id", unique = false, nullable = false, insertable = true, updatable = true)
    private int featureCvTermPropId;

    /**
     * The CvTerm that acts as the key in this map of properties
     */
    @ManyToOne(cascade = {}, fetch = FetchType.LAZY)
    @JoinColumn(name = "type_id", unique = false, nullable = false, insertable = true, updatable = true)
    private CvTerm type;

    /**
     * The FeatureCvTerm to which this property is attached
     */
    @ManyToOne(cascade = {}, fetch = FetchType.LAZY)
    @JoinColumn(name = "feature_cvterm_id", unique = false, nullable = false, insertable = true, updatable = true)
    private FeatureCvTerm featureCvTerm;

    /**
     * The value of this property
     */
    @Column(name = "value", unique = false, nullable = true, insertable = true, updatable = true)
    private String value;

    /**
     * The rank is used to distinguish multiple values for the same key eg
     * /foo="value1", /foo="value2" in an EMBL file could be stored as two
     * FeatureCvTerm with different ranks. The default is 0;
     */
    @Column(name = "rank", unique = false, nullable = false, insertable = true, updatable = true)
    private int rank;

    // Constructors

    /** default constructor */
    FeatureCvTermProp() {
        // Deliberately empty default constructor
    }

    /** minimal constructor */
    public FeatureCvTermProp(CvTerm type, FeatureCvTerm featureCvTerm, int rank) {
        this.type = type;
        this.featureCvTerm = featureCvTerm;
        this.rank = rank;
    }

    /** full constructor */
    public FeatureCvTermProp(CvTerm type, FeatureCvTerm featureCvTerm, String value, int rank) {
        this.type = type;
        this.featureCvTerm = featureCvTerm;
        this.value = value;
        this.rank = rank;
    }

    // Property accessors

    public int getFeatureCvTermPropId() {
        return this.featureCvTermPropId;
    }

    public CvTerm getType() {
        return this.type;
    }

    public FeatureCvTerm getFeatureCvTerm() {
        return this.featureCvTerm;
    }

    void setFeatureCvTerm(FeatureCvTerm featureCvTerm) {
        this.featureCvTerm = featureCvTerm;
    }

    /**
     * Get the value of this property
     *
     * @return the property value, a string. May be null.
     */
    public String getValue() {
        return this.value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Get the rank of this property.
     *
     * @return the rank, a non-negative integer
     */
    public int getRank() {
        return this.rank;
    }
}