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

Last change on this file since 535 was 535, checked in by duh, 11 years ago
  • removed obsolete templates
  • added redirect functionality
  • Property svn:keywords set to Date Author Rev
File size: 29.5 KB
Line 
1package dbnp.studycapturing
2
3import dbnp.data.*
4
5// Grails convertors is imported in order to create JSON objects
6import grails.converters.*
7
8
9/**
10 * Wizard Controler
11 *
12 * The wizard controller handles the handeling of pages and data flow
13 * through the study capturing wizard.
14 *
15 * @author Jeroen Wesbeek
16 * @since 20100107
17 * @package studycapturing
18 *
19 * Revision information:
20 * $Rev: 535 $
21 * $Author: duh $
22 * $Date: 2010-06-04 15:06:07 +0000 (vr, 04 jun 2010) $
23 */
24class WizardController {
25        /**
26         * index method, redirect to the webflow
27         * @void
28         */
29        def index = {
30                /**
31                 * Do you believe it in your head?
32                 * I can go with the flow
33                 * Don't say it doesn't matter (with the flow) matter anymore
34                 * I can go with the flow (I can go)
35                 * Do you believe it in your head?
36                 */
37                redirect(action: 'pages')
38        }
39
40        /**
41         * WebFlow definition
42         * @see http://grails.org/WebFlow
43         * @void
44         */
45        def pagesFlow = {
46                // start the flow
47                onStart {
48                        // define flow variables
49                        flow.page = 0
50                        flow.pages = [
51                                //[title: 'Templates'],                 // templates
52                                [title: 'Start'],                               // load or create a study
53                                [title: 'Study'],                               // study
54                                [title: 'Subjects'],                    // subjects
55                                [title: 'Events'],                              // events and event grouping
56                                [title: 'Groups'],                              // groups
57                                [title: 'Samples'],                             // samples
58                                [title: 'Confirmation'],                // confirmation page
59                                [title: 'Done']                                 // finish page
60                        ]
61                        success()
62                }
63
64                // render the main wizard page which immediately
65                // triggers the 'next' action (hence, the main
66                // page dynamically renders the study template
67                // and makes the flow jump to the study logic)
68                mainPage {
69                        render(view: "/wizard/index")
70                        onRender {
71                                flow.page = 1
72                                success()
73                        }
74                        on("next").to "start"
75                }
76
77                // create or modify a study
78                start {
79                        render(view: "_start")
80                        onRender {
81                                flow.page = 1
82                                success()
83                        }
84                        on("next") {
85                                // clean the flow scope
86                                flow.remove('study')
87                                flow.remove('subjects')
88                                flow.remove('subjectTemplates')
89                                flow.remove('event')
90                                flow.remove('events')
91                                flow.remove('eventGroups')
92                                flow.remove('eventTemplates')
93
94                                // set 'quicksave' variable
95                                flow.quickSave = false
96                        }.to "study"
97                        on("modify").to "modify"
98                        on("import").to "redirectToImport"
99                }
100
101                // redirect to the import wizard
102                redirectToImport {
103                        render(view: "_redirect")
104                        onRender {
105                                flash.uri = "/importer/index"
106                        }
107                        on("next").to "start"
108                }
109
110                // load a study to modify
111                modify {
112                        render(view: "_modify")
113                        onRender {
114                                flow.page = 1
115                                flash.cancel = true
116                                success()
117                        }
118                        on("cancel") {
119                                flow.study = null
120
121                                success()
122                        }.to "start"
123                        on("next") {
124                                // load study
125                                try {
126                                        // load study
127                                        flow.study = Study.findByTitle(params.study)
128
129                                        // recreate subjects
130                                        flow.subjects = [:]
131                                        flow.subjectTemplates = [:]
132                                        flow.study.subjects.each() { subject ->
133                                                def subjectIncrement = flow.subjects.size()
134                                                flow.subjects[ subjectIncrement ] = subject
135
136                                                // add subject template?
137                                                if (!flow.subjectTemplates[ subject.template.name ]) {
138                                                        flow.subjectTemplates[ subject.template.name ] = [
139                                                                name: subject.template.name,
140                                                                template: subject.template,
141                                                                subjects: [:]
142                                                        ]
143                                                }
144
145                                                // reference subject in template
146                                                flow.subjectTemplates[ subject.template.name ].subjects[ flow.subjectTemplates[ subject.template.name ].subjects.size() ] = subjectIncrement
147                                        }
148
149                                        // recreate events
150                                        flow.events = []
151                                        flow.eventGroups = []
152                                        flow.eventTemplates     = [:]
153                                        flow.study.events.each() { event ->
154                                                def eventIncrement = flow.events.size()
155                                                flow.events[ eventIncrement ] = event
156
157                                                // add event template?
158                                                if (!flow.eventTemplates[ event.template.name ]) {
159                                                        flow.eventTemplates[ event.template.name ] = [
160                                                                name: event.template.name,
161                                                                template: event.template,
162                                                                events: new ArrayList()
163                                                        ]
164                                                }
165
166                                                // reference event in template
167                                                flow.eventTemplates[ event.template.name ].events[ flow.eventTemplates[ event.template.name ].events.size() ] = eventIncrement
168
169                                                // set dummy event
170                                                flow.event = event
171                                        }
172
173                                        // recreate sample events
174                                        flow.study.samplingEvents.each() { event ->
175                                                def eventIncrement = flow.events.size()
176                                                flow.events[ eventIncrement ] = event
177
178                                                // add event template?
179                                                if (!flow.eventTemplates[ event.template.name ]) {
180                                                        flow.eventTemplates[ event.template.name ] = [
181                                                                name: event.template.name,
182                                                                template: event.template,
183                                                                events: new ArrayList()
184                                                        ]
185                                                }
186
187                                                // reference event in template
188                                                flow.eventTemplates[ event.template.name ].events[ flow.eventTemplates[ event.template.name ].events.size() ] = eventIncrement
189
190                                                // set dummy event
191                                                flow.event = event
192                                        }
193
194                                        // recreate eventGroups
195                                        flow.study.eventGroups.each() { eventGroup ->
196                                                flow.eventGroups[ flow.eventGroups.size() ] = eventGroup
197                                        }
198
199                                        // set 'quicksave' variable
200                                        flow.quickSave = true
201
202                                        success()
203                                } catch (Exception e) {
204                                        // rollback
205                                        this.appendErrorMap(['exception': e.toString() + ', see log for stacktrace' ], flash.errors)
206
207                                        error()
208                                }
209                        }.to "study"
210                }
211
212                // render and handle the study page
213                study {
214                        render(view: "_study")
215                        onRender {
216                                flow.page = 2
217                                success()
218                        }
219                        on("refresh") {
220                                flash.values = params
221
222                                // handle study data
223                                this.handleStudy(flow, flash, params)
224
225                                // remove errors as we don't want any warnings now
226                                flash.errors = [:]
227
228                                success()
229                        }.to "study"
230                        on("switchTemplate") {
231                                flash.values = params
232
233                                // handle study data
234                                this.handleStudy(flow, flash, params)
235
236                                // remove errors as we don't want any warnings now
237                                flash.errors = [:]
238
239                                success()
240                        }.to "study"
241                        on("previous") {
242                                flash.errors = [:]
243
244                                // handle the study
245                                this.handleStudy(flow, flash, params)
246
247                                // reset errors
248                                flash.errors = [:]
249
250                                success()
251                        }.to "start"
252                        on("next") {
253                                flash.errors = [:]
254
255                                if (this.handleStudy(flow, flash, params)) {
256                                        success()
257                                } else {
258                                        error()
259                                }
260                        }.to "subjects"
261                        on("quickSave") {
262                                flash.errors = [:]
263
264                                if (this.handleStudy(flow, flash, params)) {
265                                        success()
266                                } else {
267                                        error()
268                                }
269                        }.to "waitForSave"
270                }
271
272                // render and handle subjects page
273                subjects {
274                        render(view: "_subjects")
275                        onRender {
276                                flow.page = 3
277
278                                if (!flow.subjects) {
279                                        flow.subjects = [:]
280                                        flow.subjectTemplates = [:]
281                                }
282
283                                success()
284                        }
285                        on("refresh") {
286                                flash.values = params
287                                success()
288                        }.to "subjects"
289                        on("add") {
290                                // handle subjects
291                                this.handleSubjects(flow, flash, params)
292
293                                flash.errors = [:]
294                                flash.values = params
295                                def speciesTerm = Term.findByName(params.species);
296                                def subjectTemplateName = params.get('template');
297                                def subjectTemplate = Template.findByName(subjectTemplateName);
298
299                                // add this subject template to the subject template array
300                                if (!flow.subjectTemplates[ subjectTemplateName ]) {
301                                        flow.subjectTemplates[ subjectTemplateName ] = [
302                                                name: subjectTemplateName,
303                                                template: subjectTemplate,
304                                                subjects: [:]
305                                        ]
306                                }
307
308                                // add x subjects of species y
309                                (params.addNumber as int).times {
310                                        def increment = (flow.subjects.size()) ? (flow.subjects.keySet().max() + 1) : 0
311                                        def subject = new Subject(
312                                                name: 'Subject ' + (increment + 1),
313                                                species: speciesTerm,
314                                                template: subjectTemplate
315                                        )
316
317                                        // instantiate a new Subject
318                                        flow.subjects[ increment ] = subject
319
320                                        // and remember the subject id with the template
321                                        def subjectsSize = (flow.subjectTemplates[ subjectTemplateName ].subjects.size()) ? (flow.subjectTemplates[ subjectTemplateName ].subjects.keySet().max() + 1) : 0
322                                        flow.subjectTemplates[ subjectTemplateName ].subjects[ subjectsSize ] = increment
323                                }
324
325                                success()
326                        }.to "subjects"
327                        on("delete") {
328                                // handle subjects
329                                this.handleSubjects(flow, flash, params)
330
331                                flash.errors = [:]
332                                def delete = params.get('do') as int;
333
334                                // remove subject
335                                if (flow.subjects[ delete ] && flow.subjects[ delete ] instanceof Subject) {
336                                        // remove subject from templates
337                                        flow.subjectTemplates.each() { templateName, templateData ->
338                                                templateData.subjects.remove( delete )
339                                        }
340
341                                        // remove subject altogether
342                                        flow.subjects.remove( delete )
343                                }
344                        }.to "subjects"
345                        on("previous") {
346                                flash.errors = [:]
347
348                                // handle form data
349                                if (!this.handleSubjects(flow, flash, params)) {
350                                        error()
351                                } else {
352                                        success()
353                                }
354                        }.to "study"
355                        on("next") {
356                                flash.errors = [:]
357
358                                // check if we have at least one subject
359                                // and check form data
360                                if (flow.subjects.size() < 1) {
361                                        // append error map
362                                        this.appendErrorMap(['subjects': 'You need at least to create one subject for your study'], flash.errors)
363                                        error()
364                                } else if (!this.handleSubjects(flow, flash, params)) {
365                                        error()
366                                } else {
367                                        success()
368                                }
369                        }.to "events"
370                        on("quickSave") {                               
371                                flash.errors = [:]
372
373                                // check if we have at least one subject
374                                // and check form data
375                                if (flow.subjects.size() < 1) {
376                                        // append error map
377                                        this.appendErrorMap(['subjects': 'You need at least to create one subject for your study'], flash.errors)
378                                        error()
379                                } else if (!this.handleSubjects(flow, flash, params)) {
380                                        error()
381                                } else {
382                                        success()
383                                }
384                        }.to "waitForSave"
385                }
386
387                // render events page
388                events {
389                        render(view: "_events")
390                        onRender {
391                                flow.page = 4
392
393                                if (!flow.event) {
394                                        flow.event                      = new Event()
395                                        flow.events                     = []
396                                        flow.eventGroups        = []
397                                        flow.eventGroups[0]     = new EventGroup(name: 'Group 1')       // 1 group by default
398                                        flow.eventTemplates     = [:]
399                                } else if (!flash.values) {
400                                        // set flash.values.templateType based on the event instance
401                                        flash.values = [:]
402                                        flash.values.templateType = (flow.event instanceof Event) ? 'event' : 'sample'
403                                }
404                                success()
405                        }
406                        on("switchTemplate") {
407                                flash.values = params
408
409                                // handle study data
410                                this.handleEvents(flow, flash, params)
411
412                                // remove errors as we don't want any warnings now
413                                flash.errors = [:]
414                        }.to "events"
415                        on("add") {
416                                flash.values                    = params
417                                def eventTemplateName   = (params.get('eventType') == 'event') ? params.get('eventTemplate') : params.get('sampleTemplate')
418                                def eventTemplate               = Template.findByName(eventTemplateName)
419
420                                // handle study data
421                                this.handleEvents(flow, flash, params)
422
423                                // validate event object
424                                if (flow.event.validate()) {
425                                        // add this event template to the event template array
426                                        if (!flow.eventTemplates[ eventTemplateName ]) {
427                                                flow.eventTemplates[ eventTemplateName ] = [
428                                                        name: eventTemplateName,
429                                                        template: eventTemplate,
430                                                        events: []
431                                                ]
432                                        }
433
434                                        // it validated! Duplicate the event object...
435                                        def newEvent    = flow.event
436                                        def increment   = flow.events.size()
437
438                                        // ...store it in the events map in the flow scope...
439                                        flow.events[ increment ] = newEvent
440
441                                        // ...and 'reset' the event object in the flow scope
442                                        flow.event = new Event(template: newEvent.template)
443                                       
444                                        // remember the event id with the template
445                                        def eventSize = flow.eventTemplates[ eventTemplateName ]['events'].size()
446                                        flow.eventTemplates[ eventTemplateName ]['events'][ eventSize ] = increment
447
448                                        success()
449                                } else {
450                                        // it does not validate, show error feedback
451                                        flash.errors = [:]
452                                        this.appendErrors(flow.event, flash.errors)
453                                        error()
454                                }
455                        }.to "events"
456                        on("deleteEvent") {
457                                flash.values = params
458                                def delete = params.get('do') as int;
459
460                                // handle event groupings
461                                this.handleEventGrouping(flow, flash, params)
462
463                                // remove event
464                                if (flow.events[ delete ] && flow.events[ delete ] instanceof Event) {
465                                        flow.events.remove(delete)
466                                }
467
468                                success()
469                        }.to "events"
470                        on("addEventGroup") {
471                                flash.values = params
472                               
473                                // handle study data
474                                this.handleEvents(flow, flash, params)
475
476                                // handle event groupings
477                                this.handleEventGrouping(flow, flash, params)
478
479                                def increment = flow.eventGroups.size()
480                                def groupName = "Group " + (increment + 1)
481
482                                // check if group name exists
483                                def nameExists = true
484                                def u = 0
485
486                                // make sure a unique name is generated
487                                while (nameExists) {
488                                        u++
489                                        def count = 0
490                                       
491                                        flow.eventGroups.each() {
492                                                if (it.name == groupName) {
493                                                        groupName = "Group " + (increment + 1) + "," + u
494                                                } else {
495                                                        count++
496                                                }
497                                        }
498
499                                        nameExists = !(count == flow.eventGroups.size())
500                                }
501
502                                flow.eventGroups[increment] = new EventGroup( name: groupName )
503
504                                success()
505                        }.to "events"
506                        on("deleteEventGroup") {
507                                flash.values = params
508                                def delete = params.get('do') as int;
509
510                                // handle event groupings
511                                this.handleEventGrouping(flow, flash, params)
512
513                                // remove the group with this specific id
514                                if (flow.eventGroups[delete] && flow.eventGroups[delete] instanceof EventGroup) {
515                                        // remove this eventGroup
516                                        flow.eventGroups.remove(delete)
517                                }
518
519                                success()
520                        }.to "events"
521                        on("previous") {
522                                // handle event groupings
523                                this.handleEventGrouping(flow, flash, params)
524                        }.to "subjects"
525                        on("next") {
526                                flash.values = params
527                                flash.errors = [:]
528
529                                // handle study data
530                                if (flow.events.size() < 1) {
531                                        // append error map
532                                        this.appendErrorMap(['events': 'You need at least to create one event for your study'], flash.errors)
533                                        error()                                         
534                                } else if (this.handleEvents(flow, flash, params)) {
535                                        success()
536                                } else {
537                                        error()
538                                }
539                        }.to "groups"
540                        on("quickSave") {
541                                flash.values = params
542                                flash.errors = [:]
543
544                                // handle study data
545                                if (flow.events.size() < 1) {
546                                        // append error map
547                                        this.appendErrorMap(['events': 'You need at least to create one event for your study'], flash.errors)
548                                        error()
549                                } else if (this.handleEvents(flow, flash, params)) {
550                                        success()
551                                } else {
552                                        error()
553                                }
554                        }.to "waitForSave"
555                }
556
557                // groups page
558                groups {
559                        render(view: "_groups")
560                        onRender {
561                                flow.page = 5
562                                success()
563                        }
564                        on("previous") {
565                                this.handleSubjectGrouping(flow, flash, params)
566                                success()
567                        }.to "events"
568                        on("next") {
569                                this.handleSubjectGrouping(flow, flash, params)
570                                success()
571                        }.to "samples"
572                        on("quickSave") {
573                                this.handleSubjectGrouping(flow, flash, params)
574                                success()
575                        }.to "waitForSave"
576                }
577
578                // samples page
579                samples {
580                        render(view: "_samples")
581                        onRender {
582                                flow.page = 6
583                                flow.bla = "samples"
584
585                                // iterate through subjects
586                                flow.subjects.each() { subject ->
587                                        println subject.value.name
588
589                                        // iterate through events
590                                        flow.events.each() { event ->
591                                                println "bla"
592                                                if (event instanceof SamplingEvent) {
593                                                        //println event.getFieldValue('name')
594                                                        println event.startTime
595                                                        println event.endTime
596                                                }
597
598                                        }
599                                }
600
601                                success()
602                        }
603                        on("previous") {
604                                success()
605                        }.to "groups"
606                        on("next") {
607                                success()
608                        }.to "confirm"
609                        on("quickSave") {
610                                success()
611                        }.to "waitForSave"
612                }
613
614                // confirmation
615                confirm {
616                        render(view: "_confirmation")
617                        onRender {
618                                flow.page = 7
619                        }
620                        on("toStudy").to "study"
621                        on("toSubjects").to "subjects"
622                        on("toEvents").to "events"
623                        on("toGroups").to "groups"
624                        on("previous").to "samples"
625                        on("next").to "waitForSave"
626                }
627
628                waitForSave {
629                        render(view: "_wait")
630                        onRender {
631                                flow.page = 8
632                        }
633                        on("next").to "save"
634                }
635
636                // store all study data
637                save {
638                        action {
639                                println "saving..."
640                                flash.errors = [:]
641
642                                // persist data to the database
643                                try {
644                                        println ".saving wizard data..."
645
646                                        // add events to study
647                                        println ".add events to study"
648                                        flow.events.each() { event ->
649                                                if (event instanceof SamplingEvent) {
650                                                        flow.study.addToSamplingEvents(event)
651                                                } else {
652                                                        flow.study.addToEvents(event)
653                                                }
654                                        }
655
656                                        // add subjects to study
657                                        println ".add subjects to study"
658                                        flow.subjects.each() { subjectId, subject ->
659                                                flow.study.addToSubjects(subject)
660                                        }
661
662                                        // add eventGroups to study
663                                        println ".add eventGroups to study"
664                                        flow.eventGroups.each() { eventGroup ->
665                                                flow.study.addToEventGroups(eventGroup)
666                                        }
667
668                                        // save study
669                                        println ".saving study"
670                                        if (!flow.study.save(flush:true)) {
671                                                this.appendErrors(flow.study, flash.errors)
672                                                throw new Exception('error saving study')
673                                        }
674                                        println ".saved study "+flow.study+" (id: "+flow.study.id+")"
675
676                                        success()
677                                } catch (Exception e) {
678                                        // rollback
679                                        this.appendErrorMap(['exception': e.toString() + ', see log for stacktrace' ], flash.errors)
680
681                                        // stacktrace in flash scope
682                                        flash.debug = e.getStackTrace()
683
684                                        error()
685                                }
686                        }
687                        on("error").to "error"
688                        on(Exception).to "error"
689                        on("success").to "done"
690                }
691
692                // error storing data
693                error {
694                        render(view: "_error")
695                        onRender {
696                                flow.page = 7
697                        }
698                        on("next").to "waitForSave"
699                        on("previous").to "samples"
700                }
701
702                // render finish page
703                done {
704                        render(view: "_done")
705                        onRender {
706                                flow.page = 8
707                        }
708                }
709        }
710
711        /**
712         * re-usable code for handling study form data in a web flow
713         * @param Map LocalAttributeMap (the flow scope)
714         * @param Map localAttributeMap (the flash scope)
715         * @param Map GrailsParameterMap (the flow parameters = form data)
716         * @returns boolean
717         */
718        def handleStudy(flow, flash, params) {
719                // create study instance if we have none
720                if (!flow.study) flow.study = new Study();
721
722                // create date instance from date string?
723                // @see WizardTagLibrary::dateElement{...}
724                if (params.get('startDate')) {
725                        params.startDate = new Date().parse("d/M/yyyy", params.get('startDate').toString())
726                } else {
727                        params.remove('startDate')
728                }
729
730                // if a template is selected, get template instance
731                def template = params.remove('template')
732                if (template instanceof String && template.size() > 0) {
733                        flow.study.template = Template.findByName(template)
734                } else if (template instanceof Template) {
735                        flow.study.template = template
736                }
737
738                // iterate through fields
739                if (flow.study.template) {
740                        flow.study.giveFields().each() {
741                                flow.study.setFieldValue(it.name, params.get(it.escapedName()))
742                        }
743                }
744
745                // handle Publications and Contacts
746                handlePublications(flow, flash, params)
747                handleContacts(flow, flash, params)
748
749                // validate study
750                if (flow.study.validate()) {
751                        return true
752                } else {
753                        // validation failed, feedback errors
754                        flash.errors = [:]
755                        this.appendErrors(flow.study, flash.errors)
756                        return false
757                }
758        }
759
760        /**
761         * re-usable code for handling publications form data in a web flow
762         * @param Map LocalAttributeMap (the flow scope)
763         * @param Map localAttributeMap (the flash scope)
764         * @param Map GrailsParameterMap (the flow parameters = form data)
765         * @returns boolean
766         */
767        def handlePublications(flow, flash, params) {
768                // create study instance if we have none
769                if (!flow.study) flow.study = new Study();
770                if (!flow.study.publications ) flow.study.publications = [];
771
772                // Check the ids of the pubblications that should be attached
773                // to this study. If they are already attached, keep 'm. If
774                // studies are attached that are not in the selected (i.e. the
775                // user deleted them), remove them
776                def publicationIDs = params.get( 'publication_ids' );
777                if( publicationIDs ) {
778                    // Find the individual IDs and make integers
779                    publicationIDs = publicationIDs.split(',').collect { Integer.parseInt( it, 10 ) };
780
781                    // First remove the publication that are not present in the array
782                    flow.study.publications.removeAll { publication -> !publicationIDs.find { id -> id == publication.id } }
783
784                    // Add those publications not yet present in the database
785                    publicationIDs.each { id ->
786                        if( !flow.study.publications.find { publication -> id == publication.id } ) {
787                            def publication = Publication.get( id );
788                            if( publication ) {
789                                flow.study.addToPublications( publication );
790                            } else {
791                                println( 'Publication with ID ' + id + ' not found in database.' );
792                            }
793                        }
794                    }
795
796                } else {
797                    println( 'No publications selected.')
798                    flow.study.publications.clear();
799                }
800
801        }
802
803        /**
804         * re-usable code for handling contacts form data in a web flow
805         * @param Map LocalAttributeMap (the flow scope)
806         * @param Map localAttributeMap (the flash scope)
807         * @param Map GrailsParameterMap (the flow parameters = form data)
808         * @returns boolean
809         */
810        def handleContacts(flow, flash, params) {
811                // create study instance if we have none
812                if (!flow.study) flow.study = new Study();
813                if (!flow.study.persons ) flow.study.persons = [];
814
815                // Check the ids of the contacts that should be attached
816                // to this study. If they are already attached, keep 'm. If
817                // studies are attached that are not in the selected (i.e. the
818                // user deleted them), remove them
819
820                // Contacts are saved as [person_id]-[role_id]
821                println( params );
822                def contactIDs = params.get( 'contacts_ids' );
823                println( contactIDs );
824                if( contactIDs ) {
825                    // Find the individual IDs and make integers
826                    contactIDs = contactIDs.split(',').collect {
827                        def parts = it.split( '-' );
828                        return [ person: Integer.parseInt( parts[0] ), role: Integer.parseInt( parts[1] ) ];
829                    };
830
831                    // First remove the contacts that are not present in the array
832                    flow.study.persons.removeAll {
833                        studyperson -> !contactIDs.find { ids -> ( ids.person == studyperson.person.id ) && ( ids.role == studyperson.role.id ) }
834                    };
835
836                    // Add those contacts not yet present in the database
837                    contactIDs.each { ids ->
838                        if( !flow.study.persons.find { studyperson -> ( ids.person == studyperson.person.id ) && ( ids.role == studyperson.role.id ) } ) {
839                            def person = Person.get( ids.person );
840                            def role = PersonRole.get( ids.role );
841                            if( person && role ) {
842                                // Find a studyperson object with these parameters
843                                def studyPerson = StudyPerson.findAll().find { studyperson -> studyperson.person.id == person.id && studyperson.role.id == role.id };
844
845                                // If if does not yet exist, save the example
846                                if( !studyPerson ) {
847                                    studyPerson = new StudyPerson(
848                                        person: person,
849                                        role: role
850                                    );
851                                    studyPerson.save( flush: true );
852                                }
853
854                                flow.study.addToPersons( studyPerson );
855                            } else {
856                                println( 'Person ' + ids.person + ' or Role ' + ids.role + ' not found in database.' );
857                            }
858                        }
859                    }
860
861                } else {
862                    println( 'No persons selected.')
863                    flow.study.persons.clear();
864                }
865
866        }
867        /**
868         * re-usable code for handling subject form data in a web flow
869         * @param Map LocalAttributeMap (the flow scope)
870         * @param Map localAttributeMap (the flash scope)
871         * @param Map GrailsParameterMap (the flow parameters = form data)
872         * @returns boolean
873         */
874        def handleSubjects(flow, flash, params) {
875                def names = [:]
876                def errors = false
877                def id = 0
878
879                // iterate through subject templates
880                flow.subjectTemplates.each() { subjectTemplate ->
881                        // iterate through subjects
882                        subjectTemplate.value.subjects.each() { subjectIncrement, subjectId ->
883                                // iterate through fields (= template fields and domain properties)
884                                flow.subjects[ subjectId ].giveFields().each() { subjectField ->
885                                        // set the field
886                                        flow.subjects[ subjectId ].setFieldValue(
887                                                subjectField.name,
888                                                params.get( 'subject_' + subjectId + '_' + subjectField.escapedName() )
889                                        )
890                                }
891
892                                // validate subject
893                                if (!flow.subjects[ subjectId ].validate()) {
894                                        errors = true
895                                        this.appendErrors(flow.subjects[ subjectId ], flash.errors, 'subject_' + subjectId + '_')
896                                }
897                        }
898                }
899
900                return !errors
901        }
902
903        /**
904         * re-usable code for handling event form data in a web flow
905         * @param Map LocalAttributeMap (the flow scope)
906         * @param Map localAttributeMap (the flash scope)
907         * @param Map GrailsParameterMap (the flow parameters = form data)
908         * @returns boolean
909         */
910        def handleEvents(flow, flash, params) {
911                def errors = false
912                def template = null
913
914                // handle the type of event
915                if (params.eventType == 'event') {
916                        flow.event = new Event();
917                        template = params.remove('eventTemplate')
918                } else if (params.eventType == 'sample') {
919                        flow.event = new SamplingEvent();
920                        template = params.remove('sampleTemplate')
921                }
922
923                // if a template is selected, get template instance
924                if (template instanceof String && template.size() > 0) {
925                        params.template = Template.findByName(template)
926                } else if (template instanceof Template) {
927                        params.template = template
928                } else {
929                        params.template = null
930                }
931
932                // set template
933                if (params.template) flow.event.template = params.template
934
935                // update event instance with parameters
936                flow.event.giveFields().each() { eventField ->
937                        flow.event.setFieldValue(eventField.name, params[ eventField.escapedName() ])   
938                }
939
940                // handle event objects
941                flow.eventTemplates.each() { eventTemplate ->
942                        // iterate through events
943                        eventTemplate.getValue().events.each() { eventId ->
944                                // iterate through template fields
945                                flow.events[ eventId ].giveFields().each() { eventField ->
946                                        flow.events[ eventId ].setFieldValue(eventField.name, params.get( 'event_' + eventId + '_' + eventField.escapedName() ) )
947                                }
948
949                                // validate event
950                                if (!flow.events[ eventId ].validate()) {
951                                        errors = true
952                                        this.appendErrors(flow.events[ eventId ], flash.errors, 'event_' + eventId + '_')
953                                }
954                        }
955                }
956
957                // handle event grouping
958                handleEventGrouping(flow, flash, params)
959
960                return !errors
961        }
962
963        /**
964         * re-usable code for handling event grouping in a web flow
965         * @param Map LocalAttributeMap (the flow scope)
966         * @param Map localAttributeMap (the flash scope)
967         * @param Map GrailsParameterMap (the flow parameters = form data)
968         * @returns boolean
969         */
970        def handleEventGrouping(flow, flash, params) {
971                // walk through eventGroups
972                def g = 0
973                flow.eventGroups.each() { eventGroup ->
974                        def e = 0
975
976                        // reset events
977                        eventGroup.events = new HashSet()
978
979                        // iterate through events
980                        flow.events.each() {
981                                if (params.get('event_' + e + '_group_' + g) == 'on') {
982                                        eventGroup.addToEvents(it)
983                                }
984                                e++
985                        }
986                        g++
987                }
988        }
989
990        /**
991         * re-usable code for handling subject grouping in a web flow
992         * @param Map LocalAttributeMap (the flow scope)
993         * @param Map localAttributeMap (the flash scope)
994         * @param Map GrailsParameterMap (the flow parameters = form data)
995         * @returns boolean
996         */
997        def handleSubjectGrouping(flow, flash, params) {
998                // iterate through event groups
999                def g = 0
1000                flow.eventGroups.each() { eventGroup ->
1001                        // reset subjects
1002                        eventGroup.subjects = new HashSet()
1003
1004                        // iterate through subjects
1005                        flow.subjects.each() { subjectId, subject ->
1006                                // is this combination set?
1007                                if (params.get('subject_' + subjectId + '_group_' + g) != null) {
1008                                        eventGroup.addToSubjects(subject)
1009                                }
1010                        }
1011
1012                        g++
1013                }
1014        }
1015
1016        /**
1017         * return the object from a map of objects by searching for a name
1018         * @param String name
1019         * @param Map map of objects
1020         * @return Object
1021         */
1022        def getObjectByName(name, map) {
1023                def result = null
1024                map.each() {
1025                        if (it.name == name) {
1026                                result = it
1027                        }
1028                }
1029
1030                return result
1031        }
1032
1033        /**
1034         * transform domain class validation errors into a human readable
1035         * linked hash map
1036         * @param object validated domain class
1037         * @returns object  linkedHashMap
1038         */
1039        def getHumanReadableErrors(object) {
1040                def errors = [:]
1041                object.errors.getAllErrors().each() {
1042                        def message = it.toString()
1043
1044                        //errors[it.getArguments()[0]] = it.getDefaultMessage()
1045                        errors[it.getArguments()[0]] = message.substring(0, message.indexOf(';'))
1046                }
1047
1048                return errors
1049        }
1050
1051        /**
1052         * append errors of a particular object to a map
1053         * @param object
1054         * @param map linkedHashMap
1055         * @void
1056         */
1057        def appendErrors(object, map) {
1058                this.appendErrorMap(this.getHumanReadableErrors(object), map)
1059        }
1060
1061        def appendErrors(object, map, prepend) {
1062                this.appendErrorMap(this.getHumanReadableErrors(object), map, prepend)
1063        }
1064
1065        /**
1066         * append errors of one map to another map
1067         * @param map linkedHashMap
1068         * @param map linkedHashMap
1069         * @void
1070         */
1071        def appendErrorMap(map, mapToExtend) {
1072                map.each() {key, value ->
1073                        mapToExtend[key] = ['key': key, 'value': value, 'dynamic': false]
1074                }
1075        }
1076
1077        def appendErrorMap(map, mapToExtend, prepend) {
1078                map.each() {key, value ->
1079                        mapToExtend[prepend + key] = ['key': key, 'value': value, 'dynamic': true]
1080                }
1081        }
1082
1083        /**
1084         * Parses a RelTime string and returns a nice human readable string
1085         *
1086         * @returns Human Readable string or a HTTP response code 400 on error
1087         */
1088        def ajaxParseRelTime = {
1089                if (params.reltime == null) {
1090                        response.status = 400;
1091                        render('reltime parameter is expected');
1092                }
1093
1094                try {
1095                        def reltime = RelTime.parseRelTime(params.reltime);
1096                        render reltime.toPrettyString();
1097                } catch (IllegalArgumentException e) {
1098                        response.status = 400;
1099                        render(e.getMessage());
1100                }
1101        }
1102}
Note: See TracBrowser for help on using the repository browser.