Changeset 390

Timestamp:

May 3, 2010, 3:55:29 PM (14 years ago)

Author:

duh

Message:

• refactored TemplateEntity? to check for and handle event + domain fields properly
• refactored wizard event page to

1) display events seperated in event templates
2) display cross-template event groups

• todo: event fields are not yet properly handled

Location:

trunk/grails-app

Files:

• controllers/dbnp/studycapturing/WizardController.groovy (modified) (9 diffs)
• domain/dbnp/studycapturing/TemplateEntity.groovy (modified) (4 diffs)
• taglib/dbnp/studycapturing/WizardTagLib.groovy (modified) (6 diffs)
• views/wizard/pages/_events.gsp (modified) (3 diffs)

trunk/grails-app/controllers/dbnp/studycapturing/WizardController.groovy

@@ -242 +242 @@
                                 flow.page = 4
 
+                                /*
                                 if (!flow.event) flow.event = new Event()
                                 if (!flow.events) flow.events = []
@@ -247 +248 @@
                                         flow.eventGroups = []
                                         flow.eventGroups[0] = new EventGroup(name: 'Group 1')   // 1 group by default
+                                }
+                                */
+
+                                if (!flow.event) {
+                                        flow.event                      = new Event()
+                                        flow.events                     = []
+                                        flow.eventGroups        = []
+                                        flow.eventGroups[0]     = new EventGroup(name: 'Group 1')       // 1 group by default
+                                        flow.eventTemplates     = [:]
                                 }
                         }
@@ -303 +313 @@
                                 }
                                 */
-                                flash.values = params
+                                flash.values                    = params
+                                def eventTemplateName   = params.get('template')
+                                def eventTemplate               = Template.findByName(eventTemplateName)
+
+                                // add this event template to the event template array
+                                if (!flow.eventTemplates[ eventTemplateName ]) {
+                                        flow.eventTemplates[ eventTemplateName ] = [
+                                                name: eventTemplateName,
+                                                template: eventTemplate,
+                                                events: []
+                                        ]
+                                }
 
                                 // handle study data
@@ -310 +331 @@
                                 // validate event object
                                 if (flow.event.validate()) {
-                                        //flow.events[ flow.events.size() ] = flow.event
+
+flow.event.template.fields.each() {
+        println "["+it.name+"] = "+flow.event.getFieldValue(it.name)    
+}
+                                        // it validated! Duplicate the event object...
+                                        def newEvent    = flow.event
+                                        def increment   = flow.events.size()
+
+                                        // ...store it in the events map in the flow scope...
+                                        flow.events[ increment ] = newEvent
+
+                                        // ...and 'reset' the event object in the flow scope
+                                        flow.event = new Event(template: newEvent.template)
+                                        
+                                        // remember the event id with the template
+                                        def eventSize = flow.eventTemplates[ eventTemplateName ]['events'].size()
+                                        flow.eventTemplates[ eventTemplateName ]['events'][ eventSize ] = increment
+
                                         success()
                                 } else {
+                                        // it does not validate, show error feedback
                                         flash.errors = [:]
                                         this.appendErrors(flow.event, flash.errors)
@@ -382 +421 @@
                                 flash.values = params
                                 flash.errors = [:]
+                                /*
 
                                 // handle event groupings
@@ -394 +434 @@
                                         error()
                                 }
-                        }.to "confirm"
+                                */
+                        }.to "events"
                 }
 
@@ -524 +565 @@
         }
 
+        /**
+         * re-usable code for handling study form data in a web flow
+         * @param Map LocalAttributeMap (the flow scope)
+         * @param Map localAttributeMap (the flash scope)
+         * @param Map GrailsParameterMap (the flow parameters = form data)
+         * @returns boolean
+         */
+        def handleStudy(flow, flash, params) {
+                // create study instance if we have none
+                if (!flow.study) flow.study = new Study();
+
+                // create date instance from date string?
+                // @see WizardTagLibrary::dateElement{...}
+                if (params.get('startDate')) {
+                        params.startDate = new Date().parse("d/M/yyyy", params.get('startDate').toString())
+                } else {
+                        params.remove('startDate')
+                }
+
+                // if a template is selected, get template instance
+                def template = params.remove('template')
+                if (template instanceof String && template.size() > 0) {
+                        params.template = Template.findByName(template)
+                } else if (template instanceof Template) {
+                        params.template = template
+                }
+
+                // update study instance with parameters
+                params.each() { key, value ->
+                        if (flow.study.hasProperty(key)) {
+                                flow.study.setProperty(key, value);
+                        }
+                }
+
+                // walk through template fields
+                if (params.template) {
+                        params.template.fields.each() { field ->
+                                flow.study.setFieldValue(field.name, params.get(field.escapedName()))
+                        }
+                }
+
+                // validate study
+                if (flow.study.validate()) {
+                        return true
+                } else {
+                        // validation failed, feedback errors
+                        flash.errors = [:]
+                        this.appendErrors(flow.study, flash.errors)
+                        return false
+                }
+        }
+
+        /**
+         * re-usable code for handling subject form data in a web flow
+         * @param Map LocalAttributeMap (the flow scope)
+         * @param Map localAttributeMap (the flash scope)
+         * @param Map GrailsParameterMap (the flow parameters = form data)
+         * @returns boolean
+         */
+        def handleSubjects(flow, flash, params) {
+                def names = [:];
+                def errors = false;
+                def id = 0;
+
+                // iterate through subject templates
+                flow.subjectTemplates.each() {
+                        def subjectTemplate = it.getValue().template
+                        def templateFields      = subjectTemplate.fields
+
+                        // iterate through subjects
+                        it.getValue().subjects.each() { subjectId ->
+                                flow.subjects[ subjectId ].name = params.get('subject_' + subjectId + '_name')
+                                flow.subjects[ subjectId ].species = Term.findByName(params.get('subject_' + subjectId + '_species'))
+
+                                // remember name and check for duplicates
+                                if (!names[ flow.subjects[ subjectId ].name ]) {
+                                        names[ flow.subjects[ subjectId ].name ] = [count: 1, first: 'subject_' + subjectId + '_name', firstId: subjectId]
+                                } else {
+                                        // duplicate name found, set error flag
+                                        names[ flow.subjects[ subjectId ].name ]['count']++
+
+                                        // second occurence?
+                                        if (names[ flow.subjects[ subjectId ].name ]['count'] == 2) {
+                                                // yeah, also mention the first
+                                                // occurrence in the error message
+                                                this.appendErrorMap(name: 'The subject name needs to be unique!', flash.errors, 'subject_' + names[ flow.subjects[ subjectId ].name ]['firstId'] + '_')
+                                        }
+
+                                        // add to error map
+                                        this.appendErrorMap([name: 'The subject name needs to be unique!'], flash.errors, 'subject_' + subjectId + '_')
+                                        errors = true
+                                }
+
+                                // iterate through template fields
+                                templateFields.each() { subjectField ->
+                                        flow.subjects[ subjectId ].setFieldValue(
+                                                subjectField.name,
+                                                params.get( 'subject_' + subjectId + '_' + subjectField.escapedName() )
+                                        )
+                                }
+
+                                // validate subject
+                                if (!flow.subjects[ subjectId ].validate()) {
+                                        errors = true
+                                        this.appendErrors(flow.subjects[ subjectId ], flash.errors, 'subject_' + subjectId + '_')
+                                }
+                        }
+                }
+
+                return !errors
+        }
 
         /**
@@ -548 +700 @@
                 // set template
                 if (params.template) flow.event.template = params.template
-println flow.event.template
-println params
-                
+
                 // update event instance with parameters
                 params.each() { key, value ->
-                        try {
+                        // does this event have such a property or (if
+                        // a template is set) such a template field?
+                        if (flow.event.fieldExists(key)) {
+                                // yes, set it
                                 flow.event.setFieldValue(key, value)
-                                println "has "+key
-                        } catch (Exception e) {
-                                println "does NOT have "+key
-                        }
-                        /*
-                        if (flow.event.hasProperty(key)) {
-println "has property " +  key
-                                flow.event.setProperty(key, value);
-                        }
-                        */
-                }
-        }
-
-        /**
-         * re-usable code for handling study form data in a web flow
-         * @param Map LocalAttributeMap (the flow scope)
-         * @param Map localAttributeMap (the flash scope)
-         * @param Map GrailsParameterMap (the flow parameters = form data)
-         * @returns boolean
-         */
-        def handleStudy(flow, flash, params) {
-                // create study instance if we have none
-                if (!flow.study) flow.study = new Study();
-
-                // create date instance from date string?
-                // @see WizardTagLibrary::dateElement{...}
-                if (params.get('startDate')) {
-                        params.startDate = new Date().parse("d/M/yyyy", params.get('startDate').toString())
-                } else {
-                        params.remove('startDate')
-                }
-
-                // if a template is selected, get template instance
-                def template = params.remove('template')
-                if (template instanceof String && template.size() > 0) {
-                        params.template = Template.findByName(template)
-                } else if (template instanceof Template) {
-                        params.template = template
-                }
-
-                // update study instance with parameters
-                params.each() { key, value ->
-                        if (flow.study.hasProperty(key)) {
-                                flow.study.setProperty(key, value);
-                        }
-                }
-
-                // walk through template fields
-                if (params.template) {
-                        params.template.fields.each() { field ->
-                                flow.study.setFieldValue(field.name, params.get(field.escapedName()))
-                        }
-                }
-
-                // validate study
-                if (flow.study.validate()) {
-                        return true
-                } else {
-                        // validation failed, feedback errors
-                        flash.errors = [:]
-                        this.appendErrors(flow.study, flash.errors)
-                        return false
-                }
-        }
-
-        /**
-         * re-usable code for handling eventDescription form data in a web flow
-         * @param Map LocalAttributeMap (the flow scope)
-         * @param Map localAttributeMap (the flash scope)
-         * @param Map GrailsParameterMap (the flow parameters = form data)
-         * @returns boolean
-         */
-        def handleEventDescriptions(flow, flash, params) {
-                def names = [:]
-                def errors = false
-                def id = 0
-
-                flow.eventDescriptions.each() {
-                        it.name = params.get('eventDescription_' + id + '_name')
-                        it.description = params.get('eventDescription_' + id + '_description')
-                        it.protocol = Protocol.findByName(params.get('eventDescription_' + id + '_protocol'))
-                        //it.classification = Term.findByName(params.get('eventDescription_' + id + '_classification'))
-                        it.isSamplingEvent = (params.containsKey('eventDescription_' + id + '_isSamplingEvent'))
-
-                        // validate eventDescription
-                        if (!it.validate()) {
-                                errors = true
-                                this.appendErrors(it, flash.errors, 'eventDescription_' + id + '_')
-                        }
-
-                        id++
-                }
+                        }
+                }
+
+                // handle event objects
+                flow.eventTemplates.each() {
+                        def eventTemplate       = it.getValue().template
+                        def templateFields      = eventTemplate.fields
+
+                        // iterate through events
+                        it.getValue().events.each() { eventId ->
+                                // iterate through template fields
+                                templateFields.each() { eventField ->
+                                        flow.events[ eventId ].setFieldValue(
+                                                eventField.name,
+                                                params.get( 'event_' + eventId + '_' + eventField.escapedName() )
+                                        )
+                                }
+
+                                // validate event
+                                if (!flow.events[ eventId ].validate()) {
+                                        errors = true
+                                        this.appendErrors(flow.events[ eventId ], flash.errors, 'event_' + eventId + '_')
+                                }
+
+
+                        }
+                }
+
+                // handle event grouping
+                handleEventGrouping(flow, flash, params)
+
+                println flow.event
 
                 return !errors
@@ -680 +773 @@
 
         /**
-         * re-usable code for handling subject form data in a web flow
-         * @param Map LocalAttributeMap (the flow scope)
-         * @param Map localAttributeMap (the flash scope)
-         * @param Map GrailsParameterMap (the flow parameters = form data)
-         * @returns boolean
-         */
-        def handleSubjects(flow, flash, params) {
-                def names = [:];
-                def errors = false;
-                def id = 0;
-
-                // iterate through subject templates
-                flow.subjectTemplates.each() {
-                        def subjectTemplate = it.getValue().template
-                        def templateFields      = subjectTemplate.fields
-
-                        // iterate through subjects
-                        it.getValue().subjects.each() { subjectId ->
-                                flow.subjects[ subjectId ].name = params.get('subject_' + subjectId + '_name')
-                                flow.subjects[ subjectId ].species = Term.findByName(params.get('subject_' + subjectId + '_species'))
-
-                                // remember name and check for duplicates
-                                if (!names[ flow.subjects[ subjectId ].name ]) {
-                                        names[ flow.subjects[ subjectId ].name ] = [count: 1, first: 'subject_' + subjectId + '_name', firstId: subjectId]
-                                } else {
-                                        // duplicate name found, set error flag
-                                        names[ flow.subjects[ subjectId ].name ]['count']++
-
-                                        // second occurence?
-                                        if (names[ flow.subjects[ subjectId ].name ]['count'] == 2) {
-                                                // yeah, also mention the first
-                                                // occurrence in the error message
-                                                this.appendErrorMap(name: 'The subject name needs to be unique!', flash.errors, 'subject_' + names[ flow.subjects[ subjectId ].name ]['firstId'] + '_')
-                                        }
-
-                                        // add to error map
-                                        this.appendErrorMap([name: 'The subject name needs to be unique!'], flash.errors, 'subject_' + subjectId + '_')
-                                        errors = true
-                                }
-
-                                // iterate through template fields
-                                templateFields.each() { subjectField ->
-                                        flow.subjects[ subjectId ].setFieldValue(
-                                                subjectField.name,
-                                                params.get( 'subject_' + subjectId + '_' + subjectField.escapedName() )
-                                        )
-                                }
-
-                                // validate subject
-                                if (!flow.subjects[ subjectId ].validate()) {
-                                        errors = true
-                                        this.appendErrors(flow.subjects[ subjectId ], flash.errors, 'subject_' + subjectId + '_')
-                                }
-                        }
-                }
-
-                return !errors
-        }
-
-        /**
          * return the object from a map of objects by searching for a name
          * @param String name

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

@@ -270 +270 @@
          */
         def fieldExists(String fieldName) {
-                TemplateFieldType fieldType = template.getFieldType(fieldName)
-
-                // If the field is found, a TemplateFieldType is returned
-                // otherwise null
-                if (fieldType) {
-                    return true
-                } else {
-                    return false
-                }
+                // escape the fieldName for easy matching
+                // (such escaped names are commonly used
+                // in the HTTP forms of this application)
+                def escapedLowerCaseFieldName = fieldName.toLowerCase().replaceAll("([^a-z0-9])","_")
+
+                // check if this domain class has got this property
+                if (this.properties.containsKey(fieldName)) {
+                        // domain class contains this property
+                        return true
+                } else if (template == null) {
+                        // no, and we haven't got a template set either
+                        return false
+                } else {
+                        // the domain class doesn't have this property but
+                        // it has a template defined. Check the template
+                        // fields to see if such a template field exists
+                        TemplateField field = this.template.fields.find { it.name.toLowerCase().replaceAll("([^a-z0-9])","_") == escapedLowerCaseFieldName }
+
+                        // does the template field exist?
+                        if (field == null) {
+                                // no such template field
+                                return false
+                        } else {
+                                // found!
+                                return true
+                        }
+                }
         }
 
@@ -287 +305 @@
          */
         def setFieldValue(String fieldName, value) {
+                // escape the fieldName for easy matching
+                // (such escaped names are commonly used
+                // in the HTTP forms of this application)
+                def escapedLowerCaseFieldName = fieldName.toLowerCase().replaceAll("([^a-z0-9])","_")
+
                 // First, search if there is an entity property with the given name, and if so, set that
                 if (this.properties.containsKey(fieldName)) {
@@ -296 +319 @@
                         // there is a template, check the template fields
                         // Find the target template field, if not found, throw an error
-                        TemplateField field = this.template.fields.find { it.name == fieldName }
+                        TemplateField field = this.template.fields.find { it.name.toLowerCase().replaceAll("([^a-z0-9])","_") == escapedLowerCaseFieldName }
 
                         if (field == null) {
@@ -306 +329 @@
                                 if (field.type == TemplateFieldType.STRINGLIST && value && value.class == String) {
                                         // Kees insensitive pattern matching ;)
-                                        value = field.listEntries.find { it.name ==~ /(?i)($value)/ }
+                                        def escapedLowerCaseValue = value.toLowerCase().replaceAll("([^a-z0-9])","_")
+                                        value = field.listEntries.find {
+                                                it.name.toLowerCase().replaceAll("([^a-z0-9])","_") == escapedLowerCaseValue
+                                        }
                                 }
 

trunk/grails-app/taglib/dbnp/studycapturing/WizardTagLib.groovy

@@ -689 +689 @@
                 def renderType  = attrs.remove('renderType')
                 def entity              = (attrs.get('entity'))
-                println entity
-                println entity.class
-                println entity instanceof TemplateEntity
+                def prependName = (attrs.get('name')) ? attrs.remove('name')+'_' : ''
                 def template    = (entity && entity instanceof TemplateEntity) ? entity.template : null
                 def inputElement= null
@@ -711 +709 @@
                                                 out << "$inputElement"(
                                                         description: it.name,
-                                                        name: it.escapedName(),
+                                                        name: prependName + it.escapedName(),
                                                         value: fieldValue
                                                 )
@@ -720 +718 @@
                                                         out << "$inputElement"(
                                                                 description: it.name,
-                                                                name: it.escapedName(),
+                                                                name: prependName + it.escapedName(),
                                                                 from: it.listEntries,
                                                                 value: fieldValue
@@ -733 +731 @@
                                                 inputElement = (renderType == 'element') ? 'textFieldElement' : 'textField'
                                                 out << "$inputElement"(
-                                                        name: it.escapedName(),
+                                                        name: prependName + it.escapedName(),
                                                         value: fieldValue,
                                                         rel: 'ontology-all-name',
@@ -739 +737 @@
                                                 )
                                                 out << hiddenField(
-                                                        name: it.name + '-concept_id',
+                                                        name: prependName + it.name + '-concept_id',
                                                         value: fieldValue
                                                 )
                                                 out << hiddenField(
-                                                        name: it.escapedName() + '-ontology_id',
+                                                        name: prependName + it.escapedName() + '-ontology_id',
                                                         value: fieldValue
                                                 )
                                                 out << hiddenField(
-                                                        name: it.escapedName() + '-full_id',
+                                                        name: prependName + it.escapedName() + '-full_id',
                                                         value: fieldValue
                                                 )
@@ -768 +766 @@
                                                 out << "$inputElement"(
                                                         description: it.name,
-                                                        name: it.escapedName(),
+                                                        name: prependName + it.escapedName(),
                                                         value: fieldValue,
                                                         rel: 'date'

trunk/grails-app/views/wizard/pages/_events.gsp

@@ -26 +26 @@
         <g:if test="${event?.template}"><wizard:templateElements entity="${event}" /></g:if>
         <g:if test="${event?.template}"><wizard:buttonElement name="add" value="Add" url="[controller:'wizard',action:'pages']" update="[success:'wizardPage',failure:'wizardError']" afterSuccess="onWizardPage()"/></g:if>
+
+<g:if test="${events}">
+        <g:each var="eventTemplate" in="${eventTemplates}">
+                <h1>${eventTemplate.getValue().name} template</h1>
+        <div class="table">
+                <div class="header">
+                        <div class="firstColumn">#</div>
+                        <div class="firstColumn"></div>
+                        <wizard:templateColumnHeaders template="${eventTemplate.getValue().template}" class="column"/>
+                        <g:if test="${eventGroups}"><g:each var="eventGroup" status="g" in="${eventGroups}">
+                        <div class="column">
+                                <g:textField name="eventGroup_${g}_name" value="${eventGroup.name}" />
+                                <wizard:ajaxButton name="deleteEventGroup" src="../images/icons/famfamfam/delete.png" alt="delete this eventgroup" class="famfamfam" value="-" url="[controller:'wizard',action:'pages']" update="[success:'wizardPage',failure:'wizardError']" before="\$(\'input[name=do]\').val(${g});" afterSuccess="onWizardPage()" />
+                        </div>
+                        </g:each></g:if>
+                        <div class="column">
+                                <wizard:ajaxButton name="addEventGroup" src="../images/icons/famfamfam/add.png" alt="add a new eventgroup" class="famfamfam" value="+" url="[controller:'wizard',action:'pages']" update="[success:'wizardPage',failure:'wizardError']" afterSuccess="onWizardPage()" />
+                        </div>
+                </div>
+                <g:each var="eventId" in="${eventTemplate.getValue().events}">
+                        <div class="row">
+                                <div class="firstColumn">${eventId + 1}</div>
+                                <div class="firstColumn">
+                                        <wizard:ajaxButton name="delete" src="../images/icons/famfamfam/delete.png" alt="delete this subject" class="famfamfam" value="-" url="[controller:'wizard',action:'pages']" update="[success:'wizardPage',failure:'wizardError']" before="\$(\'input[name=do]\').val(${eventId});" afterSuccess="onWizardPage()"/>
+                                </div>
+                                <wizard:templateColumns id="${eventId}" entity="${events[ eventId ]}" template="${events[ eventId ].template}" name="event_${eventId}" class="column" />
+                                <g:if test="${eventGroups}"><g:each var="eventGroup" status="j" in="${eventGroups}">
+                                <div class="column">
+                                        <g:if test="${eventGroup.events.find{ it == event} }">
+                                                <input type="checkbox" name="event_${eventId}_group_${j}" checked="checked" />
+                                        </g:if><g:else>
+                                                <input type="checkbox" name="event_${eventId}_group_${j}"/>
+                                        </g:else>
+                                </div>
+                                </g:each></g:if>
+                                <div class="column"></div>
+                        </div>
+                </g:each>
+        </div>
+        <div class="sliderContainer">
+                <div class="slider"></div>
+        </div>
+        </g:each>
+</g:if>
+
 <% /*
-<g:if test="${events}">
+        ----- START ----- <br/>
         <g:each var="event" status="i" in="${events}">
         <div class="table">
@@ -51 +96 @@
                         </div>
                         <div class="column">${event.template}</div>
-                        <wizard:templateColumns id="${i}" entity="${event}" template="${event.template}" name="event${i}" class="column" />
+                        <wizard:templateColumns id="${i}" entity="${event}" template="${event.template}" name="event_${i}" class="column" />
                         <g:if test="${eventGroups}"><g:each var="eventGroup" status="j" in="${eventGroups}">
                         <div class="column">
@@ -64 +109 @@
                 </div>
         </div>
+                <div class="sliderContainer">
+                        <div class="slider"></div>
+                </div>
+
         </g:each>
-*/ %>
-<% /*
+
         <div class="table">
                 <div class="header">