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

Last change on this file since 183 was 183, checked in by duh, 10 years ago
  • removed some debugging lines
  • Property svn:keywords set to
    Date
    Author
    Rev
File size: 5.9 KB
Line 
1package dbnp.studycapturing
2
3import dbnp.studycapturing.*
4import dbnp.data.*
5import grails.converters.*
6
7/**
8 * Wizard Controler
9 *
10 * The wizard controller handles the handeling of pages and data flow
11 * through the study capturing wizard.
12 *
13 * @author Jeroen Wesbeek
14 * @since 20100107
15 * @package studycapturing
16 *
17 * Revision information:
18 * $Rev: 183 $
19 * $Author: duh $
20 * $Date: 2010-02-09 15:46:18 +0000 (di, 09 feb 2010) $
21 */
22class WizardController {
23        /**
24         * index method, redirect to the webflow
25         * @void
26         */
27        def index = {
28                /**
29                 * Do you believe it in your head?
30                 * I can go with the flow
31                 * Don't say it doesn't matter (with the flow) matter anymore
32                 * I can go with the flow (I can go)
33                 * Do you believe it in your head?
34                 */
35                redirect(action: 'pages')
36        }
37
38        /**
39         * WebFlow definition
40         * @see http://grails.org/WebFlow
41         * @void
42         */
43        def pagesFlow = {
44                // start the flow
45                onStart {
46                        // define flow variables
47                        flow.page = 0
48                        flow.pages = [
49                                [title: 'Study'],               // study
50                                [title: 'Subjects'],    // subjects
51                                [title: 'Groups'],              // groups
52                                [title: 'Form elements demo page']
53                        ]
54
55                }
56
57                // render the main wizard page which immediately
58                // triggers the 'next' action (hence, the main
59                // page dynamically renders the study template
60                // and makes the flow jump to the study logic)
61                mainPage {
62                        render(view: "/wizard/index")
63                        onRender {
64                                flow.page = 1
65                        }
66                        on("next").to "study"
67                }
68
69                // render the study page and handle study logic
70                study {
71                        render(view: "_study")
72                        onRender {
73                                flow.page = 1
74                        }
75                        on("next") {
76                                // create date instance from date string?
77                                // @see WizardTagLibrary::dateElement{...}
78                                if (params.get('startDate')) {
79                                        params.startDate = new Date().parse("d/M/yyyy", params.get('startDate').toString())
80                                }
81
82                                // if a template is selected, get template instance
83                                if (params.get('template')) {
84                                        params.template = Template.findByName(params.get('template'))
85                                }
86
87                                // create a study instance
88                                flow.study = new Study(params)
89
90                                // validate study
91                                if (flow.study.validate()) {
92                                        success()
93                                } else {
94                                        // validation failed, feedback errors
95                                        flash.errors = new LinkedHashMap()
96                                        this.appendErrors(flow.study, flash.errors)
97                                        error()
98                                }
99                        }.to "subjects"
100                }
101
102                // render page two
103                subjects {
104                        render(view: "_subjects")
105                        onRender {
106                                flow.page = 2
107
108                                if (!flow.subjects) {
109                                        flow.subjects = []
110                                }
111                        }
112                        on("add") {
113                                // fetch species by name (as posted by the form)
114                                def speciesTerm = Term.findByName(params.addSpecies)
115
116                                // add x subject of species y
117                                (params.addNumber as int).times {
118                                        def increment = flow.subjects.size()
119                                        flow.subjects[increment] = new Subject(
120                                                name: 'Subject ' + (increment + 1),
121                                                species: speciesTerm,
122                                                template: flow.study.template
123                                        )
124                                }
125                        }.to "subjects"
126                        on("next") {
127                                flash.errors = new LinkedHashMap()
128
129                                // handle form data
130                                if (!this.handleSubjects(flow, flash, params)) {
131                                        error()
132                                } else {
133                                        success()
134                                }
135                        }.to "groups"
136                        on("previous") {
137                                flash.errors = new LinkedHashMap()
138
139                                // handle form data
140                                if (!this.handleSubjects(flow, flash, params)) {
141                                        error()
142                                } else {
143                                        success()
144                                }
145                        }.to "study"
146                }
147
148                groups {
149                        render(view: "_groups")
150                        onRender {
151                                flow.page = 3
152
153                                if (!flow.groups) {
154                                        flow.groups = []
155                                }
156                        }
157                        on("add") {
158                                def increment = flow.groups.size()
159                                flow.groups[increment] = new SubjectGroup(params)
160                        }.to "groups"
161                        on("next") {
162                                // TODO
163                        }.to "groups"
164                        on("previous") {
165                                // TODO
166                        }.to "subjects"
167                }
168
169                // render page three
170                demo {
171                        render(view: "_three")
172                        onRender {
173                                flow.page = 4
174                        }
175                        on("previous") {
176                                // TODO
177                        }.to "groups"
178                }
179        }
180
181        /**
182         * re-usable code for handling subject form data in a web flow
183         * @param Map   LocalAttributeMap (the flow scope)
184         * @param Map   localAttributeMap (the flash scope)
185         * @param Map   GrailsParameterMap (the flow parameters = form data)
186         * @returns boolean
187         */
188        def handleSubjects(flow, flash, params) {
189                if (flow.subjects.size() < 1) {
190                        return false
191                } else {
192                        def errors = false;
193                        def id = 0;
194                        flow.subjects.each() {
195                                // store subject properties
196                                it.name = params.get('subject_' + id + '_name')
197                                it.species = Term.findByName(params.get('subject_' + id + '_species'))
198
199                                // clear lists
200                                def stringList = new LinkedHashMap();
201                                def intList = new LinkedHashMap();
202
203                                // get all template fields
204                                flow.study.template.subjectFields.each() {
205                                        // get value
206                                        def value = params.get('subject_' + id + '_' + it.name);
207
208                                        if (value) {
209                                                // add to template parameters
210                                                switch (it.type) {
211                                                        case 'STRINGLIST':
212                                                                stringList[it.name] = value
213                                                                break;
214                                                        case 'INTEGER':
215                                                                intList[it.name] = value
216                                                                break;
217                                                        default:
218                                                                // unsupported type?
219                                                                println "ERROR: unsupported type: " + it.type
220                                                                break;
221                                                }
222                                        }
223                                }
224
225                                // set field data
226                                it.templateStringFields = stringList
227                                it.templateIntegerFields = intList
228
229                                // validate subject
230                                if (!it.validate()) {
231                                        errors = true
232                                        println id + ' :: ' + it.errors.getAllErrors()
233                                        this.appendErrors(it, flash.errors)
234                                }
235
236                                id++;
237                        }
238
239                        return !errors
240                }
241        }
242
243        /**
244         * transform domain class validation errors into a human readable
245         * linked hash map
246         * @param object validated domain class
247         * @returns object  linkedHashMap
248         */
249        def getHumanReadableErrors(object) {
250                def errors = new LinkedHashMap()
251
252                object.errors.getAllErrors().each() {
253                        errors[it.getArguments()[0]] = it.getDefaultMessage()
254                }
255
256                return errors
257        }
258
259        /**
260         * append errors of a particular object to a map
261         * @param object
262         * @param map linkedHashMap
263         * @void
264         */
265        def appendErrors(object, map) {
266                this.appendErrorMap(this.getHumanReadableErrors(object), map)
267        }
268
269        /**
270         * append errors of one map to another map
271         * @param map linkedHashMap
272         * @param map linkedHashMap
273         * @void
274         */
275        def appendErrorMap(map, mapToExtend) {
276                map.each() {key, value ->
277                        mapToExtend[key] = value
278                }
279        }
280}
Note: See TracBrowser for help on using the repository browser.