Changeset 778 for trunk/grails-app/domain

Timestamp:

Aug 5, 2010, 10:58:09 PM (11 years ago)

Author:

duh

Message:

• big refactoring of the Study Capture Wizard until the grouping page, removing all internal maps and directory work on the study object to
  • simplify internal representation and handling
  • added static incremental identifiers to TemplateEntity?, EventGroup? and Template for use in dynamic web forms
• TODO: fix the sample page
• TODO: check cascaded deletes, confirm database content

Location:

trunk/grails-app/domain/dbnp/studycapturing

Files:

• EventGroup.groovy (modified) (2 diffs)
• Study.groovy (modified) (4 diffs)
• Template.groovy (modified) (2 diffs)
• TemplateEntity.groovy (modified) (5 diffs)

trunk/grails-app/domain/dbnp/studycapturing/EventGroup.groovy

@@ -10 +10 @@
  */
 class EventGroup implements Serializable {
-
-        static belongsTo = [parent : Study]
-
         String name
 
+        // keep an internal identifier for use in dynamic forms
+        private int identifier = 0
+        static int iterator = 0
+
+        static transients = [ "identifier", "iterator" ]
+        static belongsTo = [parent : Study]
         static hasMany = [
                 subjects: Subject,
@@ -23 +26 @@
         static constraints = {
         }
+
+        /**
+         * Class constructor increments that static iterator
+         * and sets the object's identifier (used in dynamic webforms)
+         * @void
+         */
+        public EventGroup() {
+                if (!identifier) identifier = iterator++
+        }
+
+        /**
+         * Return the identifier
+         * @return int
+         */
+        final public int getIdentifier() {
+                return identifier
+        }
 }

trunk/grails-app/domain/dbnp/studycapturing/Study.groovy

@@ -100 +100 @@
         }
 
+
+        /**
+         * Return all subjects for a specific template
+         * @param Template
+         * @return ArrayList
+         */
+        def ArrayList<Subject> giveSubjectsForTemplate(Template template) {
+                subjects.findAll { it.template.equals(template) }
+        }
+
         /**
          * Return the unique Event and SamplingEvent templates that are used in this study
@@ -107 +117 @@
                 // gives trouble when asking .size() to the result
                 // So we also use giveTemplates here
-                TemplateEntity.giveTemplates(events + samplingEvents)
+                TemplateEntity.giveTemplates( ((events) ? events : []) + ((samplingEvents) ? samplingEvents : []) )
+        }
+
+
+        /**
+         * Return all events and samplingEvenets for a specific template
+         * @param Template
+         * @return ArrayList
+         */
+        def ArrayList giveEventsForTemplate(Template template) {
+                def events = events.findAll { it.template.equals(template) }
+                def samplingEvents = samplingEvents.findAll { it.template.equals(template) }
+
+                return (events) ? events : samplingEvents
         }
 
@@ -138 +161 @@
 
 
-         /**
-        * Delete a specific subject from this study, including all its relations
-        * @param subject The subject to be deleted
-        * @return A String which contains a (user-readable) message describing the changes to the database
-        */
+        /**
+         * Delete a specific subject from this study, including all its relations
+         * @param subject The subject to be deleted
+         * @return A String which contains a (user-readable) message describing the changes to the database
+         */
         String deleteSubject(Subject subject) {
-
                 String msg = "Subject ${subject.name} was deleted"
 
@@ -171 +193 @@
                 return msg
         }
+
+        /**
+         * Delete an event from the study, including all its relations
+         * @param Event
+         * @return String
+         */
+        String deleteEvent(Event event) {
+                String msg = "Event ${event} was deleted"
+
+                // remove event from the study
+                this.removeFromEvents(event)
+
+                // remove event from eventGroups
+                this.eventGroups.each() { eventGroup ->
+                        eventGroup.removeFromEvents(event)
+                }
+
+                return msg
+        }
+
+        /**
+         * Delete a samplingEvent from the study, including all its relations
+         * @param SamplingEvent
+         * @return String
+         */
+        String deleteSamplingEvent(SamplingEvent samplingEvent) {
+                String msg = "SamplingEvent ${samplingEvent} was deleted"
+
+                // remove event from eventGroups
+                this.eventGroups.each() { eventGroup ->
+                        eventGroup.removeFromSamplingEvents(samplingEvent)
+                }
+
+                // remove event from the study
+                this.removeFromSamplingEvents(samplingEvent)
+
+                return msg
+        }
+        /**
+         * Delete an eventGroup from the study, including all its relations
+         * @param EventGroup
+         * @return String
+         */
+        String deleteEventGroup(EventGroup eventGroup) {
+                String msg = "EventGroup ${eventGroup} was deleted"
+
+                // remove the eventGroup from the study
+                this.removeFromEventGroups(eventGroup)
+
+                return msg
+        }
 }

trunk/grails-app/domain/dbnp/studycapturing/Template.groovy

@@ -33 +33 @@
         /** The template fields which are the members of this template. This is a List to preserve the field order */
         List fields
+
+        // keep an internal identifier for use in dynamic forms
+        private int identifier = 0
+        static int iterator = 0
+
+        // set transients
+        static transients = [ "identifier", "iterator" ]
+
         static hasMany = [fields: TemplateField]
 
@@ -70 +78 @@
                 // which can co-exist with the same name. See also TemplateField
                 //      name(unique:['entity'])
+        }
+
+        /**
+         * Class constructor increments that static iterator
+         * and sets the object's identifier (used in dynamic webforms)
+         * @void
+         */
+        public Template() {
+                if (!identifier) identifier = iterator++
+                println ".instantiating [" + this.getClass() + "] ("+ identifier + ")"
+        }
+
+        /**
+         * Return the identifier
+         * @return int
+         */
+        final public int getIdentifier() {
+                return identifier
         }
 

trunk/grails-app/domain/dbnp/studycapturing/TemplateEntity.groovy

@@ -18 +18 @@
  */
 abstract class TemplateEntity implements Serializable {
-
         /** The actual template of this TemplateEntity instance */
         Template template
@@ -38 +37 @@
         Map templateTermFields = [:]
 
+        // keep an internal identifier for use in dynamic forms
+        private int identifier = 0
+        static int iterator = 0
+
+        // set transients
+        static transients = [ "identifier", "iterator" ]
+
+        // define relationships
         static hasMany = [
                 templateStringFields: String,
@@ -54 +61 @@
 
         static mapping = {
-
                 // Specify that each TemplateEntity-subclassing entity should have its own tables to store TemplateField values.
                 // This results in a lot of tables, but performance is presumably better because in most queries, only values of
@@ -324 +330 @@
                         return (!error)
                 })
+        }
+
+        /**
+         * Class constructor increments that static iterator
+         * and sets the object's identifier (used in dynamic webforms)
+         * @void
+         */
+        public TemplateEntity() {
+                if (!identifier) identifier = iterator++
+        }
+
+        /**
+         * Return the identifier
+         * @return int
+         */
+        final public int getIdentifier() {
+                return identifier
         }
 
@@ -593 +616 @@
                         // it is unset if it is.
                         if (value || value == 0 || ( field.type == TemplateFieldType.BOOLEAN && value == false)) {
-                                println ".setting [" + ((super) ? super.class : '??') + "] template field: [" + fieldName + "] ([" + value.toString() + "] of type [" + value.class + "])"
+                                println ".setting [" + ((super) ? super.class : '??') + "] ("+getIdentifier()+") template field: [" + fieldName + "] ([" + value.toString() + "] of type [" + value.class + "])"
 
                                 // set value
                                 store[fieldName] = value
                         } else if (store[fieldName]) {
-                                println ".unsetting [" + ((super) ? super.class : '??') + "] template field: [" + fieldName + "]"
+                                println ".unsetting [" + ((super) ? super.class : '??') + "] ("+getIdentifier()+") template field: [" + fieldName + "]"
 
                                 // remove the item from the Map (if present)