Observable.java

Go to the documentation of this file.

package cedar.hepdata.model;

import java.util.Set;
import java.util.HashSet;

import cedar.hepdata.util.*;

import javax.persistence.*;

@Entity
@Table(name="Observables")
public class Observable extends Storeable {
    @Id @GeneratedValue
    @Column(name="OBSERVABLE_ID")
    private Long _id;

    @Column(name="Name", nullable=false, unique=true)
    private String _name;

    @Column(name="Description", nullable=false)
    private String _description = "";

    @ManyToMany
    private Set<ObservableGroup> _observableGroups = new HashSet<ObservableGroup>();

    @OneToMany(mappedBy="_observable")
    @org.hibernate.annotations.Cascade(value={org.hibernate.annotations.CascadeType.ALL})
    private Set<YAxis> _yAxes = new HashSet<YAxis>();

    @Column(name="Unit", nullable=false)
    @org.hibernate.annotations.Type(type="cedar.hepdata.db.UnitUserType")
    private Unit _canonicalUnit = new Unit();




    public Observable() {}

    public Observable(String name) {
        log().debug("Calling 1 arg constructor");
        setName(name);
    }

    public Observable(String name, Unit unit) {
        this(name);
        log().debug("Calling 2 arg constructor");
        setCanonicalUnit(unit);
    }




    // Name
    public String getName() {
        return _name;
    }
    public Observable setName(String name) {
        _name = name;
        return this;
    }


    // Description
    public String getDescription() {
        return _description;
    }
    public Observable setDescription(String description) {
        _description = description;
        return this;
    }


    public Unit getCanonicalUnit() {
        return _canonicalUnit;
    }
    public Observable setCanonicalUnit(Unit canonicalUnit) {
        _canonicalUnit = canonicalUnit;
        return this;
    }


    // Manipulating the set of ObservableGroups
    public Set<ObservableGroup> getObservableGroups() {
        return _observableGroups;
    }
    public Observable setObservableGroups(Set<ObservableGroup> observableGroups) {
        _observableGroups = observableGroups;
        return this;
    }
    public Observable addObservableGroup(ObservableGroup observableGroup) {
        if (observableGroup != null) {
            observableGroup.getObservables().add(this);
            _observableGroups.add(observableGroup);
        } else {
            log().warn("Tried to add a null ObservableGroup to an Observable");
        }
        return this;
    }
    public Observable removeObservableGroup(ObservableGroup observableGroup) {
        if (observableGroup != null) {
            observableGroup.getObservables().remove(this);
            _observableGroups.remove(observableGroup);
        } else {
            log().warn("Tried to remove a null ObservableGroup from an Observable");
        }
        return this;
    }


    // Y-axes which match this observable
    public Set<YAxis> getYAxes() {
        return _yAxes;
    }
    public Observable setYAxes(Set<YAxis> yAxes) {
        _yAxes = yAxes;
        return this;
    }
    public Observable addYAxis(YAxis yAxis) {
        if (yAxis != null) {
            _yAxes.add(yAxis);
            yAxis.setObservable(this);
        } else {
            log().warn("Tried to add a null YAxis to an Observable");
        }
        return this;
    }
    public Observable removeYAxis(YAxis yAxis) {
        if (yAxis != null) {
            _yAxes.remove(yAxis);
            yAxis.setObservable(null);
        } else {
            log().warn("Tried to remove a null YAxis from an Observable");
        }
        return this;
    }

}

---