source: trunk/grails-app/domain/dbnp/studycapturing/Study.groovy @ 511

package dbnp.studycapturing

/**
 * Domain class describing the basic entity in the study capture part: the Study class.
 *
 * Revision information:
 * $Rev: 511 $
 * $Author: jahn $
 * $Date: 2010-06-02 15:00:45 +0000 (wo, 02 jun 2010) $
 */
class Study extends TemplateEntity implements Serializable {
        static searchable = true
        nimble.User owner
        String title
        Date dateCreated
        Date lastUpdated
        Date startDate
        long externalStudyID   // enables referring to studies outside of GSCF, e.g., in the Simple Assay Module 

        /**
         * return the domain fields for this domain class
         * @return List
         */
        static List<TemplateField> giveDomainFields() { return Study.domainFields }

        static final List<TemplateField> domainFields =
        [
                new TemplateField(
                        name: 'title',
                        type: TemplateFieldType.STRING),
                new TemplateField(
                        name: 'startDate',
                        type: TemplateFieldType.DATE,
                        comment: 'Fill out the official start date or date of first action')
        ]

        static hasMany = [
                editors: nimble.User,
                readers: nimble.User,
                subjects: Subject,
                events: Event,
                samplingEvents: SamplingEvent,
                eventGroups: EventGroup,
                samples: Sample,
                assays: Assay,
                persons: StudyPerson,
                publications: Publication
        ]

        static constraints = {
                owner(nullable: true, blank: true)
                externalStudyID(nullable:true, blank:true) 
        }

        static mapping = {
                researchQuestion type: 'text'
                description type: 'text'
                autoTimestamp true
        }

        /**
         * return the title of this study
         */
        def String toString() {
                return title;
        }

        /**
         * Return the unique Subject templates that are used in this study
         */
        def Set<Template> giveSubjectTemplates() {
                TemplateEntity.giveTemplates(subjects);
        }

        /**
         * Return the unique Event and SamplingEvent templates that are used in this study
         */
        Set<Template> giveAllEventTemplates() {
                // For some reason, giveAllEventTemplates() + giveAllSamplingEventTemplates()
                // gives trouble when asking .size() to the result
                // So we also use giveTemplates here
                TemplateEntity.giveTemplates(events + samplingEvents);
        }

        /**
         * Return the unique Event templates that are used in this study
         */
        Set<Template> giveEventTemplates() {
                TemplateEntity.giveTemplates(events);
        }

        /**
         * Return the unique SamplingEvent templates that are used in this study
         */
        Set<Template> giveSamplingEventTemplates() {
                TemplateEntity.giveTemplates(samplingEvents);
        }

        /**
         * Returns the unique Sample templates that are used in the study
         */
        Set<Template> giveSampleTemplates() {
                TemplateEntity.giveTemplates(samples);
        }
        /**
         * Returns the template of the study
         */
        Template giveStudyTemplate() {
                return this.template;
        }
}