edu.northwestern.bioinformatics.studycalendar.domain.Epoch.java Source code

Introduction

Here is the source code for edu.northwestern.bioinformatics.studycalendar.domain.Epoch.java

Source

/*L
 * Copyright Northwestern University.
 *
 * Distributed under the OSI-approved BSD 3-Clause License.
 * See http://ncip.github.io/psc/LICENSE.txt for details.
 */

package edu.northwestern.bioinformatics.studycalendar.domain;

import edu.northwestern.bioinformatics.studycalendar.domain.tools.Differences;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.CascadeType;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.IndexColumn;
import org.hibernate.annotations.Parameter;

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.Table;
import javax.persistence.Transient;
import java.util.Collection;
import java.util.List;

/**
 * @author Rhett Sutphin
 */
@Entity
@Table(name = "epochs")
@GenericGenerator(name = "id-generator", strategy = "native", parameters = {
        @Parameter(name = "sequence", value = "seq_epochs_id") })
public class Epoch extends PlanTreeOrderedInnerNode<PlannedCalendar, StudySegment> implements Named {
    public static final String TEMPORARY_NAME = "[Unnamed epoch]";

    private String name = TEMPORARY_NAME;

    ////// FACTORY

    public static Epoch create() {
        return create(TEMPORARY_NAME);
    }

    public static Epoch create(String epochName, String... studySegmentNames) {
        Epoch epoch = new Epoch();
        epoch.setName(epochName);
        if (studySegmentNames.length == 0) {
            epoch.addNewStudySegment(epochName);
        } else {
            for (String studySegmentName : studySegmentNames) {
                epoch.addNewStudySegment(studySegmentName);
            }
        }
        return epoch;
    }

    private void addNewStudySegment(String studySegmentName) {
        StudySegment studySegment = new StudySegment();
        studySegment.setName(studySegmentName);
        addStudySegment(studySegment);
    }

    ////// LOGIC

    public Class<PlannedCalendar> parentClass() {
        return PlannedCalendar.class;
    }

    public Class<StudySegment> childClass() {
        return StudySegment.class;
    }

    public void addStudySegment(StudySegment studySegment) {
        addChild(studySegment);
    }

    @Transient
    public int getLengthInDays() {
        int len = 0;
        for (StudySegment studySegment : getStudySegments()) {
            len = Math.max(len, studySegment.getLengthInDays());
        }
        return len;
    }

    @Transient
    public boolean isMultipleStudySegments() {
        return getStudySegments().size() > 1;
    }

    @Override
    public StudySegment findNaturallyMatchingChild(String key) {
        Collection<StudySegment> found = findMatchingChildrenByName(key);
        if (found.size() == 1)
            return found.iterator().next();
        return null;
    }

    @Transient
    public boolean getHasTemporaryName() {
        return TEMPORARY_NAME.equals(getName());
    }

    ////// BEAN PROPERTIES

    // This is annotated this way so that the IndexColumn will work with
    // the bidirectional mapping.  See section 2.4.6.2.3 of the hibernate annotations docs.
    @OneToMany
    @JoinColumn(name = "epoch_id")
    @IndexColumn(name = "list_index")
    @Cascade(value = { CascadeType.ALL })
    public List<StudySegment> getStudySegments() {
        return getChildren();
    }

    public void setStudySegments(List<StudySegment> studySegments) {
        setChildren(studySegments);
    }

    // This is annotated this way so that the IndexColumn in the parent
    // will work with the bidirectional mapping
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(insertable = false, updatable = false, nullable = true)
    public PlannedCalendar getPlannedCalendar() {
        return getParent();
    }

    public void setPlannedCalendar(PlannedCalendar plannedCalendar) {
        setParent(plannedCalendar);
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Differences deepEquals(Object o) {
        Differences differences = new Differences();
        if (this == o)
            return differences;
        if (o == null || !(o instanceof Epoch)) {
            differences.addMessage("not an instance of epoch");
            return differences;
        }

        Epoch that = (Epoch) o;

        return differences.registerValueDifference("name", this.getName(), that.getName())
                .recurseDifferences("study segment", this.getStudySegments(), that.getStudySegments());
    }

    //Object methods

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;
        if (!(o instanceof Epoch))
            return false;

        Epoch epoch = (Epoch) o;
        if (name != null ? !name.equals(epoch.getName()) : epoch.getName() != null)
            return false;

        return true;
    }

    @Override
    public int hashCode() {
        int result;
        result = (name != null ? name.hashCode() : 0);
        return result;
    }

}