root/trunk/grails-app/controllers/dbnp/studycapturing/StudyWizardController.groovy @ 1539

Revision 1539, 52.5 KB (checked in by robert@…, 3 years ago)

Fixed #299: readers and writers are not correctly saved

  • Property svn:keywords set to Rev Author Date
Line 
1package dbnp.studycapturing
2
3import grails.plugins.springsecurity.Secured
4
5import dbnp.authentication.SecUser
6import org.codehaus.groovy.grails.plugins.web.taglib.ValidationTagLib
7import org.dbnp.gdt.*
8import org.dbnp.bgdt.*
9
10/**
11 * ajaxflow Controller
12 *
13 * @author      Jeroen Wesbeek
14 * @since       20101220
15 *
16 * Revision information:
17 * $Rev$
18 * $Author$
19 * $Date$
20 */
21@Secured(['IS_AUTHENTICATED_REMEMBERED'])
22class StudyWizardController {
23        def pluginManager
24        def authenticationService
25        def validationTagLib = new ValidationTagLib()
26
27        /**
28         * index method, redirect to the webflow
29         * @void
30         */
31        def index = {
32                // Grom a development message
33                if (pluginManager.getGrailsPlugin('grom')) "redirecting into the webflow".grom()
34
35                def jump = [:]
36
37                // allow quickjumps to:
38                //      edit a study    : /wizard?jump=edit&id=1
39                //      create a study  : /wizard?jump=create
40                if (params.get('jump')) {
41                        switch (params.get('jump')) {
42                                case 'create':
43                                        jump = [
44                                            action: 'create'
45                                        ]
46                                        break
47                                case 'edit':
48                                        jump = [
49                                            action      : 'edit',
50                                                id              : params.get('id')
51                                        ]
52                                        break
53                                default:
54                                        break
55                        }
56                }
57
58                // store in session
59                session.jump = jump
60
61                /**
62                 * Do you believe it in your head?
63                 * I can go with the flow
64                 * Don't say it doesn't matter (with the flow) matter anymore
65                 * I can go with the flow (I can go)
66                 * Do you believe it in your head?
67                 */
68                redirect(action: 'pages')
69        }
70
71        /**
72         * WebFlow definition
73         * @void
74         */
75        def pagesFlow = {
76                // start the flow
77                onStart {
78                        // Grom a development message
79                        if (pluginManager.getGrailsPlugin('grom')) "entering the WebFlow".grom()
80
81                        // define variables in the flow scope which is availabe
82                        // throughout the complete webflow also have a look at
83                        // the Flow Scopes section on http://www.grails.org/WebFlow
84                        //
85                        // The following flow scope variables are used to generate
86                        // wizard tabs. Also see common/_tabs.gsp for more information
87                        // define flow variables
88                        flow.page = 0
89                        flow.pages = [
90                                //[title: 'Templates'],                 // templates
91                                [title: 'Start'],                               // load or create a study
92                                [title: 'Subjects'],                    // subjects
93                                [title: 'Events'],                              // events and event grouping
94                                //[title: 'Event Groups'],              // groups
95                                [title: 'Samples'],                             // samples
96                                [title: 'Assays'],                              // assays
97                                //[title: 'Assay Groups'],              // assays
98                                [title: 'Confirmation'],                // confirmation page
99                                [title: 'Done']                                 // finish page
100                        ]
101                        flow.jump = session.jump
102
103                        success()
104                }
105
106                // render the main wizard page which immediately
107                // triggers the 'next' action (hence, the main
108                // page dynamically renders the study template
109                // and makes the flow jump to the study logic)
110                mainPage {
111                        render(view: "/studyWizard/index")
112                        onRender {
113                                // Grom a development message
114                                if (pluginManager.getGrailsPlugin('grom')) "rendering the main Ajaxflow page (index.gsp)".grom()
115
116                                // let the view know we're in page 1
117                                flow.page = 1
118                                success()
119                        }
120                        on("next").to "handleJump"
121                }
122
123                // handle the jump parameter
124                //
125                // I came to get down [2x]
126                // So get out your seats and jump around
127                // Jump around [3x]
128                // Jump up Jump up and get down
129                // Jump [18x]
130                handleJump {
131                        action {
132                                // Grom a development message
133                                if (pluginManager.getGrailsPlugin('grom')) "entering handleJump".grom()
134
135                                if (flow.jump && flow.jump.action == 'edit') {
136                                        if (flow.jump.id) {
137                                                // load study
138                                                if (this.loadStudy(flow, flash, [studyid:flow.jump.id],authenticationService.getLoggedInUser())) {
139                                                        toStudyPage()
140                                                } else {
141                                                        toStartPage()
142                                                }
143                                        } else {
144                                                toModifyPage()
145                                        }
146                                } else if (flow.jump && flow.jump.action == 'create') {
147                                        if (!flow.study) flow.study = new Study()
148                                        toStudyPage()
149                                } else {
150                                        toStartPage()
151                                }
152                        }
153                        on("toStartPage").to "start"
154                        on("toStudyPage").to "study"
155                        on("toModifyPage").to "modify"
156                }
157
158                // create or modify a study
159                start {
160                        render(view: "_start")
161                        onRender {
162                                // Grom a development message
163                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_start.gsp".grom()
164
165                                flow.page = 1
166                                success()
167                        }
168                        on("next") {
169                                // clean the flow scope
170                                flow.remove('study')
171
172                                // create a new study instance
173                                if (!flow.study) flow.study = new Study()
174
175                                // set 'quicksave' variable to false
176                                flow.quickSave = false
177                        }.to "study"
178                        on("modify").to "modify"
179                        on("import").to "redirectToImport"
180                }
181
182                // redirect to the import wizard
183                redirectToImport {
184                        render(view: "_redirect")
185                        onRender {
186                                // Grom a development message
187                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_redirect.gsp".grom()
188
189                                flash.uri = "/importer/index"
190                        }
191                        on("next").to "start"
192                }
193
194                // load a study to modify
195                modify {
196                        render(view: "_modify")
197                        onRender {
198                                // Grom a development message
199                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_modify.gsp".grom()
200
201                                flow.page = 1
202                                flash.showCancel = true
203                                success()
204                        }
205                        on("cancel") {
206                                flow.remove('study')
207
208                                success()
209                        }.to "start"
210                        on("next") {
211                                // load study
212                                if (this.loadStudy(flow, flash, params, authenticationService.getLoggedInUser())) {
213                                        success()
214                                } else {
215                                        error()
216                                }
217                        }.to "study"
218                }
219
220                // render and handle the study page
221                study {
222                        render(view: "_study")
223                        onRender {
224                                // Grom a development message
225                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_study.gsp".grom()
226
227                                flow.page = 1
228
229                                // since this controller was refactored it's technically
230                                // safe to enable quicksave throughout the application.
231                                // However, we must keep an eye on the quality of the
232                                // studies as this change makes it easier to create dummy
233                                // studies which will create garbage in out database.
234                                flow.quickSave = true
235
236                                success()
237                        }
238                        on("refresh") {
239                                // handle form data
240                                studyPage(flow, flash, params)
241
242                                // force refresh of the template
243                                if (flow.study.template && flow.study.template instanceof Template) {
244                                        flow.study.template.refresh()
245                                }
246
247                                // reset errors
248                                flash.wizardErrors = [:]
249                                success()
250                        }.to "study"
251            on("switchTemplate") {
252                                // handle form data
253                                studyPage(flow, flash, params)
254
255                                // reset errors
256                                flash.wizardErrors = [:]
257                                success()
258                        }.to "study"
259                        on("previous") {
260                                // handle form data
261                                studyPage(flow, flash, params)
262
263                                // reset errors
264                                flash.wizardErrors = [:]
265                                success()
266                        }.to "start"
267                        on("next") {
268                                studyPage(flow, flash, params) ? success() : error()
269                        }.to "subjects"
270                        on("quickSave") {
271                                studyPage(flow, flash, params) ? success() : error()
272                        }.to "save"
273                        on("toPageTwo") {
274                                studyPage(flow, flash, params) ? success() : error()
275                        }.to "subjects"
276                        on("toPageThree") {
277                                studyPage(flow, flash, params) ? success() : error()
278                        }.to "events"
279                        on("toPageFour") {
280                                studyPage(flow, flash, params) ? success() : error()
281                        }.to "samples"
282                        on("toPageFive") {
283                                studyPage(flow, flash, params) ? success() : error()
284                        }.to "assays"
285                        on("toPageSix") {
286                                studyPage(flow, flash, params) ? success() : error()
287                        }.to "confirm"
288                        on("toPageSeven") {
289                                studyPage(flow, flash, params) ? success() : error()
290                        }.to "save"
291                }
292
293                // render and handle subjects page
294                subjects {
295                        render(view: "_subjects")
296                        onRender {
297                                // Grom a development message
298                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_subjects.gsp".grom()
299
300                                flow.page = 2
301
302                                if (!flash.values || !flash.values.addNumber) flash.values = [addNumber:1]
303
304                                success()
305                        }
306                        on("refresh") {
307                                // remember the params in the flash scope
308                                flash.values = params
309
310                                // refresh templates
311                                if (flow.study.subjects) {
312                                        flow.study.giveSubjectTemplates().each() {
313                                                it.refresh()
314                                        }
315                                }
316
317                                success()
318                        }.to "subjects"
319                        on("add") {
320                                // handle form data
321                                addSubjects(flow, flash, params) ? success() : error()
322                        }.to "subjects"
323                        on("delete") {
324                                // handle form data
325                                subjectPage(flow, flash, params)
326
327                                // reset errors
328                                flash.wizardErrors = [:]
329
330                                // remove subject
331                                def subjectToRemove = flow.study.subjects.find { it.identifier == (params.get('do') as int) }
332                                if (subjectToRemove) {
333                                        flow.study.deleteSubject( subjectToRemove )
334                                }
335                        }.to "subjects"
336                        on("previous") {
337                                // handle form data
338                                subjectPage(flow, flash, params)
339
340                                // reset errors
341                                flash.wizardErrors = [:]
342                                success()
343                        }.to "study"
344                        on("next") {
345                                // handle form data
346                                subjectPage(flow, flash, params) ? success() : error()
347                        }.to "events"
348                        on("quickSave") {
349                                // handle form data
350                                subjectPage(flow, flash, params) ? success() : error()
351                        }.to "save"
352                        on("toPageOne") {
353                                subjectPage(flow, flash, params) ? success() : error()
354                        }.to "study"
355                        on("toPageThree") {
356                                subjectPage(flow, flash, params) ? success() : error()
357                        }.to "events"
358                        on("toPageFour") {
359                                subjectPage(flow, flash, params) ? success() : error()
360                        }.to "samples"
361                        on("toPageFive") {
362                                subjectPage(flow, flash, params) ? success() : error()
363                        }.to "assays"
364                        on("toPageSix") {
365                                subjectPage(flow, flash, params) ? success() : error()
366                        }.to "confirm"
367                        on("toPageSeven") {
368                                subjectPage(flow, flash, params) ? success() : error()
369                        }.to "save"
370                }
371
372                // render events page
373                events {
374                        render(view: "_events")
375                        onRender {
376                                // Grom a development message
377                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_events.gsp".grom()
378
379                                flow.page = 3
380
381                                // add initial eventGroup to study
382                                if (!flow.study.eventGroups?.size()) {
383                                        flow.study.addToEventGroups(
384                                                new EventGroup(name: 'Group 1')
385                                        )
386                                }
387
388                                success()
389                        }
390                        on("clear") {
391                                // remove all events
392                                (flow.study.events + flow.study.samplingEvents).each() { event ->
393                                        if (event instanceof SamplingEvent) {
394                                                flow.study.deleteSamplingEvent( event )
395                                        } else {
396                                                flow.study.deleteEvent( event )
397                                        }
398                                }
399
400                                success()
401                        }.to "events"
402                        on("switchTemplate") {
403                                // handle form data
404                                eventPage(flow, flash, params)
405
406                                // get template
407                                def type        = params.get('eventType')
408                                def template= Template.findByName( params.get( type + 'Template' ) )
409
410                                // change template and/or instance?
411                                if (!flow.event || (flow.event instanceof Event && type == "sample") || (flow.event instanceof SamplingEvent && type == "event")) {
412                                        // create new instance
413                                        flow.event = (type == "event") ? new Event(template: template) : new SamplingEvent(template: template)
414                                } else {
415                                        flow.event.template = template
416                                }
417
418                                // reset errors
419                                flash.wizardErrors = [:]
420                                success()
421
422                        }.to "events"
423                        on("refresh") {
424                                // handle form data
425                                eventPage(flow, flash, params)
426
427                                // refresh templates
428                                flow.study.giveEventTemplates().each() {
429                                        it.refresh()
430                                }
431
432                                // refresh event template
433                                if (flow.event?.template) flow.event.template.refresh()
434
435                                // reset errors
436                                flash.wizardErrors = [:]
437                                success()
438                        }.to "events"
439                        on("add") {
440                                // handle form data
441                                eventPage(flow, flash, params)
442
443                                // reset errors
444                                flash.wizardErrors = [:]
445
446                                // add event to study
447                                if (flow.event instanceof SamplingEvent) {
448                                        flow.study.addToSamplingEvents( flow.event )
449                                } else {
450                                        flow.study.addToEvents( flow.event )
451                                }
452
453                                // validate event
454                                if (flow.event.validate()) {
455                                        // remove event from the flowscope
456                                        flow.remove('event')
457
458                                        success()
459                                } else {
460                                        // event does not validate
461                                        // remove from study
462                                        if (flow.event instanceof SamplingEvent) {
463                                                flow.study.removeFromSamplingEvents( flow.event )
464                                        } else {
465                                                flow.study.removeFromEvents( flow.event )
466                                        }
467
468                                        // append errors
469                                        this.appendErrors(flow.event, flash.wizardErrors)
470                                        error()
471                                }
472                        }.to "events"
473                        on("deleteEvent") {
474                                // handle form data
475                                eventPage(flow, flash, params)
476
477                                // reset errors
478                                flash.wizardErrors = [:]
479
480                                // find matching (sampling) event
481                                def event                       = flow.study.events.find { it.getIdentifier() == (params.get('do') as int) }
482                                def samplingEvent       = flow.study.samplingEvents.find { it.getIdentifier() == (params.get('do') as int) }
483
484                                // perform delete
485                                if (event) flow.study.deleteEvent( event )
486                                if (samplingEvent) flow.study.deleteSamplingEvent( samplingEvent )
487                        }.to "events"
488                        on("addEventGroup") {
489                                // handle form data
490                                eventPage(flow, flash, params)
491
492                                // set work variables
493                                def groupName = 'Group '
494                                def tempGroupIterator = 1
495                                def tempGroupName = groupName + tempGroupIterator
496
497                                // make sure group name is unique
498                                if (flow.study.eventGroups) {
499                                        while (flow.study.eventGroups.find { it.name == tempGroupName }) {
500                                                tempGroupIterator++
501                                                tempGroupName = groupName + tempGroupIterator
502                                        }
503                                }
504                                groupName = tempGroupName
505
506                                // add a new eventGroup
507                                flow.study.addToEventGroups(
508                                        new EventGroup(
509                                                name    : groupName
510                                        )
511                                )
512
513                                // reset errors
514                                flash.wizardErrors = [:]
515                                success()
516                        }.to "events"
517                        on("deleteEventGroup") {
518                                // handle form data
519                                eventPage(flow, flash, params)
520
521                                // reset errors
522                                flash.wizardErrors = [:]
523
524                                // remove eventGroup
525                                def eventGroupToRemove = flow.study.eventGroups.find { it.getIdentifier() == (params.get('do') as int) }
526                                if (eventGroupToRemove) {
527                                        flow.study.deleteEventGroup( eventGroupToRemove )
528                                }
529                        }.to "events"
530                        on("duplicate") {
531                                // handle form data
532                                eventPage(flow, flash, params)
533
534                                // reset errors
535                                flash.wizardErrors = [:]
536
537                                // clone event
538                                def event = null
539                                (((flow.study.events) ? flow.study.events : []) + ((flow.study.samplingEvents) ? flow.study.samplingEvents : [])).find { it.getIdentifier() == (params.get('do') as int) }.each {
540                                        event = (it instanceof SamplingEvent) ? new SamplingEvent() : new Event()
541
542                                        // set template
543                                        event.template = it.template
544
545                                        // copy data
546                                        it.giveFields().each() { field ->
547                                                event.setFieldValue(
548                                                        field.name,
549                                                        it.getFieldValue(field.name)
550                                                )
551                                        }
552
553                                        // assign duplicate event to study
554                                        if (event instanceof SamplingEvent) {
555                                                flow.study.addToSamplingEvents(event)
556                                        } else {
557                                                flow.study.addToEvents(event)
558                                        }
559                                }
560
561                                success()
562                        }.to "events"
563                        on("previous") {
564                                // handle form data
565                                eventPage(flow, flash, params)
566
567                                // reset errors
568                                flash.wizardErrors = [:]
569                                success()
570                        }.to "subjects"
571                        on("next") {
572                                // handle form data
573                                eventPage(flow, flash, params) ? success() : error()
574                        }.to "eventsNext"
575                        on("quickSave") {
576                                // handle form data
577                                eventPage(flow, flash, params) ? success() : error()
578                        }.to "save"
579                        on("toPageOne") {
580                                eventPage(flow, flash, params) ? success() : error()
581                        }.to "study"
582                        on("toPageTwo") {
583                                eventPage(flow, flash, params) ? success() : error()
584                        }.to "subjects"
585                        on("toPageFour") {
586                                eventPage(flow, flash, params) ? success() : error()
587                        }.to "samples"
588                        on("toPageFive") {
589                                eventPage(flow, flash, params) ? success() : error()
590                        }.to "assays"
591                        on("toPageSix") {
592                                eventPage(flow, flash, params) ? success() : error()
593                        }.to "confirm"
594                        on("toPageSeven") {
595                                eventPage(flow, flash, params) ? success() : error()
596                        }.to "save"
597                }
598
599                // decide to show a warning page or not
600                eventsNext {
601                        action {
602                                // Grom a development message
603                                if (pluginManager.getGrailsPlugin('grom')) ".entering eventsNext".grom()
604
605                                def assigned = false
606
607                                // check if all sampling events are in an eventGroup
608                                flow.study.samplingEvents.each() { samplingEvent ->
609                                        // iterate through eventGroups
610                                        flow.study.eventGroups.each() { eventGroup ->
611                                                if ( eventGroup.samplingEvents.find { it.equals(samplingEvent) } ) {
612                                                        assigned = true
613                                                }
614                                        }
615                                }
616
617                                if (assigned) {
618                                        toGroupsPage()
619                                } else {
620                                        toWarningPage()
621                                }
622                        }
623                        on("toWarningPage").to "unassignedSamplingEventWarning"
624                        on("toGroupsPage").to "groups"
625                }
626
627                // warning page for unassigned samplingEvent
628                unassignedSamplingEventWarning {
629                        render(view: "_unassigned_samplingEvent_warning")
630                        onRender {
631                                // Grom a development message
632                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_unnassigned_samplingEvent_warning.gsp".grom()
633
634                                flow.page = 3
635                                success()
636                        }
637                        on("next").to "groups"
638                        on("previous").to "events"
639                        on("toPageOne") {
640                                eventPage(flow, flash, params) ? success() : error()
641                        }.to "study"
642                        on("toPageTwo") {
643                                eventPage(flow, flash, params) ? success() : error()
644                        }.to "subjects"
645                        on("toPageFour") {
646                                eventPage(flow, flash, params) ? success() : error()
647                        }.to "samples"
648                        on("toPageFive") {
649                                eventPage(flow, flash, params) ? success() : error()
650                        }.to "assays"
651                        on("toPageSix") {
652                                eventPage(flow, flash, params) ? success() : error()
653                        }.to "confirm"
654                        on("toPageSeven") {
655                                eventPage(flow, flash, params) ? success() : error()
656                        }.to "save"
657                }
658
659                // groups page
660                groups {
661                        render(view: "_groups")
662                        onRender {
663                                // Grom a development message
664                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_groups.gsp".grom()
665
666                                flow.page = 3
667                                success()
668                        }
669                        on("previous") {
670                                // handle form data
671                                groupPage(flow, flash, params) ? success() : error()
672                        }.to "events"
673                        on("next") {
674                                // handle form data
675                                groupPage(flow, flash, params) ? success() : error()
676                        }.to "samples"
677                        on("quickSave") {
678                                // handle form data
679                                groupPage(flow, flash, params) ? success() : error()
680                        }.to "save"
681                        on("toPageOne") {
682                                groupPage(flow, flash, params) ? success() : error()
683                        }.to "study"
684                        on("toPageTwo") {
685                                groupPage(flow, flash, params) ? success() : error()
686                        }.to "subjects"
687                        on("toPageFour") {
688                                groupPage(flow, flash, params) ? success() : error()
689                        }.to "samples"
690                        on("toPageFive") {
691                                groupPage(flow, flash, params) ? success() : error()
692                        }.to "assays"
693                        on("toPageSix") {
694                                groupPage(flow, flash, params) ? success() : error()
695                        }.to "confirm"
696                        on("toPageSeven") {
697                                groupPage(flow, flash, params) ? success() : error()
698                        }.to "save"
699                }
700
701                // sample 'previous' page with warning
702                samplePrevious {
703                        render(view: "_samples_previous_warning")
704                        onRender {
705                                // Grom a development message
706                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_samples_previous_warning.gsp".grom()
707
708                                flow.page = 4
709                        }
710                        on("next").to "samples"
711                        on("previous").to "groups"
712                        on("toPageOne").to "study"
713                        on("toPageTwo").to "subjects"
714                        on("toPageThree").to "events"
715                        on("toPageFive").to "assays"
716                        on("toPageSix").to "confirm"
717                        on("toPageSeven").to "save"
718                }
719
720                // samples page
721                samples {
722                        render(view: "_samples")
723                        onRender {
724                                // Grom a development message
725                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_samples.gsp".grom()
726
727                                flow.page = 4
728                                success()
729                        }
730                        on("switchTemplate") {
731                                // handle form data
732                                samplePage(flow, flash, params)
733
734                                // ignore errors
735                                flash.wizardErrors = [:]
736
737                                succes()
738                        }.to "samples"
739                        on("refresh") {
740                                // handle samples
741                                samplePage(flow, flash, params)
742
743                                // refresh all sample templates
744                                flow.study.giveSampleTemplates().each() {
745                                        it.refresh()
746                                }
747
748                                // ignore errors
749                                flash.wizardErrors = [:]
750
751                                success()
752                        }.to "samples"
753                        on("regenerate") {
754                                // handle samples
755                                samplePage(flow, flash, params)
756
757                                // remove all samples from the study
758                                flow.study.samples.findAll{true}.each() { sample ->
759                                        flow.study.deleteSample( sample )
760                                }
761
762                                // ignore errors
763                                flash.wizardErrors = [:]
764
765                                success()
766                        }.to "samples"
767                        on("previous") {
768                                // handle samples
769                                samplePage(flow, flash, params)
770
771                                // ignore errors
772                                flash.wizardErrors = [:]
773
774                                success()
775                        }.to "samplePrevious"
776                        on("next") {
777                                // handle form data
778                                samplePage(flow, flash, params) ? success() : error()
779                        }.to "assays"
780                        on("quickSave") {
781                                // handle form data
782                                samplePage(flow, flash, params) ? success() : error()
783                        }.to "save"
784                        on("toPageOne") {
785                                samplePage(flow, flash, params) ? success() : error()
786                        }.to "study"
787                        on("toPageTwo") {
788                                samplePage(flow, flash, params) ? success() : error()
789                        }.to "subjects"
790                        on("toPageThree") {
791                                samplePage(flow, flash, params) ? success() : error()
792                        }.to "events"
793                        on("toPageFive") {
794                                samplePage(flow, flash, params) ? success() : error()
795                        }.to "assays"
796                        on("toPageSix") {
797                                samplePage(flow, flash, params) ? success() : error()
798                        }.to "confirm"
799                        on("toPageSeven") {
800                                samplePage(flow, flash, params) ? success() : error()
801                        }.to "save"
802                }
803
804                // assays page
805                assays {
806                        render(view: "_assays")
807                        onRender {
808                                // Grom a development message
809                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_assays.gsp".grom()
810
811                                flow.page = 5
812                        }
813                        on("refresh") {
814                                // handle form data
815                                assayPage(flow, flash, params)
816
817                                // force refresh of the template
818                                if (flow.assay && flow.assay.template && flow.assay.template instanceof Template) {
819                                        flow.assay.template.refresh()
820                                }
821
822                                // reset errors
823                                flash.wizardErrors = [:]
824                                success()
825                        }.to "assays"
826            on("switchTemplate") {
827                                // handle form data
828                    assayPage(flow, flash, params)
829
830                    // find assay template
831                    def template = Template.findByName(params.get('template'))
832                    if (flow.assay) {
833                            // set template
834                            flow.assay.template = template
835                            if (template) {
836                                    flow.assay.setFieldValue(
837                                            'externalAssayID',
838                                            ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + ucwords(template.name).replaceAll("([ ]{1,})", "")
839                                    )
840                            }
841                    } else {
842                            // create a new assay instance
843                            flow.assay = new Assay(template: template)
844                            if (template) {
845                                    flow.assay.setFieldValue(
846                                            'externalAssayID',
847                                            ucwords(flow.study.code).replaceAll("([ ]{1,})", "") + '_' + ucwords(template.name).replaceAll("([ ]{1,})", "")
848                                    )
849                            }
850                    }
851
852                                // reset errors
853                                flash.wizardErrors = [:]
854                                success()
855                        }.to "assays"
856                        on("add") {
857                                // handle form data
858                                assayPage(flow, flash, params)
859
860                                // reset errors
861                                flash.wizardErrors = [:]
862
863                                // add assay to study
864                                flow.study.addToAssays( flow.assay )
865
866                                // validate assay
867                                if (flow.assay.validate()) {
868                                        // remove assay from the flowscope
869                                        flow.remove('assay')
870                                        success()
871                                } else {
872                                        // assay does not validate
873                                        // remove from study
874                                        flow.study.deleteAssay( flow.assay )
875
876                                        // append errors
877                                        this.appendErrors(flow.assay, flash.wizardErrors)
878                                        error()
879                                }
880                        }.to "assays"
881                        on("deleteAssay") {
882                                // handle form data
883                                assayPage(flow, flash, params)
884
885                                // reset errors
886                                flash.wizardErrors = [:]
887
888                                // find this assay
889                                def assay = flow.study.assays.find { it.getIdentifier() == (params.get('do') as int) }
890
891                                // perform delete
892                                if (assay) flow.study.deleteAssay( assay )
893                        }.to "assays"
894                        on("previous") {
895                                // handle form data
896                                assayPage(flow, flash, params)
897
898                                // ignore errors
899                                flash.wizardErrors = [:]
900
901                                success()
902                        }.to "samples"
903                        on("next") {
904                                // handle form data
905                                assayPage(flow, flash, params) ? success() : error()
906                        }.to "assayNext"
907                        on("quickSave") {
908                                // handle form data
909                                assayPage(flow, flash, params) ? success() : error()
910                        }.to "save"
911                        on("toPageOne") {
912                                assayPage(flow, flash, params) ? success() : error()
913                        }.to "study"
914                        on("toPageTwo") {
915                                assayPage(flow, flash, params) ? success() : error()
916                        }.to "subjects"
917                        on("toPageThree") {
918                                assayPage(flow, flash, params) ? success() : error()
919                        }.to "events"
920                        on("toPageFour") {
921                                assayPage(flow, flash, params) ? success() : error()
922                        }.to "samples"
923                        on("toPageSix") {
924                                assayPage(flow, flash, params) ? success() : error()
925                        }.to "confirm"
926                        on("toPageSeven") {
927                                assayPage(flow, flash, params) ? success() : error()
928                        }.to "save"
929                }
930
931                // assayNext
932                assayNext {
933                        action {
934                                // Grom a development message
935                                if (pluginManager.getGrailsPlugin('grom')) "entering assayNext".grom()
936
937                                // have we got samples and assays?
938                                if (flow.study.assays && flow.study.samples) {
939                                        // yes, go to the group page
940                                        toAssayGroups()
941                                } else {
942                                        // no need to show the group page as
943                                        // there's nothing to group
944                                        toConfirm()
945                                }
946                        }
947                        on("toAssayGroups").to "assayGroups"
948                        on("toConfirm").to "confirm"
949                }
950
951                // assay grouping page
952                assayGroups {
953                        render(view: "_assay_groups")
954                        onRender {
955                                // Grom a development message
956                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_assay_groups.gsp".grom()
957
958                                flow.page = 5
959                        }
960                        on("previous") {
961                                // handle form data
962                                assayGroupPage(flow, flash, params)
963
964                                // ignore errors
965                                flash.wizardErrors = [:]
966
967                                success()
968                        }.to "assays"
969                        on("next") {
970                                // handle form data
971                                assayGroupPage(flow, flash, params) ? success() : error()
972                        }.to "confirm"
973                        on("quickSave") {
974                                // handle form data
975                                assayGroupPage(flow, flash, params) ? success() : error()
976                        }.to "save"
977                        on("toPageOne") {
978                                assayGroupPage(flow, flash, params) ? success() : error()
979                        }.to "study"
980                        on("toPageTwo") {
981                                assayGroupPage(flow, flash, params) ? success() : error()
982                        }.to "subjects"
983                        on("toPageThree") {
984                                assayGroupPage(flow, flash, params) ? success() : error()
985                        }.to "events"
986                        on("toPageFour") {
987                                assayGroupPage(flow, flash, params) ? success() : error()
988                        }.to "samples"
989                        on("toPageSix") {
990                                assayGroupPage(flow, flash, params) ? success() : error()
991                        }.to "confirm"
992                        on("toPageSeven") {
993                                assayGroupPage(flow, flash, params) ? success() : error()
994                        }.to "save"
995                }
996
997                // confirm Previous
998                confirmPrevious {
999                        action {
1000                                // Grom a development message
1001                                if (pluginManager.getGrailsPlugin('grom')) "entering confirmPrevious".grom()
1002
1003                                // have we got samples and assays?
1004                                if (flow.study.assays && flow.study.samples) {
1005                                        // yes, go to the group page
1006                                        toAssayGroups()
1007                                } else {
1008                                        // no need to show the group page as
1009                                        // there's nothing to group
1010                                        toAssays()
1011                                }
1012                        }
1013                        on("toAssayGroups").to "assayGroups"
1014                        on("toAssays").to "assays"
1015                }
1016
1017                // confirmation
1018                confirm {
1019                        render(view: "_confirmation")
1020                        onRender {
1021                                // Grom a development message
1022                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_confirmation.gsp".grom()
1023
1024                                flow.page = 6
1025                        }
1026                        on("toStudy").to "study"
1027                        on("toSubjects").to "subjects"
1028                        on("toEvents").to "events"
1029                        on("toGroups").to "groups"
1030                        on("toSamples").to "samples"
1031                        on("toAssays").to "assays"
1032                        on("toAssayGroups").to "assayGroups"
1033                        on("previous").to "confirmPrevious"
1034                        on("next").to "save"
1035                        on("quickSave").to "save"
1036                        on("toPageOne").to "study"
1037                        on("toPageTwo").to "subjects"
1038                        on("toPageThree").to "events"
1039                        on("toPageFour").to "samples"
1040                        on("toPageFive").to "assays"
1041                        on("toPageSeven").to "save"
1042                }
1043
1044                // store all study data
1045                save {
1046                        action {
1047                                // Grom a development message
1048                                if (pluginManager.getGrailsPlugin('grom')) "entering save".grom()
1049
1050                                flow.page = 7
1051                                flash.wizardErrors = [:]
1052
1053                                // persist data to the database
1054                                try {
1055                                        // save study
1056                                        // Grom a development message
1057                                        if (pluginManager.getGrailsPlugin('grom')) "saving study".grom()
1058
1059                                        // Make sure the owner of the study is set right
1060                                        if (!flow.study.owner) {
1061                                                flow.study.owner = authenticationService.getLoggedInUser()
1062                                        }
1063
1064                                        if (!flow.study.save(flush:true)) {
1065                                                this.appendErrors(flow.study, flash.wizardErrors)
1066                                                throw new Exception('error saving study')
1067                                        }
1068                                        log.info ".saved study "+flow.study+" (id: "+flow.study.id+")"
1069
1070                                        success()
1071                                } catch (Exception e) {
1072                                        // rollback
1073                                        this.appendErrorMap(['exception': e.toString() + ', see log for stacktrace' ], flash.wizardErrors)
1074
1075                                        // stacktrace in flash scope
1076                                        flash.debug = e.getStackTrace()
1077
1078                                        error()
1079                                }
1080                        }
1081                        on("error").to "error"
1082                        on(Exception).to "error"
1083                        on("success").to "done"
1084                }
1085
1086                // error storing data
1087                error {
1088                        render(view: "_error")
1089                        onRender {
1090                                // Grom a development message
1091                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_error.gsp".grom()
1092
1093                                flow.page = 6
1094                        }
1095                        on("next").to "save"
1096                        on("previous").to "samples"
1097                        on("toPageOne").to "study"
1098                        on("toPageTwo").to "subjects"
1099                        on("toPageThree").to "events"
1100                        on("toPageFour").to "samples"
1101                        on("toPageFive").to "assays"
1102                        on("toPageSix").to "confirm"
1103                        on("toPageSeven").to "save"
1104                }
1105
1106                // render finish page
1107                done {
1108                        render(view: "_done")
1109                        onRender {
1110                                // Grom a development message
1111                                if (pluginManager.getGrailsPlugin('grom')) "rendering the partial: pages/_done.gsp".grom()
1112
1113                                flow.page = 7
1114                        }
1115                        onEnd {
1116                                // clean flow scope
1117                                flow.clear()
1118                        }
1119                }
1120        }
1121
1122        /**
1123         * load a study
1124         * @param Map LocalAttributeMap (the flow scope)
1125         * @param Map localAttributeMap (the flash scope)
1126         * @param Map GrailsParameterMap (the flow parameters = form data)
1127         * @returns boolean
1128         */
1129        def loadStudy(flow, flash, params, user) {
1130                flash.wizardErrors      = [:]
1131
1132                // load study
1133                try {
1134                        // load study
1135                        def study = (params.studyid) ? Study.findById( params.studyid ) : Study.findByTitle( params.study )
1136
1137                        // Check whether the user is allowed to edit this study. If it is not allowed
1138                        // the used should had never seen a link to this page, so he should never get
1139                        // here. That's why we just return false
1140            if (!study.canWrite(user)){
1141                                return false
1142                        }
1143
1144                        // store study in the flowscope
1145                        flow.study = study
1146
1147                        // set 'quicksave' variable
1148                        flow.quickSave = true
1149
1150                        return true
1151                } catch (Exception e) {
1152                        // rollback
1153                        this.appendErrorMap(['exception': e.getMessage() + ', see log for stacktrace'], flash.wizardErrors)
1154
1155                        return false
1156                }
1157        }
1158
1159        /**
1160         * Handle the wizard study page
1161         *
1162         * @param Map LocalAttributeMap (the flow scope)
1163         * @param Map localAttributeMap (the flash scope)
1164         * @param Map GrailsParameterMap (the flow parameters = form data)
1165         * @returns boolean
1166         */
1167        def studyPage(flow, flash, params) {
1168                flash.values            = params
1169                flash.wizardErrors      = [:]
1170
1171                // instantiate study of it is not yet present
1172                if (!flow.study) flow.study = new Study()
1173
1174                // did the study template change?
1175                if (params.get('template').size() && flow.study.template?.name != params.get('template')) {
1176                        // set the template
1177                        flow.study.template = Template.findByName(params.remove('template'))
1178                }
1179
1180                // does the study have a template set?
1181                if (flow.study.template && flow.study.template instanceof Template) {
1182                        // yes, iterate through template fields
1183                        flow.study.giveFields().each() {
1184                                // and set their values
1185                                flow.study.setFieldValue(it.name, params.get(it.escapedName()))
1186                        }
1187                }
1188
1189                // handle publications
1190                handlePublications(flow, flash, params)
1191
1192                // handle contacts
1193                handleContacts(flow, flash, params)
1194
1195                // handle users (readers, writers)
1196                handleUsers(flow, flash, params, 'readers')
1197                handleUsers(flow, flash, params, 'writers')
1198
1199                // handle public checkbox
1200                if (params.get("publicstudy")) {
1201                        flow.study.publicstudy = params.get("publicstudy")
1202                }
1203
1204                // have we got a template?
1205                if (flow.study.template && flow.study.template instanceof Template) {
1206                        // validate the study
1207                        if (flow.study.validate()) {
1208                                // instance is okay
1209                                return true
1210                        } else {
1211                                // validation failed
1212                                this.appendErrors(flow.study, flash.wizardErrors)
1213                                return false
1214                        }
1215                } else {
1216                        // no, return an error that the template is not set
1217                        this.appendErrorMap(['template': g.message(code: 'select.not.selected.or.add', args: ['template'])], flash.wizardErrors)
1218                        return false
1219                }
1220        }
1221
1222        /**
1223         * re-usable code for handling publications form data in a web flow
1224         * @param Map LocalAttributeMap (the flow scope)
1225         * @param Map localAttributeMap (the flash scope)
1226         * @param Map GrailsParameterMap (the flow parameters = form data)
1227         * @returns boolean
1228         */
1229        def handlePublications(flow, flash, params) {
1230                flash.wizardErrors      = [:]
1231
1232                if (!flow.study.publications) flow.study.publications = []
1233
1234                // Check the ids of the pubblications that should be attached
1235                // to this study. If they are already attached, keep 'm. If
1236                // studies are attached that are not in the selected (i.e. the
1237                // user deleted them), remove them
1238                def publicationIDs = params.get('publication_ids')
1239                if (publicationIDs) {
1240                        // Find the individual IDs and make integers
1241                        publicationIDs = publicationIDs.split(',').collect { Integer.parseInt(it, 10) }
1242
1243                        // First remove the publication that are not present in the array
1244                        flow.study.publications.removeAll { publication -> !publicationIDs.find { id -> id == publication.id } }
1245
1246                        // Add those publications not yet present in the database
1247                        publicationIDs.each { id ->
1248                                if (!flow.study.publications.find { publication -> id == publication.id }) {
1249                                        def publication = Publication.get(id)
1250                                        if (publication) {
1251                                                flow.study.addToPublications(publication)
1252                                        } else {
1253                                                log.info('.publication with ID ' + id + ' not found in database.')
1254                                        }
1255                                }
1256                        }
1257
1258                } else {
1259                        log.info('.no publications selected.')
1260                        flow.study.publications.clear()
1261                }
1262
1263        }
1264
1265        /**
1266         * re-usable code for handling contacts form data in a web flow
1267         * @param Map LocalAttributeMap (the flow scope)
1268         * @param Map localAttributeMap (the flash scope)
1269         * @param Map GrailsParameterMap (the flow parameters = form data)
1270         * @return boolean
1271         */
1272        def handleContacts(flow, flash, params) {
1273                flash.wizardErrors      = [:]
1274
1275                if (!flow.study.persons) flow.study.persons = []
1276
1277                // Check the ids of the contacts that should be attached
1278                // to this study. If they are already attached, keep 'm. If
1279                // studies are attached that are not in the selected (i.e. the
1280                // user deleted them), remove them
1281
1282                // Contacts are saved as [person_id]-[role_id]
1283                def contactIDs = params.get('contacts_ids')
1284                if (contactIDs) {
1285                        // Find the individual IDs and make integers
1286                        contactIDs = contactIDs.split(',').collect {
1287                                def parts = it.split('-')
1288                                return [person: Integer.parseInt(parts[0]), role: Integer.parseInt(parts[1])]
1289                        }
1290
1291                        // First remove the contacts that are not present in the array
1292                        flow.study.persons.removeAll {
1293                                studyperson -> !contactIDs.find { ids -> (ids.person == studyperson.person.id) && (ids.role == studyperson.role.id) }
1294                        }
1295
1296                        // Add those contacts not yet present in the database
1297                        contactIDs.each { ids ->
1298                                if (!flow.study.persons.find { studyperson -> (ids.person == studyperson.person.id) && (ids.role == studyperson.role.id) }) {
1299                                        def person = Person.get(ids.person)
1300                                        def role = PersonRole.get(ids.role)
1301                                        if (person && role) {
1302                                                // Find a studyperson object with these parameters
1303                                                def studyPerson = StudyPerson.findAll().find { studyperson -> studyperson.person.id == person.id && studyperson.role.id == role.id }
1304
1305                                                // If if does not yet exist, save the example
1306                                                if (!studyPerson) {
1307                                                        studyPerson = new StudyPerson(
1308                                                                person: person,
1309                                                                role: role
1310                                                        )
1311                                                        studyPerson.save(flush: true)
1312                                                }
1313
1314                                                flow.study.addToPersons(studyPerson)
1315                                        } else {
1316                                                log.info('.person ' + ids.person + ' or Role ' + ids.role + ' not found in database.')
1317                                        }
1318                                }
1319                        }
1320                } else {
1321                        log.info('.no persons selected.')
1322                        flow.study.persons.clear()
1323                }
1324
1325        }
1326
1327        /**
1328         * re-usable code for handling contacts form data in a web flow
1329         * @param Map LocalAttributeMap (the flow scope)
1330         * @param Map localAttributeMap (the flash scope)
1331         * @param Map GrailsParameterMap (the flow parameters = form data)
1332         * @param String    'readers' or 'writers'
1333         * @return boolean
1334         */
1335        def handleUsers(flow, flash, params, type) {
1336                flash.wizardErrors = [:]
1337
1338                def users = []
1339
1340                if (type == "readers" && flow.study.readers ) {
1341                        users += flow.study.readers
1342                } else if (type == "writers" && flow.study.writers ) {
1343                        users += flow.study.writers
1344                }
1345
1346                // Check the ids of the contacts that should be attached
1347                // to this study. If they are already attached, keep 'm. If
1348                // studies are attached that are not in the selected (i.e. the
1349                // user deleted them), remove them
1350
1351                // Users are saved as user_id
1352                def userIDs = params.get(type + '_ids')
1353                if (userIDs) {
1354                        // Find the individual IDs and make integers
1355                        userIDs = userIDs.split(',').collect { Integer.parseInt(it, 10) }
1356
1357                        // First remove the publication that are not present in the array
1358                        users.removeAll { user -> !userIDs.find { id -> id == user.id } }
1359
1360                        // Add those publications not yet present in the database
1361                        userIDs.each { id ->
1362                                if (!users.find { user -> id == user.id }) {
1363                                        def user = SecUser.get(id)
1364                                        if (user) {
1365                                                users.add(user)
1366                                        } else {
1367                                                log.info('.user with ID ' + id + ' not found in database.')
1368                                        }
1369                                }
1370                        }
1371
1372                } else {
1373                        log.info('.no users selected.')
1374                        users.clear()
1375                }
1376
1377                if (type == "readers") {
1378                        if (flow.study.readers)
1379                                flow.study.readers.clear()
1380                        users.each { flow.study.addToReaders(it) }
1381                } else if (type == "writers") {
1382                        if (flow.study.writers)
1383                                flow.study.writers.clear()
1384
1385                        users.each { flow.study.addToWriters(it) }
1386                }
1387        }
1388
1389        /**
1390         * Handle the wizard subject page
1391         *
1392         * @param Map LocalAttributeMap (the flow scope)
1393         * @param Map localAttributeMap (the flash scope)
1394         * @param Map GrailsParameterMap (the flow parameters = form data)
1395         * @returns boolean
1396         */
1397        def subjectPage(flow, flash, params) {
1398                def errors = false
1399                flash.wizardErrors = [:]
1400
1401                // remember the params in the flash scope
1402                flash.values = params
1403
1404                // iterate through subjects
1405                flow.study.subjects.each() { subject ->
1406                        // iterate through (template and domain) fields
1407                        subject.giveFields().each() { field ->
1408                                // set field
1409                                subject.setFieldValue(
1410                                        field.name,
1411                                        params.get('subject_' + subject.getIdentifier() + '_' + field.escapedName())
1412                                )
1413                        }
1414
1415                        // validate subject
1416                        if (!subject.validate()) {
1417                                errors = true
1418                                this.appendErrors(subject, flash.wizardErrors, 'subject_' + subject.getIdentifier() + '_')
1419                        }
1420                }
1421
1422                return !errors
1423        }
1424
1425        /**
1426         * Add a number of subjects to a study
1427         *
1428         * required params entities:
1429         * -addNumber (int)
1430         * -species   (string)
1431         * -template  (string)
1432         *
1433         * @param Map LocalAttributeMap (the flow scope)
1434         * @param Map localAttributeMap (the flash scope)
1435         * @param Map GrailsParameterMap (the flow parameters = form data)
1436         * @returns boolean
1437         */
1438        def addSubjects(flow, flash, params) {
1439                // remember the params in the flash scope
1440                flash.values = params
1441
1442                // handle the subject page
1443                subjectPage(flow, flash, params)
1444
1445                // (re)set error message
1446                flash.wizardErrors = [:]
1447
1448                // set work variables
1449                def errors              = false
1450                def number              = params.get('addNumber') as int
1451                def species             = Term.findByName(params.get('species'))
1452                def template    = Template.findByName(params.get('template'))
1453
1454                // can we add subjects?
1455                if (number > 0 && species && template) {
1456                        // add subjects to study
1457                        number.times {
1458                                // work variables
1459                                def subjectName = 'Subject '
1460                                def subjectIterator = 1
1461                                def tempSubjectName = subjectName + subjectIterator
1462
1463                                // make sure subject name is unique
1464                                if (flow.study.subjects) {
1465                                        while (flow.study.subjects.find { it.name == tempSubjectName }) {
1466                                                subjectIterator++
1467                                                tempSubjectName = subjectName + subjectIterator
1468                                        }
1469                                }
1470                                subjectName = tempSubjectName
1471
1472                                // create a subject instance
1473                                def subject = new Subject(
1474                                        name            : subjectName,
1475                                        species         : species,
1476                                        template        : template
1477                                )
1478
1479                                // add it to the study
1480                                flow.study.addToSubjects( subject )
1481                        }
1482                } else {
1483                        // add feedback
1484                        errors = true
1485                        if (number < 1) this.appendErrorMap(['addNumber': 'Enter a positive number of subjects to add'], flash.wizardErrors)
1486                        if (!species)   this.appendErrorMap(['species': g.message(code: 'select.not.selected.or.add', args: ['species'])], flash.wizardErrors)
1487                        if (!template)  this.appendErrorMap(['template': g.message(code: 'select.not.selected.or.add', args: ['template'])], flash.wizardErrors)
1488                }
1489
1490                return !errors
1491        }
1492
1493        /**
1494         * Handle the wizard event page
1495         *
1496         * @param Map LocalAttributeMap (the flow scope)
1497         * @param Map localAttributeMap (the flash scope)
1498         * @param Map GrailsParameterMap (the flow parameters = form data)
1499         * @returns boolean
1500         */
1501        def eventPage(flow, flash, params) {
1502                def errors = false
1503                flash.wizardErrors = [:]
1504
1505                // remember the params in the flash scope
1506                flash.values = params
1507
1508                // handle the 'add event' form
1509                if (flow.event) {
1510                        flow.event.giveFields().each() { field ->
1511                                // set field
1512                                flow.event.setFieldValue(
1513                                        field.name,
1514                                        params.get(field.escapedName())
1515                                )
1516                        }
1517                }
1518
1519                // handle the eventGroup names and grouping
1520                def name        = ""
1521                def tempName= ""
1522                flow.study.eventGroups.each() { eventGroup ->
1523                        // iterate through templates
1524                        flow.study.giveAllEventTemplates().each() { template ->
1525                                tempName = params.get( 'eventGroup_' + eventGroup.getIdentifier() + '_' + template.getIdentifier() )
1526
1527                                // is the name different?
1528                                if (tempName != eventGroup.name) {
1529                                        name = tempName
1530                                }
1531                        }
1532
1533                        // should the name change?
1534                        if (name) {
1535                                // yes, change it
1536                                eventGroup.name = name
1537                                name = ""
1538                        }
1539
1540                        // handle eventGrouping
1541                        ( ((flow.study.events) ? flow.study.events : []) + ((flow.study.samplingEvents) ? flow.study.samplingEvents : []) ) .each() { event ->
1542                                if (params.get( 'event_' + event.getIdentifier() + '_group_' + eventGroup.getIdentifier() )) {
1543                                        // add to eventGroup
1544                                        if (event instanceof SamplingEvent) {
1545                                                // check if we are already in this eventGroup
1546                                                if (!eventGroup.samplingEvents.find { it.equals(event) }) {
1547                                                        // no, add it
1548                                                        eventGroup.addToSamplingEvents(event)
1549
1550                                                        // iterate through subjects for this eventGroup
1551                                                        eventGroup.subjects.each() { subject ->
1552                                                                // instantiate a sample for this subject / event
1553                                                                def samplingEventName = ucwords(event.template.name)
1554                                                                def eventGroupName = ucwords(eventGroup.name).replaceAll("([ ]{1,})", "")
1555                                                                def sampleName = (ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(event.startTime).toString()).replaceAll("([ ]{1,})", "")
1556                                                                def tempSampleIterator = 0
1557                                                                def tempSampleName = sampleName
1558
1559                                                                // make sure sampleName is unique
1560                                                                if (flow.study.samples) {
1561                                                                        while (flow.study.samples.find { it.name == tempSampleName }) {
1562                                                                                tempSampleIterator++
1563                                                                                tempSampleName = sampleName + "_" + tempSampleIterator
1564                                                                        }
1565                                                                        sampleName = tempSampleName
1566                                                                }
1567
1568                                                                // instantiate a sample
1569                                                                flow.study.addToSamples(
1570                                                                        new Sample(
1571                                                                                parentSubject   : subject,
1572                                                                                parentEvent             : event,
1573                                                                                parentEventGroup: eventGroup,
1574                                                                                name                    : sampleName,
1575                                                                                template                : (event.sampleTemplate) ? event.sampleTemplate : ''
1576                                                                        )
1577                                                                )
1578                                                        }
1579                                                }
1580                                        } else {
1581                                                eventGroup.addToEvents(event)
1582                                        }
1583                                } else {
1584                                        // remove from eventGroup
1585                                        if (event instanceof SamplingEvent) {
1586                                                // iterate through subjects (if we have them)
1587                                                eventGroup.subjects.each() { subject ->
1588                                                        // find all samples for this subject / event
1589                                                        flow.study.samples.findAll { (it.parentEvent.equals(event) && it.parentSubject.equals(subject) ) }.each() {
1590                                                                // delete this sample
1591                                                                flow.study.deleteSample( it )
1592                                                        }
1593                                                }
1594
1595                                                eventGroup.removeFromSamplingEvents(event)
1596                                        } else {
1597                                                eventGroup.removeFromEvents(event)
1598                                        }
1599                                }
1600                        }
1601                }
1602
1603                // handle the (sampling) events
1604                ( ((flow.study.events) ? flow.study.events : []) + ((flow.study.samplingEvents) ? flow.study.samplingEvents : []) ) .each() { event ->
1605                        event.giveFields().each() { field ->
1606                                event.setFieldValue(
1607                                        field.name,
1608                                        params.get( 'event_' + event.getIdentifier() + '_' + field.escapedName() )
1609                                )
1610                        }
1611
1612                        // validate event
1613                        if (!event.validate()) {
1614                                errors = true
1615                                this.appendErrors(event, flash.wizardErrors)
1616                        }
1617                }
1618
1619                return !errors
1620        }
1621
1622        /**
1623         * Handle the wizard group page
1624         *
1625         * @param Map LocalAttributeMap (the flow scope)
1626         * @param Map localAttributeMap (the flash scope)
1627         * @param Map GrailsParameterMap (the flow parameters = form data)
1628         * @returns boolean
1629         */
1630        def groupPage(flow, flash, params) {
1631                def errors = false
1632                flash.wizardErrors = [:]
1633
1634                // remember the params in the flash scope
1635                flash.values = params
1636
1637                // iterate through groups
1638                flow.study.eventGroups.each() { eventGroup ->
1639                        // iterate through subjects
1640                        flow.study.subjects.each() { subject ->
1641                                if (params.get('subject_' + subject.getIdentifier() + '_group_' + eventGroup.getIdentifier() )) {
1642                                        // check if this subject is already part of this eventGroup
1643                                        if ( !eventGroup.subjects.find { it.equals(subject) } ) {
1644                                                // add to eventGroup
1645                                                eventGroup.addToSubjects(subject)
1646
1647                                                // iterate through samplingEvents
1648                                                eventGroup.samplingEvents.each() { samplingEvent ->
1649                                                        def samplingEventName = ucwords(samplingEvent.template.name)
1650                                                        def eventGroupName = ucwords(eventGroup.name)
1651                                                        def sampleName = (ucwords(subject.name) + '_' + samplingEventName + '_' + eventGroupName + '_' + new RelTime(samplingEvent.startTime).toString()).replaceAll("([ ]{1,})", "")
1652                                                        def tempSampleIterator = 0
1653                                                        def tempSampleName = sampleName
1654
1655                                                        // make sure sampleName is unique
1656                                                        if (flow.study.samples) {
1657                                                                while (flow.study.samples.find { it.name == tempSampleName }) {
1658                                                                        tempSampleIterator++
1659                                                                        tempSampleName = sampleName + "_" + tempSampleIterator
1660                                                                }
1661                                                                sampleName = tempSampleName
1662                                                        }
1663
1664                                                        // instantiate a sample
1665                                                        flow.study.addToSamples(
1666                                                                new Sample(
1667                                                                        parentSubject   : subject,
1668                                                                        parentEvent             : samplingEvent,
1669                                                                        parentEventGroup: eventGroup,
1670                                                                        name                    : sampleName,
1671                                                                        template                : (samplingEvent.sampleTemplate) ? samplingEvent.sampleTemplate : ''
1672                                                                )
1673                                                        )
1674                                                }
1675                                        } else {
1676                                        }
1677                                } else {
1678                                        // check if this subject is a member of this eventGroup
1679                                        if (eventGroup.subjects.find { it.equals(subject) }) {
1680                                                // remove from eventGroup
1681                                                eventGroup.removeFromSubjects(subject)
1682
1683                                                // iterate through samplingEvents
1684                                                eventGroup.samplingEvents.each() { samplingEvent ->
1685                                                        flow.study.samples.findAll { (it.parentEvent.equals(samplingEvent) && it.parentSubject.equals(subject) && it.parentEventGroup.equals(eventGroup)) }.each() {
1686                                                                // delete this sample
1687                                                                flow.study.deleteSample( it )
1688                                                        }
1689                                                }
1690                                        }
1691                                }
1692                        }
1693                }
1694        }
1695
1696        /**
1697         * Handle the wizard samples page
1698         *
1699         * @param Map LocalAttributeMap (the flow scope)
1700         * @param Map localAttributeMap (the flash scope)
1701         * @param Map GrailsParameterMap (the flow parameters = form data)
1702         * @returns boolean
1703         */
1704        def samplePage(flow, flash, params) {
1705                def errors = false
1706                flash.wizardErrors = [:]
1707
1708                // remember the params in the flash scope
1709                flash.values = params
1710
1711                // iterate through samples
1712                flow.study.samples.each() { sample ->
1713                        // iterate through sample fields
1714                        sample.giveFields().each() { field ->
1715                                def value = params.get('sample_'+sample.getIdentifier()+'_'+field.escapedName())
1716
1717                                // set field value
1718                                if (!(field.name == 'name' && !value)) {
1719                                        log.info "setting "+field.name+" to "+value
1720                                        sample.setFieldValue(field.name, value)
1721                                }
1722                        }
1723
1724                        // has the template changed?
1725                        def templateName = params.get('template_' + sample.getIdentifier())
1726                        if (templateName && sample.template?.name != templateName) {
1727                                sample.template = Template.findByName(templateName)
1728                        }
1729
1730                        // validate sample
1731                        if (!sample.validate()) {
1732                                errors = true
1733                                this.appendErrors(sample, flash.wizardErrors, 'sample_' + sample.getIdentifier() + '_' )
1734                                log.info 'error-> sample_'+sample.getIdentifier()
1735                        }
1736                }
1737
1738                return !errors
1739        }
1740
1741        /**
1742         * Handle the wizard assays page
1743         *
1744         * @param Map LocalAttributeMap (the flow scope)
1745         * @param Map localAttributeMap (the flash scope)
1746         * @param Map GrailsParameterMap (the flow parameters = form data)
1747         * @returns boolean
1748         */
1749        def assayPage(flow, flash, params) {
1750                def errors = false
1751                flash.wizardErrors = [:]
1752
1753                // remember the params in the flash scope
1754                flash.values = params
1755
1756                // handle the 'add assay' form
1757                if (flow.assay) {
1758                        flow.assay.giveFields().each() { field ->
1759                                // set field
1760                                flow.assay.setFieldValue(
1761                                        field.name,
1762                                        params.get(field.escapedName())
1763                                )
1764                        }
1765                }
1766
1767                // handle the assay data
1768                flow.study.assays.each() { assay ->
1769                        // set data
1770                        assay.giveFields().each() { field ->
1771                                assay.setFieldValue(
1772                                        field.name,
1773                                        params.get( 'assay_' + assay.getIdentifier() + '_' + field.escapedName() )
1774                                )
1775                        }
1776
1777                        // validate assay
1778                        if (!assay.validate()) {
1779                                errors = true
1780                                this.appendErrors(assay, flash.wizardErrors, 'assay_' + assay.getIdentifier() + '_')
1781                        }
1782                }
1783
1784                return !errors
1785        }
1786
1787        /**
1788         * Handle the wizard assayGroups page
1789         *
1790         * @param Map LocalAttributeMap (the flow scope)
1791         * @param Map localAttributeMap (the flash scope)
1792         * @param Map GrailsParameterMap (the flow parameters = form data)
1793         * @returns boolean
1794         */
1795        def assayGroupPage(flow, flash, params) {
1796                def errors = false
1797                flash.wizardErrors = [:]
1798
1799                // remember the params in the flash scope
1800                flash.values = params
1801
1802                // iterate through samples
1803                flow.study.samples.each() { sample ->
1804                        // iterate through assays
1805                        flow.study.assays.each() { assay ->
1806                                if (params.get( 'sample_' + sample.getIdentifier() + '_assay_' + assay.getIdentifier() )) {
1807                                        // add sample to assay
1808                                        assay.addToSamples( sample )
1809                                } else {
1810                                        // remove sample from assay
1811                                        assay.removeFromSamples( sample )
1812                                }
1813                        }
1814                }
1815
1816                return !errors
1817        }
1818
1819        /**
1820         * groovy / java equivalent of php's ucwords function
1821         *
1822         * Capitalize all first letters of separate words
1823         *
1824         * @param String
1825         * @return String
1826         */
1827        public static ucwords(String text) {
1828                def newText = ''
1829
1830                // change case to lowercase
1831                text = text.toLowerCase()
1832
1833                // iterate through words
1834                text.split(" ").each() {
1835                        newText += it[0].toUpperCase() + it.substring(1) + " "
1836                }
1837
1838                return newText.substring(0, newText.size()-1)
1839        }
1840
1841        /**
1842         * return the object from a map of objects by searching for a name
1843         * @param String name
1844         * @param Map map of objects
1845         * @return Object
1846         */
1847        def getObjectByName(name, map) {
1848                def result = null
1849                map.each() {
1850                        if (it.name == name) {
1851                                result = it
1852                        }
1853                }
1854
1855                return result
1856        }
1857
1858        /**
1859         * transform domain class validation errors into a human readable
1860         * linked hash map
1861         * @param object validated domain class
1862         * @return object  linkedHashMap
1863         */
1864        def getHumanReadableErrors(object) {
1865                def errors = [:]
1866                object.errors.getAllErrors().each() { error ->
1867                        // error.codes.each() { code -> println code }
1868
1869                        // generally speaking g.message(...) should work,
1870                        // however it fails in some steps of the wizard
1871                        // (add event, add assay, etc) so g is not always
1872                        // availably. Using our own instance of the
1873                        // validationTagLib instead so it is always
1874                        // available to us
1875                        errors[ error.getArguments()[0] ] = validationTagLib.message(error: error)
1876                }
1877
1878                return errors
1879        }
1880
1881        /**
1882         * append errors of a particular object to a map
1883         * @param object
1884         * @param map linkedHashMap
1885         * @void
1886         */
1887        def appendErrors(object, map) {
1888                this.appendErrorMap(getHumanReadableErrors(object), map)
1889        }
1890
1891        def appendErrors(object, map, prepend) {
1892                this.appendErrorMap(getHumanReadableErrors(object), map, prepend)
1893        }
1894
1895        /**
1896         * append errors of one map to another map
1897         * @param map linkedHashMap
1898         * @param map linkedHashMap
1899         * @void
1900         */
1901        def appendErrorMap(map, mapToExtend) {
1902                map.each() {key, value ->
1903                        mapToExtend[key] = ['key': key, 'value': value, 'dynamic': false]
1904                }
1905        }
1906
1907        def appendErrorMap(map, mapToExtend, prepend) {
1908                map.each() {key, value ->
1909                        mapToExtend[prepend + key] = ['key': key, 'value': value, 'dynamic': true]
1910                }
1911        }
1912
1913        /**
1914         * Parses a RelTime string and returns a nice human readable string
1915         *
1916         * @return Human Readable string or a HTTP response code 400 on error
1917         */
1918        def ajaxParseRelTime = {
1919                if (params.reltime == null) {
1920                        response.status = 400
1921                        render('reltime parameter is expected')
1922                }
1923
1924                try {
1925                        def reltime = RelTime.parseRelTime(params.reltime)
1926                        render reltime.toPrettyString()
1927                } catch (IllegalArgumentException e) {
1928                        response.status = 400
1929                        render(e.getMessage())
1930                }
1931        }
1932
1933        /**
1934         * Proxy for searching PubMed articles (or other articles from the Entrez DB).
1935         *
1936         * This proxy is needed because it is not allowed to fetch XML directly from a different
1937         * domain using javascript. So we have the javascript call a function on our own domain
1938         * and the proxy will fetch the data from Entrez
1939         *
1940         * @since       20100609
1941         * @param       _utility        The name of the utility, without the complete path. Example: 'esearch.fcgi'
1942         * @return      XML
1943         */
1944        def entrezProxy = {
1945                // Remove unnecessary parameters
1946                params.remove( "action" )
1947                params.remove( "controller" )
1948
1949                def url = "http://eutils.ncbi.nlm.nih.gov/entrez/eutils";
1950                def util = params.remove( "_utility" )
1951                def paramString = params.collect { k, v -> k + '=' + v.encodeAsURL() }.join( '&' );
1952
1953                def fullUrl = url + '/' + util + '?' + paramString;
1954
1955                // Return the output of the request
1956                // render fullUrl;
1957                render(
1958                    text:           new URL( fullUrl ).getText(),
1959                    contentType:    "text/xml",
1960                    encoding:       "UTF-8"
1961                );
1962        }
1963}
Note: See TracBrowser for help on using the browser.