source: trunk/grails-app/controllers/dbnp/studycapturing/WizardController.groovy @ 383

Last change on this file since 383 was 383, checked in by duh, 9 years ago
  • initial event template
  • Property svn:keywords set to Date Author Rev
File size: 18.8 KB
Line 
1package dbnp.studycapturing
2
3import dbnp.data.*
4
5/**
6 * Wizard Controler
7 *
8 * The wizard controller handles the handeling of pages and data flow
9 * through the study capturing wizard.
10 *
11 * TODO: refactor the 'handle*' methods to work as subflows instead
12 *               of methods outside of the flow
13 *
14 * @author Jeroen Wesbeek
15 * @since 20100107
16 * @package studycapturing
17 *
18 * Revision information:
19 * $Rev: 383 $
20 * $Author: duh $
21 * $Date: 2010-04-26 16:36:49 +0000 (ma, 26 apr 2010) $
22 */
23class WizardController {
24        /**
25         * index method, redirect to the webflow
26         * @void
27         */
28        def index = {
29                /**
30                 * Do you believe it in your head?
31                 * I can go with the flow
32                 * Don't say it doesn't matter (with the flow) matter anymore
33                 * I can go with the flow (I can go)
34                 * Do you believe it in your head?
35                 */
36                redirect(action: 'pages')
37        }
38
39        /**
40         * WebFlow definition
41         * @see http://grails.org/WebFlow
42         * @void
43         */
44        def pagesFlow = {
45                // start the flow
46                onStart {
47                        // define flow variables
48                        flow.page = 0
49                        flow.pages = [
50                                //[title: 'Templates'],                 // templates
51                                [title: 'Start'],                               // load or create a study
52                                [title: 'Study'],                               // study
53                                [title: 'Subjects'],                    // subjects
54                                [title: 'Events'],                              // events and event grouping
55                                [title: 'Confirmation'],                // confirmation page
56                                [title: 'Done']                                 // finish page
57                        ]
58                }
59
60                // render the main wizard page which immediately
61                // triggers the 'next' action (hence, the main
62                // page dynamically renders the study template
63                // and makes the flow jump to the study logic)
64                mainPage {
65                        render(view: "/wizard/index")
66                        onRender {
67                                flow.page = 1
68                        }
69                        on("next").to "start"
70                }
71
72                // create or modify a study
73                start {
74                        render(view: "_start")
75                        onRender {
76                                flow.page = 1
77                        }
78                        on("next").to "study"
79                        on("modify").to "modify"
80                }
81
82                // load a study to modify
83                modify {
84                        render(view: "_modify")
85                        onRender {
86                                flow.page = 1
87                                flash.cancel = true
88                        }
89                        on("cancel") {
90                                flow.study = null
91                        }.to "start"
92                        on("next") {
93                                // TODO: loading a study is not yet implemented
94                                //       create a error stating this feature is
95                                //       not yet implemented
96                                flash.errors = [:]
97                                this.appendErrorMap(
98                                        ['study': 'Loading a study and modifying it has not yet been implemented. Please press \'cancel\' to go back to the initial page...'],
99                                        flash.errors
100                                )
101                        }.to "modify"
102                }
103
104                // render and handle the study page
105                // TODO: make sure both template as well as logic will
106                //       handle Study templates as well!!!
107                study {
108                        render(view: "_study")
109                        onRender {
110                                flow.page = 2
111                        }
112                        on("refresh") {
113                                flash.values = params
114
115                                // handle study data
116                                this.handleStudy(flow, flash, params)
117
118                                // remove errors as we don't want any warnings now
119                                flash.errors = [:]                             
120                        }.to "study"
121                        on("switchTemplate") {
122                                flash.values = params
123
124                                // handle study data
125                                this.handleStudy(flow, flash, params)
126
127                                // remove errors as we don't want any warnings now
128                                flash.errors = [:]
129                        }.to "study"
130                        on("previous") {
131                                flash.errors = [:]
132
133                                // handle the study
134                                this.handleStudy(flow, flash, params)
135
136                                // reset errors
137                                flash.errors = [:]
138
139                                success()
140                        }.to "start"
141                        on("next") {
142                                flash.errors = [:]
143
144                                if (this.handleStudy(flow, flash, params)) {
145                                        success()
146                                } else {
147                                        error()
148                                }
149                        }.to "subjects"
150                }
151
152                // render and handle subjects page
153                subjects {
154                        render(view: "_subjects")
155                        onRender {
156                                flow.page = 3
157
158                                if (!flow.subjects) {
159                                        flow.subjects = []
160                                        flow.subjectTemplates = [:]
161                                }
162                        }
163                        on("refresh") {
164                                flash.values = params
165                        }.to "subjects"
166                        on("add") {
167                                flash.values = params
168                                def speciesTerm = Term.findByName(params.species);
169                                def subjectTemplateName = params.get('template');
170                                def subjectTemplate = Template.findByName(subjectTemplateName);
171
172                                // add this subject template to the subject template array
173                                if (!flow.subjectTemplates[ subjectTemplateName ]) {
174                                        flow.subjectTemplates[ subjectTemplateName ] = [
175                                                name: subjectTemplateName,
176                                                template: subjectTemplate,
177                                                subjects: []
178                                        ]
179                                }
180
181                                // add x subjects of species y
182                                (params.addNumber as int).times {
183                                        def increment = flow.subjects.size()
184                                        def subject = new Subject(
185                                                name: 'Subject ' + (increment + 1),
186                                                species: speciesTerm,
187                                                template: subjectTemplate
188                                        )
189
190                                        // instantiate a new Subject
191                                        flow.subjects[ increment ] = subject
192
193                                        // and remember the subject id with the template
194                                        def subjectsSize = flow.subjectTemplates[ subjectTemplateName ]['subjects'].size()
195                                        flow.subjectTemplates[ subjectTemplateName ]['subjects'][ subjectsSize ] = increment
196                                }
197                        }.to "subjects"
198                        on("next") {
199                                flash.errors = [:]
200
201                                // check if we have at least one subject
202                                // and check form data
203                                if (flow.subjects.size() < 1) {
204                                        // append error map
205                                        this.appendErrorMap(['subjects': 'You need at least to create one subject for your study'], flash.errors)
206                                        error()
207                                } else if (!this.handleSubjects(flow, flash, params)) {
208                                        error()
209                                } else {
210                                        success()
211                                }
212                        }.to "events"
213                        on("delete") {
214                                flash.errors = [:]
215                                def delete = params.get('do') as int;
216
217                                // remove subject
218                                if (flow.subjects[ delete ] && flow.subjects[ delete ] instanceof Subject) {
219                                        flow.subjectTemplates.each() { templateName, templateData ->
220                                                templateData.subjects.remove(delete)
221                                        }
222
223                                        flow.subjects.remove( delete )
224                                }
225                        }.to "subjects"
226                        on("previous") {
227                                flash.errors = [:]
228
229                                // handle form data
230                                if (!this.handleSubjects(flow, flash, params)) {
231                                        error()
232                                } else {
233                                        success()
234                                }
235                        }.to "study"
236                }
237
238                // render events page
239                events {
240                        render(view: "_events")
241                        onRender {
242                                flow.page = 4
243
244                                if (!flow.events) {
245                                        flow.events = []
246                                }
247
248                                if (!flow.eventGroups) {
249                                        flow.eventGroups = []
250                                        flow.eventGroups[0] = new EventGroup(name: 'Group 1')   // 1 group by default
251                                }
252println flow.events
253                        }
254                        on("add") {
255                                def startTime   = (params.get('startTime')) ? params.startTime = new Date().parse("d/M/yyyy HH:mm", params.get('startTime').toString()) : null
256                                def endTime             = (params.get('endTime')) ? new Date().parse("d/M/yyyy HH:mm", params.get('endTime').toString()) : null
257                                def template    = params.get('template')
258
259                                // handle template
260                                if (template instanceof String && template.size() > 0) {
261                                        template = Template.findByName(template)
262                                } else if (!template instanceof Template) {
263                                        template = null
264                                }
265
266                                // handle data
267                                if (template && startTime && endTime) {
268                                        // add an event instance
269                                        def event = new Event(
270                                                template        : template,
271                                                startTime       : startTime,
272                                                endTime         : endTime
273                                        )
274
275                                        // validate event
276                                        if (event.validate()) {
277                                                // add event to event list
278                                                flow.events[ flow.events.size() ] = event
279                                                success()
280                                        } else {
281                                                // validation failed, feedback errors
282                                                flash.errors = [:]
283                                                flash.values = params
284                                                this.appendErrors(event, flash.errors)
285                                                error()
286                                        }
287                                } else {
288                                        // validation failed, feedback errors
289                                        flash.errors    = [:]
290                                        flash.values    = params
291
292                                        if (!template)  this.appendErrorMap(['template': 'You need to select an event template'], flash.errors)
293                                        if (!startTime) this.appendErrorMap(['startTime': 'You need to define the start time of your study event'], flash.errors)
294                                        if (!endTime)   this.appendErrorMap(['endTime': 'You need to define the end time of your study event'], flash.errors)
295                                        error()
296                                }
297                        }.to "events"
298                        on("deleteEvent") {
299                                flash.values = params
300                                def delete = params.get('do') as int;
301
302                                // handle event groupings
303                                this.handleEventGrouping(flow, flash, params)
304
305                                // remove event
306                                if (flow.events[ delete ] && flow.events[ delete ] instanceof Event) {
307                                        flow.events.remove(delete)
308                                }
309                        }.to "events"
310                        on("addEventGroup") {
311                                flash.values = params
312                               
313                                // handle event groupings
314                                this.handleEventGrouping(flow, flash, params)
315
316                                def increment = flow.eventGroups.size()
317                                def groupName = "Group " + (increment + 1)
318
319                                // check if group name exists
320                                def nameExists = true
321                                def u = 0
322
323                                // make sure a unique name is generated
324                                while (nameExists) {
325                                        u++
326                                        def count = 0
327                                       
328                                        flow.eventGroups.each() {
329                                                if (it.name == groupName) {
330                                                        groupName = "Group " + (increment + 1) + "," + u
331                                                } else {
332                                                        count++
333                                                }
334                                        }
335
336                                        nameExists = !(count == flow.eventGroups.size())
337                                }
338
339                                flow.eventGroups[increment] = new EventGroup(name: groupName)
340                        }.to "events"
341                        on("deleteEventGroup") {
342                                flash.values = params
343                               
344                                def delete = params.get('do') as int;
345
346                                // handle event groupings
347                                this.handleEventGrouping(flow, flash, params)
348
349                                // remove the group with this specific id
350                                if (flow.eventGroups[delete] && flow.eventGroups[delete] instanceof EventGroup) {
351                                        // remove this eventGroup
352                                        flow.eventGroups.remove(delete)
353                                }
354                        }.to "events"
355                        on("previous") {
356                                // handle event groupings
357                                this.handleEventGrouping(flow, flash, params)
358                        }.to "subjects"
359                        on("next") {
360                                flash.values = params
361                                flash.errors = [:]
362
363                                // handle event groupings
364                                this.handleEventGrouping(flow, flash, params)
365
366                                // check if we have at least one subject
367                                // and check form data
368                                if (flow.events.size() < 1) {
369                                        // append error map
370                                        flash.values = params
371                                        this.appendErrorMap(['events': 'You need at least to create one event for your study'], flash.errors)
372                                        error()
373                                }
374                        }.to "confirm"
375                }
376
377                confirm {
378                        render(view: "_confirmation")
379                        onRender {
380                                flow.page = 5
381                        }
382                        on("toStudy").to "study"
383                        on("toSubjects").to "subjects"
384                        on("toEvents").to "events"
385                        on("previous").to "events"
386                        on("next").to "save"
387                }
388
389                // store all study data
390                save {
391                        action {
392                                println "saving..."
393                                flash.errors = [:]
394
395                                // start transaction
396                                def transaction = sessionFactory.getCurrentSession().beginTransaction()
397
398                                // persist data to the database
399                                try {
400                                        // save EventDescriptions
401                                        flow.eventDescriptions.each() {
402                                                if (!it.save(flush:true)) {
403                                                        this.appendErrors(it, flash.errors)
404                                                        throw new Exception('error saving eventDescription')
405                                                }
406                                                println "saved eventdescription "+it
407                                        }
408
409                                        // TODO: eventDescriptions that are not linked to an event are currently
410                                        //               stored but end up in a black hole. We should either decide to
411                                        //               NOT store these eventDescriptions, or add "hasmany eventDescriptions"
412                                        //               to Study domain class
413
414                                        // save events
415                                        flow.events.each() {
416                                                if (!it.save(flush:true)) {
417                                                        this.appendErrors(it, flash.errors)
418                                                        throw new Exception('error saving event')
419                                                }
420                                                println "saved event "+it
421
422                                                // add to study
423                                                if (it instanceof SamplingEvent) {
424                                                        flow.study.addToSamplingEvents(it)
425                                                } else {
426                                                        flow.study.addToEvents(it)
427                                                }
428                                        }
429
430                                        // save eventGroups
431                                        flow.eventGroups.each() {
432                                                if (!it.save(flush:true)) {
433                                                        this.appendErrors(it, flash.errors)
434                                                        throw new Exception('error saving eventGroup')
435                                                }
436                                                println "saved eventGroup "+it
437
438                                                // add to study
439                                                flow.study.addToEventGroups(it)
440                                        }
441                                       
442                                        // save subjects
443                                        flow.subjects.each() {
444                                                if (!it.save(flush:true)) {
445                                                        this.appendErrors(it, flash.errors)
446                                                        throw new Exception('error saving subject')
447                                                }
448                                                println "saved subject "+it
449
450                                                // add this subject to the study
451                                                flow.study.addToSubjects(it)
452                                        }
453
454                                        // save study
455                                        if (!flow.study.save(flush:true)) {
456                                                this.appendErrors(flow.study, flash.errors)
457                                                throw new Exception('error saving study')
458                                        }
459                                        println "saved study "+flow.study+" (id: "+flow.study.id+")"
460
461                                        // commit transaction
462                                        println "commit"
463                                        transaction.commit()
464                                        success()
465                                } catch (Exception e) {
466                                        // rollback
467                                        this.appendErrorMap(['exception': e.toString() + ', see log for stacktrace' ], flash.errors)
468
469                                        // stacktrace in flash scope
470                                        flash.debug = e.getStackTrace()
471
472                                        println "rollback"
473                                        transaction.rollback()
474                                        error()
475                                }
476                        }
477                        on("error").to "error"
478                        on(Exception).to "error"
479                        on("success").to "done"
480                }
481
482                // error storing data
483                error {
484                        render(view: "_error")
485                        onRender {
486                                flow.page = 6
487                        }
488                        on("next").to "save"
489                        on("previous").to "events"
490                }
491
492                // render page three
493                done {
494                        render(view: "_done")
495                        onRender {
496                                flow.page = 7
497                        }
498                        on("previous") {
499                                // TODO
500                        }.to "confirm"
501                }
502        }
503
504        /**
505         * re-usable code for handling study form data in a web flow
506         * @param Map LocalAttributeMap (the flow scope)
507         * @param Map localAttributeMap (the flash scope)
508         * @param Map GrailsParameterMap (the flow parameters = form data)
509         * @returns boolean
510         */
511        def handleStudy(flow, flash, params) {
512                // create study instance if we have none
513                if (!flow.study) flow.study = new Study();
514
515                // create date instance from date string?
516                // @see WizardTagLibrary::dateElement{...}
517                if (params.get('startDate')) {
518                        params.startDate = new Date().parse("d/M/yyyy", params.get('startDate').toString())
519                } else {
520                        params.remove('startDate')
521                }
522
523                // if a template is selected, get template instance
524                def template = params.remove('template')
525                if (template instanceof String && template.size() > 0) {
526                        params.template = Template.findByName(template)
527                } else if (template instanceof Template) {
528                        params.template = template
529                }
530
531                // update study instance with parameters
532                params.each() { key, value ->
533                        if (flow.study.hasProperty(key)) {
534                                flow.study.setProperty(key, value);
535                        }
536                }
537
538                // walk through template fields
539                if (params.template) {
540                        params.template.fields.each() { field ->
541                                flow.study.setFieldValue(field.name, params.get(field.escapedName()))
542                        }
543                }
544
545                // validate study
546                if (flow.study.validate()) {
547                        return true
548                } else {
549                        // validation failed, feedback errors
550                        flash.errors = [:]
551                        this.appendErrors(flow.study, flash.errors)
552                        return false
553                }
554        }
555
556        /**
557         * re-usable code for handling eventDescription form data in a web flow
558         * @param Map LocalAttributeMap (the flow scope)
559         * @param Map localAttributeMap (the flash scope)
560         * @param Map GrailsParameterMap (the flow parameters = form data)
561         * @returns boolean
562         */
563        def handleEventDescriptions(flow, flash, params) {
564                def names = [:]
565                def errors = false
566                def id = 0
567
568                flow.eventDescriptions.each() {
569                        it.name = params.get('eventDescription_' + id + '_name')
570                        it.description = params.get('eventDescription_' + id + '_description')
571                        it.protocol = Protocol.findByName(params.get('eventDescription_' + id + '_protocol'))
572                        //it.classification = Term.findByName(params.get('eventDescription_' + id + '_classification'))
573                        it.isSamplingEvent = (params.containsKey('eventDescription_' + id + '_isSamplingEvent'))
574
575                        // validate eventDescription
576                        if (!it.validate()) {
577                                errors = true
578                                this.appendErrors(it, flash.errors, 'eventDescription_' + id + '_')
579                        }
580
581                        id++
582                }
583
584                return !errors
585        }
586
587        /**
588         * re-usable code for handling event grouping in a web flow
589         * @param Map LocalAttributeMap (the flow scope)
590         * @param Map localAttributeMap (the flash scope)
591         * @param Map GrailsParameterMap (the flow parameters = form data)
592         * @returns boolean
593         */
594        def handleEventGrouping(flow, flash, params) {
595                // walk through eventGroups
596                def g = 0
597                flow.eventGroups.each() {
598                        def e = 0
599                        def eventGroup = it
600
601                        // reset events
602                        eventGroup.events = new HashSet()
603
604                        // walk through events
605                        flow.events.each() {
606                                if (params.get('event_' + e + '_group_' + g) == 'on') {
607                                        eventGroup.addToEvents(it)
608                                }
609                                e++
610                        }
611                        g++
612                }
613        }
614
615        /**
616         * re-usable code for handling subject form data in a web flow
617         * @param Map LocalAttributeMap (the flow scope)
618         * @param Map localAttributeMap (the flash scope)
619         * @param Map GrailsParameterMap (the flow parameters = form data)
620         * @returns boolean
621         */
622        def handleSubjects(flow, flash, params) {
623                def names = [:];
624                def errors = false;
625                def id = 0;
626
627                // iterate through subject templates
628                flow.subjectTemplates.each() {
629                        def subjectTemplate = it.getValue().template
630                        def templateFields      = subjectTemplate.fields
631
632                        // iterate through subjects
633                        it.getValue().subjects.each() { subjectId ->
634                                flow.subjects[ subjectId ].name = params.get('subject_' + subjectId + '_name')
635                                flow.subjects[ subjectId ].species = Term.findByName(params.get('subject_' + subjectId + '_species'))
636
637                                // remember name and check for duplicates
638                                if (!names[ flow.subjects[ subjectId ].name ]) {
639                                        names[ flow.subjects[ subjectId ].name ] = [count: 1, first: 'subject_' + subjectId + '_name', firstId: subjectId]
640                                } else {
641                                        // duplicate name found, set error flag
642                                        names[ flow.subjects[ subjectId ].name ]['count']++
643
644                                        // second occurence?
645                                        if (names[ flow.subjects[ subjectId ].name ]['count'] == 2) {
646                                                // yeah, also mention the first
647                                                // occurrence in the error message
648                                                this.appendErrorMap(name: 'The subject name needs to be unique!', flash.errors, 'subject_' + names[ flow.subjects[ subjectId ].name ]['firstId'] + '_')
649                                        }
650
651                                        // add to error map
652                                        this.appendErrorMap([name: 'The subject name needs to be unique!'], flash.errors, 'subject_' + subjectId + '_')
653                                        errors = true
654                                }
655
656                                // iterate through template fields
657                                templateFields.each() { subjectField ->
658                                        flow.subjects[ subjectId ].setFieldValue(
659                                                subjectField.name,
660                                                params.get( 'subject_' + subjectId + '_' + subjectField.escapedName() )
661                                        )
662                                }
663
664                                // validate subject
665                                if (!flow.subjects[ subjectId ].validate()) {
666                                        errors = true
667                                        this.appendErrors(flow.subjects[ subjectId ], flash.errors, 'subject_' + subjectId + '_')
668                                }
669                        }
670                }
671
672                return !errors
673        }
674
675        /**
676         * return the object from a map of objects by searching for a name
677         * @param String name
678         * @param Map map of objects
679         * @return Object
680         */
681        def getObjectByName(name, map) {
682                def result = null
683                map.each() {
684                        if (it.name == name) {
685                                result = it
686                        }
687                }
688
689                return result
690        }
691
692        /**
693         * transform domain class validation errors into a human readable
694         * linked hash map
695         * @param object validated domain class
696         * @returns object  linkedHashMap
697         */
698        def getHumanReadableErrors(object) {
699                def errors = [:]
700                object.errors.getAllErrors().each() {
701                        errors[it.getArguments()[0]] = it.getDefaultMessage()
702                }
703
704                return errors
705        }
706
707        /**
708         * append errors of a particular object to a map
709         * @param object
710         * @param map linkedHashMap
711         * @void
712         */
713        def appendErrors(object, map) {
714                this.appendErrorMap(this.getHumanReadableErrors(object), map)
715        }
716
717        def appendErrors(object, map, prepend) {
718                this.appendErrorMap(this.getHumanReadableErrors(object), map, prepend)
719        }
720
721        /**
722         * append errors of one map to another map
723         * @param map linkedHashMap
724         * @param map linkedHashMap
725         * @void
726         */
727        def appendErrorMap(map, mapToExtend) {
728                map.each() {key, value ->
729                        mapToExtend[key] = ['key': key, 'value': value, 'dynamic': false]
730                }
731        }
732
733        def appendErrorMap(map, mapToExtend, prepend) {
734                map.each() {key, value ->
735                        mapToExtend[prepend + key] = ['key': key, 'value': value, 'dynamic': true]
736                }
737        }
738}
Note: See TracBrowser for help on using the repository browser.