root/trunk/grails-app/controllers/dbnp/studycapturing/SimpleWizardController.groovy @ 1611

Revision 1611, 36.7 KB (checked in by robert@…, 3 years ago)

Improved simple study wizard

  • Property svn:keywords set to Rev Author Date
Line 
1/**
2 * SimpleWizardController Controler
3 *
4 * Description of my controller
5 *
6 * @author  your email (+name?)
7 * @since       2010mmdd
8 * @package     ???
9 *
10 * Revision information:
11 * $Rev$
12 * $Author$
13 * $Date$
14 */
15package dbnp.studycapturing
16
17import org.apache.poi.ss.usermodel.DataFormatter
18import org.dbnp.gdt.*
19import grails.plugins.springsecurity.Secured
20import dbnp.authentication.SecUser
21import dbnp.importer.ImportCell
22import dbnp.importer.ImportRecord
23import dbnp.importer.MappingColumn
24
25@Secured(['IS_AUTHENTICATED_REMEMBERED'])
26class SimpleWizardController extends StudyWizardController {
27        def authenticationService
28        def fileService
29        def importerService
30        def gdtService = new GdtService()
31
32        /**
33         * index closure
34         */
35        def index = {
36                if( params.id )
37                        redirect( action: "simpleWizard", id: params.id );
38                else
39                        redirect( action: "simpleWizard" );
40        }
41
42        def simpleWizardFlow = {
43                entry {
44                        action{
45                                flow.study = getStudyFromRequest( params )
46                                if (!flow.study) retrievalError()
47                        }
48                        on("retrievalError").to "handleError"
49                        on("success").to "study"
50                }
51
52                study {
53                        on("next") {
54                                handleStudy( flow.study, params )
55                                if( !validateObject( flow.study ) )
56                                        error()
57                        }.to "decisionState"
58                        on("refresh") { handleStudy( flow.study, params ); }.to "study"
59                        on( "success" ) { handleStudy( flow.study, params ) }.to "study"
60                }
61
62                decisionState {
63                        action {
64                                // Create data in the flow
65                                flow.templates = [
66                                                        'Sample': Template.findAllByEntity( Sample.class ),
67                                                        'Subject': Template.findAllByEntity( Subject.class ),
68                                                        'Event': Template.findAllByEntity( Event.class ),
69                                                        'SamplingEvent': Template.findAllByEntity( SamplingEvent.class )
70                                ];
71                       
72                                flow.encodedEntity = [
73                                                        'Sample': gdtService.encryptEntity( Sample.class.name ),
74                                                        'Subject': gdtService.encryptEntity( Subject.class.name ),
75                                                        'Event': gdtService.encryptEntity( Event.class.name ),
76                                                        'SamplingEvent': gdtService.encryptEntity( SamplingEvent.class.name )
77                                ]
78
79                                if (flow.study.samples)
80                                        checkStudySimplicity(flow.study) ? existingSamples() : complexStudy()
81                                else
82                                        samples()
83                        }
84                        on ("existingSamples").to "startExistingSamples"
85                        on ("complexStudy").to "complexStudy"
86                        on ("samples").to "samples"
87                }
88               
89                startExistingSamples {
90                        action {
91                                def records = importerService.getRecords( flow.study );
92                                flow.records = records
93                                flow.templateCombinations = records.templateCombination.unique()
94                                success();
95                        }
96                        on( "success" ).to "existingSamples"
97                }
98
99                existingSamples {
100                        on("next") {
101                                handleExistingSamples( flow.study, params, flow ) ? success() : error()
102                        }.to "startAssays"
103                        on("previous").to "study"
104                        on("update") {
105                                handleExistingSamples( flow.study, params, flow ) ? success() : error()
106                        }.to "samples"
107
108                        on("skip").to "startAssays"
109                }
110
111                complexStudy {
112                        on("save").to "save"
113                        on("previous").to "study"
114                }
115
116                samples {
117                        on("next") {
118                                if( !handleSamples( flow.study, params, flow ) )
119                                        return error();
120                               
121                                // Add domain fields for all entities
122                                flow.domainFields = [:]
123                               
124                                flow.templates.each {
125                                        if( it.value ) {
126                                                flow.domainFields[ it.key ] = it.value[0].entity.giveDomainFields();
127                                        }
128                                }
129                               
130                                println flow.sampleForm.template
131                        }.to "columns"
132                        on("refresh") {
133                                def filename = params.get( 'importfile' );
134               
135                                // Handle 'existing*' in front of the filename. This is put in front to make a distinction between
136                                // an already uploaded file test.txt (maybe moved to some other directory) and a newly uploaded file test.txt
137                                // still being in the temporary directory.
138                                // This import step doesn't have to make that distinction, since all files remain in the temporary directory.
139                                if( filename == 'existing*' )
140                                        filename = '';
141                                else if( filename[0..8] == 'existing*' )
142                                        filename = filename[9..-1]
143                               
144                                // Refresh the templates, since the template editor has been opened
145                                flow.templates = [
146                                                'Sample': Template.findAllByEntity( Sample.class ),
147                                                'Subject': Template.findAllByEntity( Subject.class ),
148                                                'Event': Template.findAllByEntity( Event.class ),
149                                                'SamplingEvent': Template.findAllByEntity( SamplingEvent.class )
150                                ];
151                                                                               
152                                flow.sampleForm = [ importFile: filename ]
153                        }.to "samples"
154                        on("previous").to "returnFromSamples"
155                        on("study").to "study"
156                        on("skip").to "startAssays"
157                }
158
159                returnFromSamples {
160                        action {
161                                flow.study.samples ? existingSamples() : study();
162                        }
163                        on( "existingSamples" ).to "startExistingSamples"
164                        on( "study" ).to "study"
165                }
166               
167                columns {
168                        on( "next" ) {
169                                flow.editImportedData = params.get( 'editAfterwards' ) ? true : false;
170                                handleColumns( flow.study, params, flow ) ? success() : error()
171                        }.to "checkImportedEntities"
172                        on( "previous" ).to "samples"
173                }
174               
175                checkImportedEntities {
176                        action {
177                                // Only continue to the next page if the information entered is correct
178                                if( flow.editImportedData || flow.imported.numInvalidEntities > 0 ) {
179                                        missingFields();
180                                } else {
181                                        // The import of the excel file has finished. Now delete the excelfile
182                                        if( flow.excel.filename )
183                                                fileService.delete( flow.excel.filename );
184       
185                                        flow.sampleForm = null
186       
187                                        assays();
188                                }
189                        }
190                        on( "missingFields" ).to "missingFields"
191                        on( "assays" ).to "startAssays"
192                }
193               
194                missingFields {
195                        on( "next" ) {
196                                if( !handleMissingFields( flow.study, params, flow ) ) {
197                                        return error();
198                                }
199                               
200                                // The import of the excel file has finished. Now delete the excelfile
201                                if( flow.excel.filename )
202                                        fileService.delete( flow.excel.filename );
203
204                                flow.sampleForm = null
205                               
206                                success();
207                        }.to "startAssays"
208                        on( "previous" ) {
209                                // The user goes back to the previous page, so the already imported entities
210                                // (of which some gave an error) should be removed again.
211                                // Add all samples
212                                flow.imported.data.each { record ->
213                                        record.each { entity ->
214                                                if( entity ) {
215                                                        switch( entity.class ) {
216                                                                case Sample:    flow.study.removeFromSamples( entity ); break;
217                                                                case Subject:   flow.study.removeFromSubjects( entity ); break;
218                                                                case Event:             flow.study.removeFromEvents( entity ); break;
219                                                                case SamplingEvent:     flow.study.removeFromSamplingEvents( entity ); break;
220                                                        }
221                                                }
222                                        }
223                                }
224                               
225                                success();
226                        }.to "columns"
227                }
228               
229                startAssays {
230                        action {
231                                if( !flow.assay )
232                                        flow.assay = new Assay( parent: flow.study );
233                                       
234                                success();
235                        }
236                        on( "success" ).to "assays"
237                }
238               
239                assays {
240                        on( "next" ) {
241                                handleAssays( flow.assay, params, flow );
242                                if( !validateObject( flow.assay ) )
243                                        error();
244                         }.to "overview"
245                        on( "skip" ) {
246                                // In case the user has created an assay before he clicked 'skip', it should only be kept if it
247                                // existed before this step
248                                if( flow.assay != null && !flow.assay.id ) {
249                                        flow.remove( "assay" )
250                                }
251
252                         }.to "overview"
253                        on( "previous" ).to "returnFromAssays"
254                        on("refresh") { handleAssays( flow.assay, params, flow ); success() }.to "assays"
255                }
256
257                returnFromAssays {
258                        action {
259                                flow.study.samples ? existingSamples() : samples();
260                        }
261                        on( "existingSamples" ).to "existingSamples"
262                        on( "samples" ).to "samples"
263                }
264               
265                overview {
266                        on( "save" ).to "saveStudy"
267                        on( "previous" ).to "startAssays"
268                }
269               
270                saveStudy {
271                        action {
272                                if( flow.assay && !flow.study.assays?.contains( flow.assay ) ) {
273                                        flow.study.addToAssays( flow.assay );
274                                }
275                               
276                                if( flow.study.save( flush: true ) ) {
277                                        // Make sure all samples are attached to all assays
278                                        flow.study.assays.each { assay ->
279                                                def l = []+ assay.samples;
280                                                l.each { sample ->
281                                                        if( sample )
282                                                                assay.removeFromSamples( sample );
283                                                }
284                                                assay.samples?.clear();
285               
286                                                flow.study.samples.each { sample ->
287                                                        assay.addToSamples( sample )
288                                                }
289                                        }
290                       
291                                        flash.message = "Your study is succesfully saved.";
292                                       
293                                        finish();
294                                } else {
295                                        flash.error = "An error occurred while saving your study: <br />"
296                                        flow.study.getErrors().each { flash.error += it.toString() + "<br />"}
297                                       
298                                        // Remove the assay from the study again, since it is still available
299                                        // in the session
300                                        if( flow.assay ) {
301                                                flow.study.removeFromAssays( flow.assay );
302                                                flow.assay.parent = flow.study;
303                                        }
304                                       
305                                        overview();
306                                }
307                        }
308                        on( "finish" ).to "finish"
309                        on( "overview" ).to "overview"
310                }
311               
312                finish()
313               
314                handleError{
315                        redirect action: "errorPage"
316                }
317        }
318
319        /**
320         * Retrieves the required study from the database or return an empty Study object if
321         * no id is given
322         *
323         * @param params        Request parameters with params.id being the ID of the study to be retrieved
324         * @return                      A study from the database or an empty study if no id was given
325         */
326        protected Study getStudyFromRequest( def params ) {
327                int id = params.int( "id" );
328
329                if( !id ) {
330                        return new Study( title: "New study", owner: authenticationService.getLoggedInUser() );
331                }
332
333                Study s = Study.get( id );
334
335                if( !s ) {
336                        flash.error = "No study found with given id";
337                        return null;
338                }
339                if( !s.canWrite( authenticationService.getLoggedInUser() ) ) {
340                        flash.error = "No authorization to edit this study."
341                        return null;
342                }
343
344                return s
345        }
346
347        /**
348         * Handles study input
349         * @param study         Study to update
350         * @param params        Request parameter map
351         * @return                      True if everything went OK, false otherwise. An error message is put in flash.error
352         */
353        def handleStudy( study, params ) {
354                // did the study template change?
355                if (params.get('template') && study.template?.name != params.get('template')) {
356                        // set the template
357                        study.template = Template.findByName(params.remove('template'))
358                }
359
360                // does the study have a template set?
361                if (study.template && study.template instanceof Template) {
362                        // yes, iterate through template fields
363                        study.giveFields().each() {
364                                // and set their values
365                                study.setFieldValue(it.name, params.get(it.escapedName()))
366                        }
367                }
368
369                // handle public checkbox
370                if (params.get("publicstudy")) {
371                        study.publicstudy = params.get("publicstudy")
372                }
373
374                // handle publications
375                handleStudyPublications(study, params)
376
377                // handle contacts
378                handleStudyContacts(study, params)
379
380                // handle users (readers, writers)
381                handleStudyUsers(study, params, 'readers')
382                handleStudyUsers(study, params, 'writers')
383
384                return true
385        }
386       
387        /**
388        * Handles the editing of existing samples
389        * @param study          Study to update
390        * @param params         Request parameter map
391        * @return                       True if everything went OK, false otherwise. An error message is put in flash.error
392        */
393   def handleExistingSamples( study, params, flow ) {
394           flash.validationErrors = [];
395
396           def errors = false;
397           
398           // iterate through objects; set field values and validate the object
399           def eventgroups = study.samples.parentEventGroup.findAll { it }
400           def events;
401           if( !eventgroups )
402                   events = []
403           else
404                   events = eventgroups.events?.getAt(0);
405           
406           def objects = [
407                   'Sample': study.samples,
408                   'Subject': study.samples.parentSubject.findAll { it },
409                   'SamplingEvent': study.samples.parentEvent.findAll { it },
410                   'Event': events.flatten().findAll { it }
411           ];
412           objects.each {
413                   def type = it.key;
414                   def entities = it.value;
415                   
416                   entities.each { entity ->
417                           // iterate through entity fields
418                           entity.giveFields().each() { field ->
419                                   def value = params.get( type.toLowerCase() + '_' + entity.getIdentifier() + '_' + field.escapedName())
420
421                                   // set field value; name cannot be set to an empty value
422                                   if (field.name != 'name' || value) {
423                                           log.info "setting "+field.name+" to "+value
424                                           entity.setFieldValue(field.name, value)
425                                   }
426                           }
427                           
428                           // has the template changed?
429                           def templateName = params.get(type.toLowerCase() + '_' + entity.getIdentifier() + '_template')
430                           if (templateName && entity.template?.name != templateName) {
431                                   entity.template = Template.findByName(templateName)
432                           }
433   
434                           // validate sample
435                           if (!entity.validate()) {
436                                   errors = true;
437                                   
438                                   def entityName = entity.class.name[ entity.class.name.lastIndexOf( "." ) + 1 .. -1 ]
439                                   getHumanReadableErrors( entity ).each {
440                                                flash.validationErrors << [ key: it.key, value: "(" + entityName + ") " + it.value ];
441                                   }
442                           }
443                   }
444           }
445
446           return !errors
447   }
448
449        /**
450         * Handles the upload of sample data
451         * @param study         Study to update
452         * @param params        Request parameter map
453         * @return                      True if everything went OK, false otherwise. An error message is put in flash.error
454         */
455        def handleSamples( study, params, flow ) {
456                def filename = params.get( 'importfile' );
457
458                // Handle 'existing*' in front of the filename. This is put in front to make a distinction between
459                // an already uploaded file test.txt (maybe moved to some other directory) and a newly uploaded file test.txt
460                // still being in the temporary directory.
461                // This import step doesn't have to make that distinction, since all files remain in the temporary directory.
462                if( filename == 'existing*' )
463                        filename = '';
464                else if( filename[0..8] == 'existing*' )
465                        filename = filename[9..-1]
466
467                def sampleTemplateId  = params.long( 'sample_template_id' )
468                def subjectTemplateId  = params.long( 'subject_template_id' )
469                def eventTemplateId  = params.long( 'event_template_id' )
470                def samplingEventTemplateId  = params.long( 'samplingEvent_template_id' )
471
472                // These fields have been removed from the form, so will always contain
473                // their default value. The code however remains like this for future use.
474                int sheetIndex = (params.int( 'sheetindex' ) ?: 1 )
475                int dataMatrixStart = (params.int( 'datamatrix_start' ) ?: 2 )
476                int headerRow = (params.int( 'headerrow' ) ?: 1 )
477
478                // Save form data in session
479                flow.sampleForm = [
480                                        importFile: filename,
481                                        templateId: [
482                                                'Sample': sampleTemplateId,
483                                                'Subject': subjectTemplateId,
484                                                'Event': eventTemplateId,
485                                                'SamplingEvent': samplingEventTemplateId
486                                        ],
487                                        template: [
488                                                'Sample': sampleTemplateId ? Template.get( sampleTemplateId ) : null,
489                                                'Subject': subjectTemplateId ? Template.get( subjectTemplateId ) : null,
490                                                'Event': eventTemplateId ? Template.get( eventTemplateId ) : null,
491                                                'SamplingEvent': samplingEventTemplateId ? Template.get( samplingEventTemplateId ) : null
492                                        ],
493                                        sheetIndex: sheetIndex,
494                                        dataMatrixStart: dataMatrixStart,
495                                        headerRow: headerRow
496                                ];
497
498                // Check whether the template exists
499                if (!sampleTemplateId || !Template.get( sampleTemplateId ) ){
500                        log.error ".simple study wizard not all fields are filled in: " + sampleTemplateId
501                        flash.error = "No template was chosen. Please choose a template for the samples you provided."
502                        return false
503                }
504               
505                def importedfile = fileService.get( filename )
506                def workbook
507                if (importedfile.exists()) {
508                        try {
509                                workbook = importerService.getWorkbook(new FileInputStream(importedfile))
510                        } catch (Exception e) {
511                                log.error ".simple study wizard could not load file: " + e
512                                flash.error = "The given file doesn't seem to be an excel file. Please provide an excel file for entering samples.";
513                                return false
514                        }
515                } else {
516                        log.error ".simple study wizard no file given";
517                        flash.error = "No file was given. Please provide an excel file for entering samples.";
518                        return false;
519                }
520
521                if( !workbook ) {
522                        log.error ".simple study wizard could not load file into a workbook"
523                        flash.error = "The given file doesn't seem to be an excel file. Please provide an excel file for entering samples.";
524                        return false
525                }
526
527                def selectedentities = []
528
529                if( !excelChecks( workbook, sheetIndex, headerRow, dataMatrixStart ) )
530                        return false;
531
532                // Get the header from the Excel file using the arguments given in the first step of the wizard
533                def importerHeader;
534                def importerDataMatrix;
535
536                try {           
537                        importerHeader = importerService.getHeader(workbook,
538                                        sheetIndex - 1,                 // 0 == first sheet
539                                        headerRow,                              // 1 == first row :s
540                                        dataMatrixStart - 1,    // 0 == first row
541                                        Sample.class)
542               
543                        importerDataMatrix = importerService.getDatamatrix(
544                                        workbook,
545                                        importerHeader,
546                                        sheetIndex - 1,                 // 0 == first sheet
547                                        dataMatrixStart - 1,    // 0 == first row
548                                        5)
549                } catch( Exception e ) {
550                        // An error occurred while reading the excel file.
551                        log.error ".simple study wizard error while reading the excel file";
552                        e.printStackTrace();
553
554                        // Show a message to the user
555                        flash.error = "An error occurred while reading the excel file. Have you provided the right sheet number and row numbers. Contact your system administrator if this problem persists.";
556                        return false;
557                }
558
559                // Match excel columns with template fields
560                def fieldNames = [];
561                flow.sampleForm.template.each { template ->
562                        if( template.value ) {
563                                def fields = template.value.entity.giveDomainFields() + template.value.getFields();
564                                fields.each { field ->
565                                        if( !field.entity )
566                                                field.entity = template.value.entity
567                                               
568                                        fieldNames << field
569                                }
570                        }
571                }
572                importerHeader.each { mc ->
573                        def bestfit = importerService.mostSimilar( mc.name, fieldNames, 0.8);
574                        if( bestfit ) {
575                                // Remove this fit from the list
576                                fieldNames.remove( bestfit );
577                               
578                                mc.entityclass = bestfit.entity
579                                mc.property = bestfit.name
580                        }
581                }
582               
583                // Save read excel data into session
584                def dataMatrix = [];
585                def df = new DataFormatter();
586                importerDataMatrix.each {
587                        dataMatrix << it.collect{ it ? df.formatCellValue(it) : "" }
588                }
589               
590                flow.excel = [
591                                        filename: filename,
592                                        sheetIndex: sheetIndex,
593                                        dataMatrixStart: dataMatrixStart,
594                                        headerRow: headerRow,
595                                        data: [
596                                                header: importerHeader,
597                                                dataMatrix: dataMatrix
598                                        ]
599                                ]
600
601                return true
602        }
603
604       
605        /**
606         * Handles the matching of template fields with excel columns by the user
607         * @param study         Study to update
608         * @param params        Request parameter map
609         * @return                      True if everything went OK, false otherwise. An error message is put in flash.error
610         *                                      The field session.simpleWizard.imported.numInvalidEntities reflects the number of
611         *                                      entities that have errors, and should be fixed before saving. The errors for those entities
612         *                                      are saved into session.simpleWizard.imported.errors
613         */
614        def handleColumns( study, params, flow ) {
615                // Find actual Template object from the chosen template name
616                def templates = [:];
617                flow.sampleForm.templateId.each {
618                        templates[ it.key ] = it.value ? Template.get( it.value ) : null;
619                }
620               
621                def headers = flow.excel.data.header;
622
623                if( !params.matches ) {
624                        log.error( ".simple study wizard no column matches given" );
625                        flash.error = "No column matches given";
626                        return false;
627                }
628
629                // Retrieve the chosen matches from the request parameters and put them into
630                // the headers-structure, for later reference
631                params.matches.index.each { columnindex, value ->
632                        // Determine the entity and property by splitting it
633                        def parts = value.toString().tokenize( "||" );
634                       
635                        def property
636                        def entityName
637                        if( parts.size() > 1 ) {
638                                property = parts[ 1 ];
639                                entityName = "dbnp.studycapturing." + parts[ 0 ];
640                        } else if( parts.size() == 1 ) {
641                                property = parts[ 0 ];
642                                entityName = headers[columnindex.toInteger()].entityclass.getName();
643                        }
644                       
645                        // Create an actual class instance of the selected entity with the selected template
646                        // This should be inside the closure because in some cases in the advanced importer, the fields can have different target entities
647                        def entityClass = Class.forName( entityName, true, this.getClass().getClassLoader())
648                        def entityObj = entityClass.newInstance(template: templates[ entityName[entityName.lastIndexOf( '.' ) + 1..-1] ])
649
650                        headers[ columnindex.toInteger() ].entityclass = entityClass
651                       
652                        // Store the selected property for this column into the column map for the ImporterService
653                        headers[columnindex.toInteger()].property = property
654
655                        // Look up the template field type of the target TemplateField and store it also in the map
656                        headers[columnindex.toInteger()].templatefieldtype = entityObj.giveFieldType(property)
657
658                        // Is a "Don't import" property assigned to the column?
659                        headers[columnindex.toInteger()].dontimport = (property == "dontimport") ? true : false
660
661                        //if it's an identifier set the mapping column true or false
662                        entityClass.giveDomainFields().each {
663                                headers[columnindex.toInteger()].identifier = ( it.preferredIdentifier && (it.name == property) )
664                        }
665                }
666
667                // Import the workbook and store the table with entity records and store the failed cells
668                println "Importing samples for study " + study + " (" + study.id + ")";
669               
670                def importedfile = fileService.get( flow.excel.filename )
671                def workbook
672                if (importedfile.exists()) {
673                        try {
674                                workbook = importerService.getWorkbook(new FileInputStream(importedfile))
675                        } catch (Exception e) {
676                                log.error ".simple study wizard could not load file: " + e
677                                flash.error = "The given file doesn't seem to be an excel file. Please provide an excel file for entering samples.";
678                                return false
679                        }
680                } else {
681                        log.error ".simple study wizard no file given";
682                        flash.error = "No file was given. Please provide an excel file for entering samples.";
683                        return false;
684                }
685
686                if( !workbook ) {
687                        log.error ".simple study wizard could not load file into a workbook"
688                        flash.error = "The given file doesn't seem to be an excel file. Please provide an excel file for entering samples.";
689                        return false
690                }
691                       
692                def imported = importerService.importOrUpdateDataBySampleIdentifier(templates,
693                                workbook,
694                                flow.excel.sheetIndex - 1,
695                                flow.excel.dataMatrixStart - 1,
696                                flow.excel.data.header,
697                                flow.study,
698                                true                    // Also create entities for which no data is imported but where templates were chosen
699                );
700
701                def table = imported.table
702                def failedcells = imported.failedCells
703
704                flow.imported = [
705                        data: table,
706                        failedCells: failedcells
707                ];
708       
709                // loop through all entities to validate them and add them to failedcells if an error occurs
710                def numInvalidEntities = 0;
711                def errors = [];
712
713                // Add all samples
714                table.each { record ->
715                        record.each { entity ->
716                                if( entity ) {
717                                        // Determine entity class and add a parent. Add the entity to the study
718                                        def preferredIdentifier = importerService.givePreferredIdentifier( entity.class );
719                                        def equalClosure = { it.getFieldValue( preferredIdentifier.name ) == entity.getFieldValue( preferredIdentifier.name ) }
720                                        def entityName = entity.class.name[ entity.class.name.lastIndexOf( "." ) + 1 .. -1 ]
721
722                                        entity.parent = study
723                                       
724                                        switch( entity.class ) {
725                                                case Sample:
726                                                        if( !preferredIdentifier || !study.samples?.find( equalClosure ) ) {
727                                                                study.addToSamples( entity );
728                                                        }
729                                                       
730                                                        // If an eventgroup is created, add it to the study
731                                                        // The eventgroup must have a unique name, but the user shouldn't be bothered with it
732                                                        // Add 'group ' + samplename and it that is not unique, add a number to it
733                                                        if( entity.parentEventGroup ) {
734                                                                study.addToEventGroups( entity.parentEventGroup )
735
736                                                                entity.parentEventGroup.name = "Group " + entity.name
737                                                                while( !entity.parentEventGroup.validate() ) {
738                                                                        entity.parentEventGroup.getErrors().each { println it }
739                                                                        entity.parentEventGroup.name += "" + Math.floor( Math.random() * 100 )
740                                                                }
741                                                        }
742                                                       
743                                                        break;
744                                                case Subject:
745                                                        // Subjects should have unique names; if the user has entered the same name multiple times,
746                                                        // the subject will be renamed
747                                                        def subjectFound = study.subjects?.find( equalClosure ) ;
748                                                        if( preferredIdentifier && subjectFound ) {
749                                                                def baseName = entity.getFieldValue( preferredIdentifier.name )
750                                                                def counter = 1;
751                                                               
752                                                                while( study.subjects?.find { it.getFieldValue( preferredIdentifier.name ) == entity.getFieldValue( preferredIdentifier.name ) } ) {
753                                                                        entity.setFieldValue( preferredIdentifier.name, baseName + " (" + counter++ + ")" )
754                                                                }
755                                                        }
756                                                        study.addToSubjects( entity );
757                                                       
758                                                        break;
759                                                case Event:
760                                                        if( !preferredIdentifier || !study.events?.find( equalClosure ) ) {
761                                                                study.addToEvents( entity );
762                                                        }
763                                                        break;
764                                                case SamplingEvent:
765                                                        // Sampling events have a 'sampleTemplate' value, which should be filled by the
766                                                        // template that is chosen for samples.
767                                                        if( !entity.getFieldValue( 'sampleTemplate' ) ) {
768                                                                entity.setFieldValue( 'sampleTemplate', flow.sampleForm.template.Sample.name )
769                                                        }
770                                               
771                                                        if( !preferredIdentifier || !study.samplingEvents?.find( equalClosure ) ) {
772                                                                study.addToSamplingEvents( entity );
773                                                        }
774                                                        break;
775                                        }
776                                       
777                                        if (!entity.validate()) {
778                                                numInvalidEntities++;
779                                               
780                                                // Add this field to the list of failed cells, in order to give the user feedback
781                                                failedcells = addNonValidatingCells( failedcells, entity, flow )
782       
783                                                // Also create a full list of errors
784                                                def currentErrors = getHumanReadableErrors( entity )
785                                                if( currentErrors ) {
786                                                        currentErrors.each {
787                                                                errors += "(" + entityName + ") " + it.value;
788                                                        }
789                                                }
790                                        }
791                                }
792                        }
793                }
794
795                flow.imported.numInvalidEntities = numInvalidEntities + failedcells?.size();
796                flow.imported.errors = errors;
797
798                return true
799        }
800       
801        /**
802         * Handles the update of the edited fields by the user
803         * @param study         Study to update
804         * @param params                Request parameter map
805         * @return                      True if everything went OK, false otherwise. An error message is put in flash.error.
806         *                                      The field session.simpleWizard.imported.numInvalidEntities reflects the number of
807         *                                      entities that still have errors, and should be fixed before saving. The errors for those entities
808         *                                      are saved into session.simpleWizard.imported.errors
809         */
810        def handleMissingFields( study, params, flow ) {
811                def numInvalidEntities = 0;
812                def errors = [];
813
814                // Check which fields failed previously
815                def failedCells = flow.imported.failedCells
816                def newFailedCells = [];
817
818                flow.imported.data.each { table ->
819                        table.each { entity ->
820                                def invalidFields = 0
821                                def failed = new ImportRecord();
822                                def entityName = entity.class.name[ entity.class.name.lastIndexOf( "." ) + 1 .. -1 ]
823                               
824
825                                // Set the fields for this entity by retrieving values from the params
826                                entity.giveFields().each { field ->
827                                        def fieldName = importerService.getFieldNameInTableEditor( entity, field );
828
829                                        if( params[ fieldName ] == "#invalidterm" ) {
830                                                // If the value '#invalidterm' is chosen, the user hasn't fixed anything, so this field is still incorrect
831                                                invalidFields++;
832                                               
833                                                // store the mapping column and value which failed
834                                                def identifier = entityName.toLowerCase() + "_" + entity.getIdentifier() + "_" + fieldName
835                                                def mcInstance = new MappingColumn()
836                                                failed.addToImportcells(new ImportCell(mappingcolumn: mcInstance, value: params[ fieldName ], entityidentifier: identifier))
837                                        } else {
838                                                if( field.type == org.dbnp.gdt.TemplateFieldType.ONTOLOGYTERM || field.type == org.dbnp.gdt.TemplateFieldType.STRINGLIST ) {
839                                                        // If this field is an ontologyterm field or a stringlist field, the value has changed, so remove the field from
840                                                        // the failedCells list
841                                                        importerService.removeFailedCell( failedCells, entity, field )
842                                                }
843
844                                                // Update the field, regardless of the type of field
845                                                entity.setFieldValue(field.name, params[ fieldName ] )
846                                        }
847                                }
848                               
849                                // Try to validate the entity now all fields have been set. If it fails, return an error
850                                if (!entity.validate() || invalidFields) {
851                                        numInvalidEntities++;
852
853                                        // Add this field to the list of failed cells, in order to give the user feedback
854                                        failedCells = addNonValidatingCellsToImportRecord( failed, entity, flow )
855
856                                        // Also create a full list of errors
857                                        def currentErrors = getHumanReadableErrors( entity )
858                                        if( currentErrors ) {
859                                                currentErrors.each {
860                                                        errors += "(" + entityName + ") " + it.value;
861                                                }
862                                        }
863                                       
864                                        newFailedCells << failed;
865                                } else {
866                                        importerService.removeFailedCell( failedCells, entity )
867                                }
868                        } // end of record
869                } // end of table
870
871                flow.imported.failedCells = newFailedCells
872                flow.imported.numInvalidEntities = numInvalidEntities;
873                flow.imported.errors = errors;
874
875                return numInvalidEntities == 0
876        }
877       
878        /**
879        * Handles assay input
880        * @param study          Study to update
881        * @param params         Request parameter map
882        * @return                       True if everything went OK, false otherwise. An error message is put in flash.error
883        */
884   def handleAssays( assay, params, flow ) {
885           // did the study template change?
886           if (params.get('template') && assay.template?.name != params.get('template')) {
887                   // set the template
888                   assay.template = Template.findByName(params.remove('template'))
889           }
890
891           // does the study have a template set?
892           if (assay.template && assay.template instanceof Template) {
893                   // yes, iterate through template fields
894                   assay.giveFields().each() {
895                           // and set their values
896                           assay.setFieldValue(it.name, params.get(it.escapedName()))
897                   }
898           }
899
900           return true
901   }
902       
903       
904        /**
905         * Checks whether the given study is simple enough to be edited using this controller.
906         *
907         * The study is simple enough if the samples, subjects, events and samplingEvents can be
908         * edited as a flat table. That is:
909         *              - Every subject belongs to 0 or 1 eventgroup
910         *              - Every eventgroup belongs to 0 or 1 sample
911         *              - Every eventgroup has 0 or 1 subjects, 0 or 1 event and 0 or 1 samplingEvents
912         *              - If a sample belongs to an eventgroup:
913         *                      - If that eventgroup has a samplingEvent, that same samplingEvent must also be
914         *                              the sampling event that generated this sample
915         *                      - If that eventgroup has a subject, that same subject must also be the subject
916         *                              from whom the sample was taken
917         *
918         * @param study         Study to check
919         * @return                      True if the study can be edited by this controller, false otherwise
920         */
921        def checkStudySimplicity( study ) {
922                def simplicity = true;
923
924                if( !study )
925                        return false
926
927                if( study.eventGroups ) {
928                        study.eventGroups.each { eventGroup ->
929                                // Check for simplicity of eventgroups: only 0 or 1 subject, 0 or 1 event and 0 or 1 samplingEvent
930                                if( eventGroup.subjects?.size() > 1 || eventGroup.events?.size() > 1 || eventGroup.samplingEvents?.size() > 1 ) {
931                                        flash.message = "One or more eventgroups contain multiple subjects or events."
932                                        simplicity = false;
933                                }
934
935                                // Check whether this eventgroup only belongs to (max) 1 sample
936                                def numSamples = 0;
937                                study.samples.each { sample ->
938                                        // If no id is given for the eventGroup, it has been entered in this wizard, but
939                                        // not yet saved. In that case, it is always OK
940                                        if( eventGroup.id && sample.parentEventGroup?.id == eventGroup.id )
941                                                numSamples++;
942                                }
943
944                                if( numSamples > 1 ) {
945                                        flash.message = "One or more eventgroups belong to multiple samples."
946                                        simplicity = false;
947                                }
948                        }
949
950                        if( !simplicity ) return false;
951
952                        // Check whether subject only belong to zero or one event group
953                        if( study.subjects ) {
954                                study.subjects.each { subject ->
955                                        def numEventGroups = 0
956                                        study.eventGroups.each { eventGroup ->
957                                                // If no id is given for the subject, it has been entered in this wizard, but
958                                                // not yet saved. In that case, it is always OK
959                                                if( subject.id && eventGroup.subjects && eventGroup.subjects.toList()[0]?.id == subject.id )
960                                                        numEventGroups++
961                                        }
962
963                                        if( numEventGroups > 1 ) {
964                                                flash.message = "One or more subjects belong to multiple eventgroups."
965                                                simplicity = false;
966                                        }
967                                }
968                        }
969
970                        if( !simplicity ) return false;
971
972                        // Check whether the samples that belong to an eventgroup have the right parentObjects
973                        study.samples.each { sample ->
974                                if( sample.parentEventGroup ) {
975                                        // If no id is given for the subject, it has been entered in this wizard, but
976                                        // not yet saved. In that case, it is always OK
977                                        if( sample.parentSubject && sample.parentSubject.id) {
978                                                if( !sample.parentEventGroup.subjects || sample.parentEventGroup.subjects.toList()[0]?.id != sample.parentSubject.id ) {
979                                                        flash.message = "The structure of the eventgroups of one or more samples is too complex"
980                                                        simplicity = false;
981                                                }
982                                        }
983
984                                        // If no id is given for the sampling event, it has been entered in this wizard, but
985                                        // not yet saved. In that case, it is always OK
986                                        if( sample.parentEvent && sample.parentEvent.id) {
987                                                if( !sample.parentEventGroup.samplingEvents || sample.parentEventGroup.samplingEvents.toList()[0]?.id != sample.parentEvent.id ) {
988                                                        flash.message = "The structure of the eventgroups of one or more samples is too complex"
989                                                        simplicity = false;
990                                                }
991                                        }
992                                }
993                        }
994
995                        if( !simplicity ) return false;
996                }
997
998                return simplicity;
999        }
1000
1001       
1002        /**
1003         * Adds all fields of this entity that have given an error when validating to the failedcells list
1004         * @param failedcells   Current list of ImportRecords
1005         * @param entity                Entity to check. The entity must have been validated before
1006         * @return                              Updated list of ImportRecords
1007         */
1008        protected def addNonValidatingCells( failedcells, entity, flow ) {
1009                // Add this entity and the fields with an error to the failedCells list
1010                ImportRecord failedRecord = addNonValidatingCellsToImportRecord( new ImportRecord(), entity, flow );
1011
1012                failedcells.add( failedRecord );
1013
1014                return failedcells
1015        }
1016       
1017        /**
1018        * Adds all fields of this entity that have given an error when validating to the failedcells list
1019        * @param failedcells    Current list of ImportRecords
1020        * @param entity         Entity to check. The entity must have been validated before
1021        * @return                               Updated list of ImportRecords
1022        */
1023   protected def addNonValidatingCellsToImportRecord( failedRecord, entity, flow ) {
1024           entity.getErrors().getFieldErrors().each { error ->
1025                   String field = error.getField();
1026                   
1027                   def mc = importerService.findMappingColumn( flow.excel.data.header, field );
1028                   def mcInstance = new MappingColumn( name: field, entityClass: Sample.class, index: -1, property: field.toLowerCase(), templateFieldType: entity.giveFieldType( field ) );
1029
1030                   // Create a clone of the mapping column
1031                   if( mc ) {
1032                           mcInstance.properties = mc.properties
1033                   }
1034
1035                   failedRecord.addToImportcells( new ImportCell(mappingcolumn: mcInstance, value: error.getRejectedValue(), entityidentifier: importerService.getFieldNameInTableEditor( entity, field ) ) )
1036           }
1037           
1038           return failedRecord
1039   }
1040
1041       
1042        /**
1043        * Checks an excel workbook whether the given sheetindex and rownumbers are correct
1044        * @param workbook                       Excel workbook to read
1045        * @param sheetIndex             1-based sheet index for the sheet to read (1=first sheet)
1046        * @param headerRow                      1-based row number for the header row (1=first row)
1047        * @param dataMatrixStart        1-based row number for the first data row (1=first row)
1048        * @return                                       True if the sheet index and row numbers are correct.
1049        */
1050   protected boolean excelChecks( def workbook, int sheetIndex, int headerRow, int dataMatrixStart ) {
1051           // Perform some basic checks on the excel file. These checks should be performed by the importerservice
1052           // in a perfect scenario.
1053           if( sheetIndex > workbook.getNumberOfSheets() ) {
1054                   log.error ".simple study wizard Sheet index is too high: " + sheetIndex + " / " + workbook.getNumberOfSheets();
1055                   flash.error = "Your excel sheet contains too few excel sheets. The provided excel sheet has only " + workbook.getNumberOfSheets() + " sheet(s).";
1056                   return false
1057           }
1058
1059           def sheet = workbook.getSheetAt(sheetIndex - 1);
1060           def firstRowNum = sheet.getFirstRowNum();
1061           def lastRowNum = sheet.getLastRowNum();
1062           def numRows = lastRowNum - firstRowNum + 1;
1063
1064           if( headerRow > numRows  ) {
1065                   log.error ".simple study wizard Header row number is incorrect: " + headerRow + " / " + numRows;
1066                   flash.error = "Your excel sheet doesn't contain enough rows (" + numRows + "). Please provide an excel sheet with one header row and data below";
1067                   return false
1068           }
1069
1070           if( dataMatrixStart > numRows  ) {
1071                   log.error ".simple study wizard Data row number is incorrect: " + dataMatrixStart + " / " + numRows;
1072                   flash.error = "Your excel sheet doesn't contain enough rows (" + numRows + "). Please provide an excel sheet with one header row and data below";
1073                   return false
1074           }
1075
1076           return true;
1077   }
1078       
1079        /**
1080         * Validates an object and puts human readable errors in validationErrors variable
1081         * @param entity                Entity to validate
1082         * @return                      True iff the entity validates, false otherwise
1083         */
1084        protected boolean validateObject( def entity ) {
1085                if( !entity.validate() ) {
1086                        flash.validationErrors = getHumanReadableErrors( entity )
1087                        return false;
1088                }
1089                return true;
1090        }
1091
1092        /**
1093         * transform domain class validation errors into a human readable
1094         * linked hash map
1095         * @param object validated domain class
1096         * @return object  linkedHashMap
1097         */
1098        def getHumanReadableErrors(object) {
1099                def errors = [:]
1100                object.errors.getAllErrors().each() { error ->
1101                        // error.codes.each() { code -> println code }
1102
1103                        // generally speaking g.message(...) should work,
1104                        // however it fails in some steps of the wizard
1105                        // (add event, add assay, etc) so g is not always
1106                        // availably. Using our own instance of the
1107                        // validationTagLib instead so it is always
1108                        // available to us
1109                        errors[error.getArguments()[0]] = validationTagLib.message(error: error)
1110                }
1111
1112                return errors
1113        }
1114}
Note: See TracBrowser for help on using the browser.