root/trunk/grails-app/services/dbnp/importer/ImporterService.groovy @ 1613

Revision 1613, 38.2 KB (checked in by robert@…, 3 years ago)

Removed some printlns

  • Property svn:keywords set to Rev Author Date
Line 
1/**
2 * Importer service
3 *
4 * The importer service handles the import of tabular, comma delimited and Excel format
5 * based files.
6 *
7 * @package importer
8 * @author t.w.abma@umcutrecht.nl
9 * @since 20100126
10 *
11 * Revision information:
12 * $Rev$
13 * $Author$
14 * $Date$
15 */
16package dbnp.importer
17
18import org.dbnp.gdt.*
19import org.apache.poi.ss.usermodel.*
20import dbnp.studycapturing.*
21
22class ImporterService {
23        def authenticationService
24
25        static transactional = false
26
27        /**
28         * @param is input stream representing the (workbook) resource
29         * @return high level representation of the workbook
30         */
31        Workbook getWorkbook(InputStream is) {
32                WorkbookFactory.create(is)
33        }
34
35        /**
36         * @param wb high level representation of the workbook
37         * @param sheetindex sheet to use within the workbook
38         * @return header representation as a MappingColumn hashmap
39         */
40        def getHeader(Workbook wb, int sheetindex, int headerrow, int datamatrix_start, theEntity = null) {
41                def sheet = wb.getSheetAt(sheetindex)
42                def sheetrow = sheet.getRow(datamatrix_start)
43                //def header = []
44                def header = []
45                def df = new DataFormatter()
46                def property = new String()
47
48                //for (Cell c: sheet.getRow(datamatrix_start)) {
49
50                (0..sheetrow.getLastCellNum() - 1).each { columnindex ->
51
52                        //def index     =   c.getColumnIndex()
53                        def datamatrix_celltype = sheet.getRow(datamatrix_start).getCell(columnindex, Row.CREATE_NULL_AS_BLANK).getCellType()
54                        def datamatrix_celldata = df.formatCellValue(sheet.getRow(datamatrix_start).getCell(columnindex))
55                        def datamatrix_cell = sheet.getRow(datamatrix_start).getCell(columnindex)
56                        def headercell = sheet.getRow(headerrow - 1 + sheet.getFirstRowNum()).getCell(columnindex)
57                        def tft = TemplateFieldType.STRING //default templatefield type
58
59                        // Check for every celltype, currently redundant code, but possibly this will be
60                        // a piece of custom code for every cell type like specific formatting
61
62                        switch (datamatrix_celltype) {
63                                case Cell.CELL_TYPE_STRING:
64                                //parse cell value as double
65                                        def doubleBoolean = true
66                                        def fieldtype = TemplateFieldType.STRING
67
68                                // is this string perhaps a double?
69                                        try {
70                                                formatValue(datamatrix_celldata, TemplateFieldType.DOUBLE)
71                                        } catch (NumberFormatException nfe) {
72                                                doubleBoolean = false
73                                        }
74                                        finally {
75                                                if (doubleBoolean) fieldtype = TemplateFieldType.DOUBLE
76                                        }
77
78                                        header[columnindex] = new dbnp.importer.MappingColumn(name: df.formatCellValue(headercell),
79                                                        templatefieldtype: fieldtype,
80                                                        index: columnindex,
81                                                        entityclass: theEntity,
82                                                        property: property);
83
84                                        break
85                                case Cell.CELL_TYPE_NUMERIC:
86                                        def fieldtype = TemplateFieldType.LONG
87                                        def doubleBoolean = true
88                                        def longBoolean = true
89
90                                // is this cell really an integer?
91                                        try {
92                                                Long.valueOf(datamatrix_celldata)
93                                        } catch (NumberFormatException nfe) {
94                                                longBoolean = false
95                                        }
96                                        finally {
97                                                if (longBoolean) fieldtype = TemplateFieldType.LONG
98                                        }
99
100                                // it's not an long, perhaps a double?
101                                        if (!longBoolean)
102                                                try {
103                                                        formatValue(datamatrix_celldata, TemplateFieldType.DOUBLE)
104                                                } catch (NumberFormatException nfe) {
105                                                        doubleBoolean = false
106                                                }
107                                                finally {
108                                                        if (doubleBoolean) fieldtype = TemplateFieldType.DOUBLE
109                                                }
110
111                                        if (DateUtil.isCellDateFormatted(datamatrix_cell)) fieldtype = TemplateFieldType.DATE
112
113                                        header[columnindex] = new dbnp.importer.MappingColumn(name: df.formatCellValue(headercell),
114                                                        templatefieldtype: fieldtype,
115                                                        index: columnindex,
116                                                        entityclass: theEntity,
117                                                        property: property);
118                                        break
119                                case Cell.CELL_TYPE_BLANK:
120                                        header[columnindex] = new dbnp.importer.MappingColumn(name: df.formatCellValue(headercell),
121                                        templatefieldtype: TemplateFieldType.STRING,
122                                        index: columnindex,
123                                        entityclass: theEntity,
124                                        property: property);
125                                        break
126                                default:
127                                        header[columnindex] = new dbnp.importer.MappingColumn(name: df.formatCellValue(headercell),
128                                        templatefieldtype: TemplateFieldType.STRING,
129                                        index: columnindex,
130                                        entityclass: theEntity,
131                                        property: property);
132                                        break
133                        } // end of switch
134                } // end of cell loop
135                return header
136        }
137
138        /**
139         * This method is meant to return a matrix of the rows and columns
140         * used in the preview
141         *
142         * @param wb workbook object
143         * @param sheetindex sheet index used
144         * @param rows amount of rows returned
145         * @return two dimensional array (matrix) of Cell objects
146         */
147        Object[][] getDatamatrix(Workbook wb, header, int sheetindex, int datamatrix_start, int count) {
148                def sheet = wb.getSheetAt(sheetindex)
149                def rows = []
150                def df = new DataFormatter()
151
152                count = (count < sheet.getLastRowNum()) ? count : sheet.getLastRowNum()
153
154                // walk through all rows
155                ((datamatrix_start + sheet.getFirstRowNum())..count).each { rowindex ->
156                        def row = []
157
158                        (0..header.size() - 1).each { columnindex ->
159                                if (sheet.getRow(rowindex))
160                                        row.add( sheet.getRow(rowindex).getCell(columnindex, Row.CREATE_NULL_AS_BLANK) )
161                        }
162
163                        rows.add(row)
164                }
165
166                return rows
167        }
168
169        /**
170         * This method will move a file to a new location.
171         *
172         * @param file File object to move
173         * @param folderpath folder to move the file to
174         * @param filename (new) filename to give
175         * @return if file has been moved succesful, the new path and filename will be returned, otherwise an empty string will be returned
176         */
177        def moveFile(File file, String folderpath, String filename) {
178                try {
179                        def rnd = ""; //System.currentTimeMillis()
180                        file.transferTo(new File(folderpath, rnd + filename))
181                        return folderpath + filename
182                } catch (Exception exception) {
183                        log.error "File move error, ${exception}"
184                        return ""
185                }
186        }
187
188        /**
189         * @return random numeric value
190         */
191        def random = {
192                return System.currentTimeMillis() + Runtime.runtime.freeMemory()
193        }
194
195
196        /**
197         * Retrieves records with sample, subject, samplingevent etc. from a study
198         * @param s             Study to retrieve records from
199         * @return              A list with hashmaps [ 'objects': [ 'Sample': .., 'Subject': .., 'SamplingEvent': .., 'Event': '.. ], 'templates': [], 'templateCombination': .. ]
200         */
201        protected def getRecords( Study s ) {
202                def records = [];
203
204                s.samples?.each {
205                        def record = [ 'objects': retrieveEntitiesBySample( it ) ];
206
207                        def templates = [:]
208                        def templateCombination = [];
209                        record.objects.each { entity ->
210                                templates[ entity.key ] = entity.value?.template
211                                if( entity.value?.template )
212                                        templateCombination << entity.key + ": " + entity.value?.template?.name;
213                        }
214
215                        record.templates = templates;
216                        record.templateCombination = templateCombination.join( ', ' )
217
218                        records << record
219                }
220
221                return records;
222        }
223
224        /**
225         * Returns a subject, event and samplingEvent that belong to this sample
226         * @param s             Sample to find the information for
227         * @return
228         */
229        protected retrieveEntitiesBySample( Sample s ) {
230                return [
231                        'Sample': s,
232                        'Subject': s?.parentSubject,
233                        'SamplingEvent': s?.parentEvent,
234                        'Event': s?.parentEventGroup?.events?.toList()?.getAt(0)
235                ]
236        }
237
238        /**
239         * Imports data from a workbook into a list of ImportRecords. If some entities are already in the database,
240         * these records are updated.
241         *
242         * This method is capable of importing Subject, Samples, SamplingEvents and Events
243         *
244         * @param       templates       Map of templates, identified by their entity as a key. For example: [ Subject: Template x, Sample: Template y ]
245         * @param       wb                      Excel workbook to import
246         * @param       sheetindex      Number of the sheet to import data from
247         * @param       rowindex        Row to start importing from.
248         * @param       mcmap           Hashmap of mappingcolumns, with the first entry in the hashmap containing information about the first column, etc.
249         * @param       parent          Study to import all data into. Is used for determining which sample/event/subject/assay to update
250         * @param       createAllEntities       If set to true, the system will also create objects for entities that have no data imported, but do have
251         *                                                              a template assigned
252         * @return      List            List with two entries:
253         *                      0                       List with ImportRecords, one for each row in the excelsheet
254         *                      1                       List with ImportCell objects, mentioning the cells that could not be correctly imported
255         *                                              (because the value in the excelsheet can't be entered into the template field)
256         */
257        def importOrUpdateDataBySampleIdentifier( def templates, Workbook wb, int sheetindex, int rowindex, def mcmap, Study parent = null, boolean createAllEntities = true ) {
258                if( !mcmap )
259                        return;
260
261                // Check whether the rows should be imported in one or more entities
262                def entities
263                if( createAllEntities ) {
264                        entities = templates.entrySet().value.findAll { it }.entity;
265                } else {
266                        entities = mcmap.findAll{ !it.dontimport }.entityclass.unique();
267                }
268
269                def sheet = wb.getSheetAt(sheetindex)
270                def table = []
271                def failedcells = [] // list of cells that have failed to import
272                // First check for each record whether an entity in the database should be updated,
273                // or a new entity should be added. This is done before any new object is created, since
274                // searching after new objects have been created (but not yet saved) will result in
275                //      org.hibernate.AssertionFailure: collection [...] was not processed by flush()
276                // errors
277                def existingEntities = [:]
278                for( int i = rowindex; i <= sheet.getLastRowNum(); i++ ) {
279                        existingEntities[i] = findExistingEntities( entities, sheet.getRow(i), mcmap, parent );
280                }
281
282                // walk through all rows and fill the table with records
283                for( int i = rowindex; i <= sheet.getLastRowNum(); i++ ) {
284                        def row = sheet.getRow(i);
285                       
286                        if( row && !rowIsEmpty( row ) ) {
287                                // Create an entity record based on a row read from Excel and store the cells which failed to be mapped
288                                def (record, failed) = importOrUpdateRecord( templates, entities, row, mcmap, parent, table, existingEntities[i] );
289       
290                                // Setup the relationships between the imported entities
291                                relateEntities( record );
292       
293                                // Add record with entities and its values to the table
294                                table.add(record)
295       
296                                // If failed cells have been found, add them to the failed cells list
297                                if (failed?.importcells?.size() > 0) failedcells.add(failed)
298                        }
299                }
300
301                return [ "table": table, "failedCells": failedcells ]
302        }
303       
304        /**
305         * Checks whether an excel row is empty
306         * @param row   Row from the excel sheet
307         * @return              True if all cells in this row are empty or the given row is null. False otherwise
308         */
309        def rowIsEmpty( Row excelRow ) {
310                if( !excelRow )
311                        return true;
312               
313                def df = new DataFormatter();
314                for( int i = excelRow.getFirstCellNum(); i < excelRow.getLastCellNum(); i++ ) {
315                        Cell cell = excelRow.getCell( i );
316                       
317                        try {
318                                def value = df.formatCellValue(cell)
319                                if( value )
320                                        return false
321                        } catch (NumberFormatException nfe) {
322                                // If the number can't be formatted, the row isn't empty
323                                return false;
324                        }
325                }
326               
327                return true;
328        }
329
330        /**
331         * Checks whether entities in the given row already exist in the database
332         * they are updated.
333         *
334         * @param       entities        Entities that have to be imported for this row
335         * @param       excelRow        Excel row to import into this record
336         * @param       mcmap           Hashmap of mappingcolumns, with the first entry in the hashmap containing information about the first column, etc.
337         * @return      Map                     Map with entities that have been found for this row. The key for the entities is the entity name (e.g.: [Sample: null, Subject: <subject object>]
338         */
339        def findExistingEntities(def entities, Row excelRow, mcmap, parent ) {
340                DataFormatter df = new DataFormatter();
341
342                // Find entities based on sample identifier
343                def sample = findEntityByRow( dbnp.studycapturing.Sample, excelRow, mcmap, parent, [], df );
344                return retrieveEntitiesBySample( sample );
345        }
346
347        /**
348         * Imports a records from the excelsheet into the database. If the entities are already in the database
349         * they are updated.
350         *
351         * This method is capable of importing Subject, Samples, SamplingEvents and Events
352         *
353         * @param       templates       Map of templates, identified by their entity as a key. For example: [ Sample: Template y ]
354         * @param       entities        Entities that have to be imported for this row
355         * @param       excelRow        Excel row to import into this record
356         * @param       mcmap           Hashmap of mappingcolumns, with the first entry in the hashmap containing information about the first column, etc.
357         * @param       parent          Study to import all data into. Is used for determining which sample/event/subject/assay to update
358         * @param       importedRows    Rows that have been imported before this row. These rows might contain the same entities as are
359         *                                                      imported in this row. These entities should be used again, to avoid importing duplicates.
360         * @return      List            List with two entries:
361         *                      0                       List with ImportRecords, one for each row in the excelsheet
362         *                      1                       List with ImportCell objects, mentioning the cells that could not be correctly imported
363         *                                              (because the value in the excelsheet can't be entered into the template field)
364         */
365        def importOrUpdateRecord(def templates, def entities, Row excelRow, mcmap, Study parent = null, List importedRows, Map existingEntities ) {
366                DataFormatter df = new DataFormatter();
367                def record = [] // list of entities and the read values
368                def failed = new ImportRecord() // map with entity identifier and failed mappingcolumn
369
370                // Check whether this record mentions a sample that has been imported before. In that case,
371                // we update that record, in order to prevent importing the same sample multiple times
372                def importedEntities = [];
373                if( importedRows )
374                        importedEntities = importedRows.flatten().findAll { it.class == dbnp.studycapturing.Sample }.unique();
375
376                def importedSample = findEntityInImportedEntities( dbnp.studycapturing.Sample, excelRow, mcmap, importedEntities, df )
377                def imported = retrieveEntitiesBySample( importedSample );
378               
379                for( entity in entities ) {
380                        // Check whether this entity should be added or updated
381                        // The entity is updated is an entity with the same 'identifier' (field
382                        // specified to be the identifying field) is found in the database
383                        def entityName = entity.name[ entity.name.lastIndexOf( '.' ) + 1..-1];
384                        def template = templates[ entityName ];
385
386                        // If no template is specified for this entity, continue with the next
387                        if( !template )
388                                continue;
389
390                        // Check whether the object exists in the list of already imported entities
391                        def entityObject = imported[ entityName ]
392
393                        // If it doesn't, search for the entity in the database
394                        if( !entityObject && existingEntities )
395                                entityObject = existingEntities[ entityName ];
396
397                        // Otherwise, create a new object
398                        if( !entityObject )
399                                entityObject = entity.newInstance();
400
401                        // Update the template
402                        entityObject.template = template;
403
404                        // Go through the Excel row cell by cell
405                        for( int i = excelRow.getFirstCellNum(); i < excelRow.getLastCellNum(); i++ ) {
406                                Cell cell = excelRow.getCell( i );
407                               
408                                // get the MappingColumn information of the current cell
409                                def mc = mcmap[cell.getColumnIndex()]
410                                def value
411
412                                // Check if column must be imported
413                                if (mc != null && !mc.dontimport && mc.entityclass == entity) {
414                                        try {
415                                                if( cell.getCellType() == Cell.CELL_TYPE_NUMERIC && DateUtil.isCellDateFormatted(cell) ) {
416                                                        // The format for date template fields is dd/mm/yyyy
417                                                        def date = cell.getDateCellValue();
418                                                        value = date.format( "dd/MM/yyyy" )
419                                                } else {
420                                                        value = formatValue(df.formatCellValue(cell), mc.templatefieldtype)
421                                                }
422                                        } catch (NumberFormatException nfe) {
423                                                value = ""
424                                        }
425
426                                        try {
427                                                entityObject.setFieldValue(mc.property, value)
428                                        } catch (Exception iae) {
429                                                log.error ".import wizard error could not set property `" + mc.property + "` to value `" + value + "`"
430
431                                                // store the mapping column and value which failed
432                                                def identifier = entityName.toLowerCase() + "_" + entityObject.getIdentifier() + "_" + mc.property
433
434                                                def mcInstance = new MappingColumn()
435                                                mcInstance.properties = mc.properties
436                                                failed.addToImportcells(new ImportCell(mappingcolumn: mcInstance, value: value, entityidentifier: identifier))
437                                        }
438                                } // end if
439                        } // end for
440
441                        // If a Study is entered, use it as a 'parent' for other entities
442                        if( entity == Study )
443                                parent = entityObject;
444
445                        record << entityObject;
446                }
447
448                // a failed column means that using the entity.setFieldValue() threw an exception
449                return [record, failed]
450        }
451
452        /**
453         * Looks into the database to find an object of the given entity that should be updated, given the excel row.
454         * This is done by looking at the 'preferredIdentifier' field of the object. If it exists in the row, and the
455         * value is already in the database for that field, an existing object is returned. Otherwise, null is returned
456         *
457         * @param       entity          Entity to search
458         * @param       excelRow        Excelrow to search for
459         * @param       mcmap           Map with MappingColumns
460         * @param       parent          Parent study for the entity (if applicable). The returned entity will also have this parent
461         * @param       importedRows    List of entities that have been imported before. The function will first look through this list to find
462         *                                                      a matching entity.
463         * @return      An entity that has the same identifier as entered in the excelRow. The entity is first sought in the importedRows. If it
464         *                      is not found there, the database is queried. If no entity is found at all, null is returned.
465         */
466        def findEntityByRow( Class entity, Row excelRow, def mcmap, Study parent = null, List importedEntities = [], DataFormatter df = null ) {
467                if( !excelRow )
468                        return
469               
470                if( df == null )
471                        df = new DataFormatter();
472
473                def identifierField = givePreferredIdentifier( entity );
474
475                if( identifierField ) {
476                        // Check whether the identifierField is chosen in the column matching
477                        def identifierColumn = mcmap.find { it.entityclass == entity && it.property == identifierField.name };
478
479                        // If it is, find the identifier and look it up in the database
480                        if( identifierColumn ) {
481                                def identifierCell = excelRow.getCell( identifierColumn.index );
482                                def identifier;
483                                try {
484                                        identifier = formatValue(df.formatCellValue(identifierCell), identifierColumn.templatefieldtype)
485                                } catch (NumberFormatException nfe) {
486                                        identifier = null
487                                }
488
489                                // Search for an existing object with the same identifier.
490                                if( identifier ) {
491                                        // First search the already imported rows
492                                        if( importedEntities ) {
493                                                def imported = importedEntities.find { it.getFieldValue( identifierField.name ) == identifier };
494                                                if( imported )
495                                                        return imported;
496                                        }
497
498                                        def c = entity.createCriteria();
499
500                                        // If the entity has a field 'parent', the search should be limited to
501                                        // objects with the same parent. The method entity.hasProperty( "parent" ) doesn't
502                                        // work, since the java.lang.Class entity doesn't know of the parent property.
503                                        if( entity.belongsTo?.containsKey( "parent" ) ) {
504                                                // If the entity requires a parent, but none is given, no
505                                                // results are given from the database. This prevents the user
506                                                // of changing data in another study
507                                                if( parent && parent.id ) {
508                                                        return c.get {
509                                                                eq( identifierField.name, identifier )
510                                                                eq( "parent", parent )
511                                                        }
512                                                }
513                                        } else  {
514                                                return c.get {
515                                                        eq( identifierField.name, identifier )
516                                                }
517                                        }
518                                }
519                        }
520                }
521
522                // No object is found
523                return null;
524        }
525
526        /**
527         * Looks into the list of already imported entities to find an object of the given entity that should be
528         * updated, given the excel row. This is done by looking at the 'preferredIdentifier' field of the object.
529         * If it exists in the row, and the list of imported entities contains an object with the same
530         * identifier, the existing object is returned. Otherwise, null is returned
531         *
532         * @param       entity          Entity to search
533         * @param       excelRow        Excelrow to search for
534         * @param       mcmap           Map with MappingColumns
535         * @param       importedRows    List of entities that have been imported before. The function will first look through this list to find
536         *                                                      a matching entity.
537         * @return      An entity that has the same identifier as entered in the excelRow. The entity is first sought in the importedRows. If it
538         *                      is not found there, the database is queried. If no entity is found at all, null is returned.
539         */
540        def findEntityInImportedEntities( Class entity, Row excelRow, def mcmap, List importedEntities = [], DataFormatter df = null ) {
541                if( df == null )
542                        df = new DataFormatter();
543
544                def allFields = entity.giveDomainFields();
545                def identifierField = allFields.find { it.preferredIdentifier }
546
547                if( identifierField ) {
548                        // Check whether the identifierField is chosen in the column matching
549                        def identifierColumn = mcmap.find { it.entityclass == entity && it.property == identifierField.name };
550
551                        // If it is, find the identifier and look it up in the database
552                        if( identifierColumn ) {
553                                def identifierCell = excelRow.getCell( identifierColumn.index );
554                                def identifier;
555                                try {
556                                        identifier = formatValue(df.formatCellValue(identifierCell), identifierColumn.templatefieldtype)
557                                } catch (NumberFormatException nfe) {
558                                        identifier = null
559                                }
560
561                                // Search for an existing object with the same identifier.
562                                if( identifier ) {
563                                        // First search the already imported rows
564                                        if( importedEntities ) {
565                                                def imported = importedEntities.find {
566                                                        def fieldValue = it.getFieldValue( identifierField.name )
567
568                                                        if( fieldValue instanceof String )
569                                                                return fieldValue.toLowerCase() == identifier.toLowerCase();
570                                                        else
571                                                                return fieldValue == identifier
572                                                };
573                                                if( imported )
574                                                        return imported;
575                                        }
576                                }
577                        }
578                }
579
580                // No object is found
581                return null;
582        }
583
584
585        /**
586         * Creates relation between multiple entities that have been imported. The entities are
587         * all created from one row in the excel sheet.
588         */
589        def relateEntities( List entities) {
590                def study = entities.find { it instanceof Study }
591                def subject = entities.find { it instanceof Subject }
592                def sample = entities.find { it instanceof Sample }
593                def event = entities.find { it instanceof Event }
594                def samplingEvent = entities.find { it instanceof SamplingEvent }
595                def assay = entities.find { it instanceof Assay }
596
597                // A study object is found in the entity list
598                if( study ) {
599                        if( subject ) {
600                                subject.parent = study;
601                                study.addToSubjects( subject );
602                        }
603                        if( sample ) {
604                                sample.parent = study
605                                study.addToSamples( sample );
606                        }
607                        if( event ) {
608                                event.parent = study
609                                study.addToEvents( event );
610                        }
611                        if( samplingEvent ) {
612                                samplingEvent.parent = study
613                                study.addToSamplingEvents( samplingEvent );
614                        }
615                        if( assay ) {
616                                assay.parent = study;
617                                study.addToAssays( assay );
618                        }
619                }
620
621                if( sample ) {
622                        if( subject ) sample.parentSubject = subject
623                        if( samplingEvent ) sample.parentEvent = samplingEvent;
624                        if( event ) {
625                                def evGroup = new EventGroup();
626                                evGroup.addToEvents( event );
627                                if( subject ) evGroup.addToSubjects( subject );
628                                if( samplingEvent ) evGroup.addToSamplingEvents( samplingEvent );
629
630                                sample.parentEventGroup = evGroup;
631                        }
632
633                        if( assay ) assay.addToSamples( sample );
634                }
635        }
636
637        /**
638         * Method to read data from a workbook and to import data into a two dimensional
639         * array
640         *
641         * @param template_id template identifier to use fields from
642         * @param wb POI horrible spreadsheet formatted workbook object
643         * @param mcmap linked hashmap (preserved order) of MappingColumns
644         * @param sheetindex sheet to use when using multiple sheets
645         * @param rowindex first row to start with reading the actual data (NOT the header)
646         * @return two dimensional array containing records (with entities)
647         *
648         * @see dbnp.importer.MappingColumn
649         */
650        def importData(template_id, Workbook wb, int sheetindex, int rowindex, mcmap) {
651                def sheet = wb.getSheetAt(sheetindex)
652                def template = Template.get(template_id)
653                def table = []
654                def failedcells = [] // list of records
655                // walk through all rows and fill the table with records
656                (rowindex..sheet.getLastRowNum()).each { i ->
657                        // Create an entity record based on a row read from Excel and store the cells which failed to be mapped
658                        def (record, failed) = createRecord(template, sheet.getRow(i), mcmap)
659
660                        // Add record with entity and its values to the table
661                        table.add(record)
662
663                        // If failed cells have been found, add them to the failed cells list
664                        if (failed?.importcells?.size() > 0) failedcells.add(failed)
665                }
666
667                return [table, failedcells]
668        }
669
670        /**
671         * Removes a cell from the failedCells list, based on the entity and field. If the entity and field didn't fail before
672         * the method doesn't do anything.
673         *
674         * @param failedcell    list of cells that have failed previously
675         * @param entity                entity to remove from the failedcells list
676         * @param field                 field to remove the failed cell for. If no field is given, all cells for this entity will be removed
677         * @return List                 Updated list of cells that have failed
678         */
679        def removeFailedCell(failedcells, entity, field = null ) {
680                if( !entity )
681                        return failedcells;
682
683                def filterClosure
684                if( field ) {
685                        def entityIdField = "entity_" + entity.getIdentifier() + "_" + field.name.toLowerCase()
686                        filterClosure = { cell -> cell.entityidentifier != entityIdField }
687                } else {
688                        def entityIdField = "entity_" + entity.getIdentifier() + "_"
689                        filterClosure = { cell -> !cell.entityidentifier.startsWith( entityIdField ) }
690                }
691
692                failedcells.each { record ->
693                        record.importcells = record.importcells.findAll( filterClosure )
694                }
695
696                return failedcells;
697        }
698
699        /**
700         * Returns the name of an input field as it is used for a specific entity in HTML.
701         *
702         * @param entity                entity to retrieve the field name for
703         * @param field                 field to retrieve the field name for
704         * @return String               Name of the HTML field for the given entity and field. Can also be used in the map
705         *                                              of request parameters
706         */
707        def getFieldNameInTableEditor(entity, field) {
708                def entityName = entity?.class.name[ entity?.class.name.lastIndexOf(".") + 1..-1]
709
710                if( field instanceof TemplateField )
711                        field = field.escapedName();
712
713                return entityName.toLowerCase() + "_" + entity.getIdentifier() + "_" + field.toLowerCase()
714        }
715
716        /**
717         * Retrieves a mapping column from a list based on the given fieldname
718         * @param mappingColumns                List of mapping columns
719         * @param fieldName                             Field name to find
720         * @return                                              Mapping column if a column is found, null otherwise
721         */
722        def findMappingColumn( mappingColumns, String fieldName ) {
723                return mappingColumns.find { it.property == fieldName.toLowerCase() }
724        }
725
726        /** Method to put failed cells back into the datamatrix. Failed cells are cell values
727         * which could not be stored in an entity (e.g. Humu Supiuns in an ontology field).
728         * Empty corrections should not be stored
729         *
730         * @param datamatrix two dimensional array containing entities and possibly also failed cells
731         * @param failedcells list with maps of failed cells in [mappingcolumn, cell] format
732         * @param correctedcells map of corrected cells in [cellhashcode, value] format
733         * */
734        def saveCorrectedCells(datamatrix, failedcells, correctedcells) {
735
736                // Loop through all failed cells (stored as
737                failedcells.each { record ->
738                        record.value.importcells.each { cell ->
739
740                                // Get the corrected value
741                                def correctedvalue = correctedcells.find { it.key.toInteger() == cell.getIdentifier()}.value
742
743                                // Find the record in the table which the mappingcolumn belongs to
744                                def tablerecord = datamatrix.find { it.hashCode() == record.key }
745
746                                // Loop through all entities in the record and correct them if necessary
747                                tablerecord.each { rec ->
748                                        rec.each { entity ->
749                                                try {
750                                                        // Update the entity field
751                                                        entity.setFieldValue(cell.mappingcolumn.property, correctedvalue)
752                                                        //log.info "Adjusted " + cell.mappingcolumn.property + " to " + correctedvalue
753                                                }
754                                                catch (Exception e) {
755                                                        //log.info "Could not map corrected ontology: " + cell.mappingcolumn.property + " to " + correctedvalue
756                                                }
757                                        }
758                                } // end of table record
759                        } // end of cell record
760                } // end of failedlist
761        }
762
763        /**
764         * Method to store a matrix containing the entities in a record like structure. Every row in the table
765         * contains one or more entity objects (which contain fields with values). So actually a row represents
766         * a record with fields from one or more different entities.
767         *
768         * @param study entity Study
769         * @param datamatrix two dimensional array containing entities with values read from Excel file
770         */
771        static saveDatamatrix(Study study, importerEntityType, datamatrix, authenticationService, log) {
772                def validatedSuccesfully = 0
773                def entitystored = null
774
775                // Study passed? Sync data
776                if (study != null && importerEntityType != 'Study') study.refresh()
777
778                // go through the data matrix, read every record and validate the entity and try to persist it
779                datamatrix.each { record ->
780                        record.each { entity ->
781                                switch (entity.getClass()) {
782                                        case Study: log.info ".importer wizard, persisting Study `" + entity + "`: "
783                                                entity.owner = authenticationService.getLoggedInUser()
784
785                                                if (entity.validate()) {
786                                                        if (!entity.save(flush:true)) {
787                                                                log.error ".importer wizard, study could not be saved: " + entity
788                                                                throw new Exception('.importer wizard, study could not be saved: ' + entity)
789                                                        }
790                                                } else {
791                                                        log.error ".importer wizard, study could not be validated: " + entity
792                                                        throw new Exception('.importer wizard, study could not be validated: ' + entity)
793                                                }
794
795                                                break
796                                        case Subject: log.info ".importer wizard, persisting Subject `" + entity + "`: "
797
798                                        // is the current entity not already in the database?
799                                        //entitystored = isEntityStored(entity)
800
801                                        // this entity is new, so add it to the study
802                                        //if (entitystored==null)
803
804                                                study.addToSubjects(entity)
805
806                                                break
807                                        case Event: log.info ".importer wizard, persisting Event `" + entity + "`: "
808                                                study.addToEvents(entity)
809                                                break
810                                        case Sample: log.info ".importer wizard, persisting Sample `" + entity + "`: "
811
812                                        // is this sample validatable (sample name unique for example?)
813                                                study.addToSamples(entity)
814
815                                                break
816                                        case SamplingEvent: log.info ".importer wizard, persisting SamplingEvent `" + entity + "`: "
817                                                study.addToSamplingEvents(entity)
818                                                break
819                                        default: log.info ".importer wizard, skipping persisting of `" + entity.getclass() + "`"
820                                                break
821                                } // end switch
822                        } // end record
823                } // end datamatrix
824
825                // validate study
826                if (importerEntityType != 'Study') {
827                        if (study.validate()) {
828                                if (!study.save(flush: true)) {
829                                        //this.appendErrors(flow.study, flash.wizardErrors)
830                                        throw new Exception('.importer wizard [saveDatamatrix] error while saving study')
831                                }
832                        } else {
833                                throw new Exception('.importer wizard [saveDatamatrix] study does not validate')
834                        }
835                }
836
837                //persistEntity(study)
838
839                //return [validatedSuccesfully, updatedentities, failedtopersist]
840                //return [0,0,0]
841                return true
842        }
843
844        /**
845         * Check whether an entity already exist. A unique field in the entity is
846         * used to check whether the instantiated entity (read from Excel) is new.
847         * If the entity is found in the database it will be returned as is.
848         *
849         * @param entity entity object like a Study, Subject, Sample et cetera
850         * @return entity if found, otherwise null
851         */
852        def isEntityStored(entity) {
853                switch (entity.getClass()) {
854                        case Study: return Study.findByCode(entity.code)
855                                break
856                        case Subject: return Subject.findByParentAndName(entity.parent, entity.name)
857                                break
858                        case Event: break
859                        case Sample:
860                                break
861                        case SamplingEvent: break
862                        default:  // unknown entity
863                                return null
864                }
865        }
866
867        /**
868         * Find the entity and update the fields. The entity is an instance
869         * read from Excel. This method looks in the database for the entity
870         * having the same identifier. If it has found the same entity
871         * already in the database, it will update the record.
872         *
873         * @param entitystored existing record in the database to update
874         * @param entity entity read from Excel
875         */
876        def updateEntity(entitystored, entity) {
877                switch (entity.getClass()) {
878                        case Study: break
879                        case Subject: entitystored.properties = entity.properties
880                                entitystored.save()
881                                break
882                        case Event: break
883                        case Sample: break
884                        case SamplingEvent: break
885                        default:  // unknown entity
886                                return null
887                }
888        }
889
890        /**
891         * Method to persist entities into the database
892         * Checks whether entity already exists (based on identifier column 'name')
893         *
894         * @param entity entity object like Study, Subject, Protocol et cetera
895         *
896         */
897        boolean persistEntity(entity) {
898                /*log.info ".import wizard persisting ${entity}"
899                 try {           
900                 entity.save(flush: true)
901                 return true
902                 } catch (Exception e) {
903                 def session = sessionFactory.currentSession
904                 session.setFlushMode(org.hibernate.FlushMode.MANUAL)
905                 log.error ".import wizard, failed to save entity:\n" + org.apache.commons.lang.exception.ExceptionUtils.getRootCauseMessage(e)
906                 }
907                 return true*/
908                //println "persistEntity"
909        }
910
911        /**
912         * This method creates a record (array) containing entities with values
913         *
914         * @param template_id template identifier
915         * @param excelrow POI based Excel row containing the cells
916         * @param mcmap map containing MappingColumn objects
917         * @return list of entities and list of failed cells
918         */
919        def createRecord(template, Row excelrow, mcmap) {
920                def df = new DataFormatter()
921                def tft = TemplateFieldType
922                def record = [] // list of entities and the read values
923                def failed = new ImportRecord() // map with entity identifier and failed mappingcolumn
924
925                // Initialize all possible entities with the chosen template
926                def study = new Study(template: template)
927                def subject = new Subject(template: template)
928                def samplingEvent = new SamplingEvent(template: template)
929                def event = new Event(template: template)
930                def sample = new Sample(template: template)
931
932                // Go through the Excel row cell by cell
933                for (Cell cell: excelrow) {
934                        // get the MappingColumn information of the current cell
935                        def mc = mcmap[cell.getColumnIndex()]
936                        def value
937
938                        // Check if column must be imported
939                        if (mc != null) if (!mc.dontimport) {
940                                try {
941                                        value = formatValue(df.formatCellValue(cell), mc.templatefieldtype)
942                                } catch (NumberFormatException nfe) {
943                                        value = ""
944                                }
945
946                                try {
947                                        // which entity does the current cell (field) belong to?
948                                        switch (mc.entityclass) {
949                                                case Study: // does the entity already exist in the record? If not make it so.
950                                                        (record.any {it.getClass() == mc.entityclass}) ? 0 : record.add(study)
951                                                        study.setFieldValue(mc.property, value)
952                                                        break
953                                                case Subject: (record.any {it.getClass() == mc.entityclass}) ? 0 : record.add(subject)
954                                                        subject.setFieldValue(mc.property, value)
955                                                        break
956                                                case SamplingEvent: (record.any {it.getClass() == mc.entityclass}) ? 0 : record.add(samplingEvent)
957                                                        samplingEvent.setFieldValue(mc.property, value)
958                                                        break
959                                                case Event: (record.any {it.getClass() == mc.entityclass}) ? 0 : record.add(event)
960                                                        event.setFieldValue(mc.property, value)
961                                                        break
962                                                case Sample: (record.any {it.getClass() == mc.entityclass}) ? 0 : record.add(sample)
963                                                        sample.setFieldValue(mc.property, value)
964                                                        break
965                                                case Object:   // don't import
966                                                        break
967                                        } // end switch
968                                } catch (Exception iae) {
969                                        log.error ".import wizard error could not set property `" + mc.property + "` to value `" + value + "`"
970                                        // store the mapping column and value which failed
971                                        def identifier
972                                        def fieldName = mc.property?.toLowerCase()
973                                       
974                                        switch (mc.entityclass) {
975                                                case Study: identifier = "entity_" + study.getIdentifier() + "_" + fieldName
976                                                        break
977                                                case Subject: identifier = "entity_" + subject.getIdentifier() + "_" + fieldName
978                                                        break
979                                                case SamplingEvent: identifier = "entity_" + samplingEvent.getIdentifier() + "_" + fieldName
980                                                        break
981                                                case Event: identifier = "entity_" + event.getIdentifier() + "_" + fieldName
982                                                        break
983                                                case Sample: identifier = "entity_" + sample.getIdentifier() + "_" + fieldName
984                                                        break
985                                                case Object:   // don't import
986                                                        break
987                                        }
988
989                                        def mcInstance = new MappingColumn()
990                                        mcInstance.properties = mc.properties
991                                        failed.addToImportcells(new ImportCell(mappingcolumn: mcInstance, value: value, entityidentifier: identifier))
992                                }
993                        } // end
994                } // end for
995                // a failed column means that using the entity.setFieldValue() threw an exception
996                return [record, failed]
997        }
998
999        /**
1000         * Method to parse a value conform a specific type
1001         * @param value string containing the value
1002         * @return object corresponding to the TemplateFieldType
1003         */
1004        def formatValue(String value, TemplateFieldType type) throws NumberFormatException {
1005                switch (type) {
1006                        case TemplateFieldType.STRING: return value.trim()
1007                        case TemplateFieldType.TEXT: return value.trim()
1008                        case TemplateFieldType.LONG: return (long) Double.valueOf(value)
1009                        //case TemplateFieldType.FLOAT      :   return Float.valueOf(value.replace(",","."));
1010                        case TemplateFieldType.DOUBLE: return Double.valueOf(value.replace(",", "."));
1011                        case TemplateFieldType.STRINGLIST: return value.trim()
1012                        case TemplateFieldType.ONTOLOGYTERM: return value.trim()
1013                        case TemplateFieldType.DATE: return value
1014                        default: return value
1015                }
1016        }
1017
1018        /**
1019         * Returns the preferred identifier field for a given entity or
1020         * null if no preferred identifier is given
1021         * @param entity        TemplateEntity class
1022         * @return      The preferred identifier field or NULL if no preferred identifier is given
1023         */
1024        public TemplateField givePreferredIdentifier( Class entity ) {
1025                def allFields = entity.giveDomainFields();
1026                return allFields.find { it.preferredIdentifier }
1027        }
1028
1029        // classes for fuzzy string matching
1030        // <FUZZY MATCHING>
1031
1032        static def similarity(l_seq, r_seq, degree = 2) {
1033                def l_histo = countNgramFrequency(l_seq, degree)
1034                def r_histo = countNgramFrequency(r_seq, degree)
1035
1036                dotProduct(l_histo, r_histo) /
1037                                Math.sqrt(dotProduct(l_histo, l_histo) *
1038                                dotProduct(r_histo, r_histo))
1039        }
1040
1041        static def countNgramFrequency(sequence, degree) {
1042                def histo = [:]
1043                def items = sequence.size()
1044
1045                for (int i = 0; i + degree <= items; i++) {
1046                        def gram = sequence[i..<(i + degree)]
1047                        histo[gram] = 1 + histo.get(gram, 0)
1048                }
1049                histo
1050        }
1051
1052        static def dotProduct(l_histo, r_histo) {
1053                def sum = 0
1054                l_histo.each { key, value ->
1055                        sum = sum + l_histo[key] * r_histo.get(key, 0)
1056                }
1057                sum
1058        }
1059
1060        static def stringSimilarity(l_str, r_str, degree = 2) {
1061
1062                similarity(l_str.toString().toLowerCase().toCharArray(),
1063                                r_str.toString().toLowerCase().toCharArray(),
1064                                degree)
1065        }
1066
1067        static def mostSimilar(pattern, candidates, threshold = 0) {
1068                def topScore = 0
1069                def bestFit = null
1070
1071                candidates.each { candidate ->
1072                        def score = stringSimilarity(pattern, candidate)
1073                        if (score > topScore) {
1074                                topScore = score
1075                                bestFit = candidate
1076                        }
1077                }
1078
1079                if (topScore < threshold)
1080                        bestFit = null
1081
1082                bestFit
1083        }
1084        // </FUZZY MATCHING>
1085
1086}
Note: See TracBrowser for help on using the browser.