source: trunk/grails-app/services/dbnp/importer/ImporterService.groovy @ 1207

Last change on this file since 1207 was 1207, checked in by t.w.abma@…, 10 years ago
  • added an initial simple overview in last step of import wizard showing entities which failed to be persisted
  • Property svn:keywords set to Date Author Rev
File size: 22.3 KB
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: 1207 $
13 * $Author: t.w.abma@umcutrecht.nl $
14 * $Date: 2010-11-26 12:02:51 +0000 (vr, 26 nov 2010) $
15 */
16
17package dbnp.importer
18import org.apache.poi.ss.usermodel.*
19
20import dbnp.studycapturing.TemplateFieldType
21import dbnp.studycapturing.Template
22import dbnp.studycapturing.SamplingEvent
23import dbnp.studycapturing.Study
24import dbnp.studycapturing.Subject
25import dbnp.studycapturing.Event
26import dbnp.studycapturing.Sample
27
28class ImporterService {
29    def AuthenticationService
30
31    boolean transactional = true
32
33    /**
34    * @param is input stream representing the (workbook) resource
35    * @return high level representation of the workbook
36    */
37    Workbook getWorkbook(InputStream is) {
38        WorkbookFactory.create(is)
39    }
40
41    /**
42     * @param wb high level representation of the workbook
43     * @param sheetindex sheet to use within the workbook
44     * @return header representation as a MappingColumn hashmap
45     */
46    def getHeader(Workbook wb, int sheetindex, int headerrow, int datamatrix_start, theEntity=null){
47
48        def sheet = wb.getSheetAt(sheetindex)   
49        def sheetrow = sheet.getRow(datamatrix_start)
50        //def header = []
51        def header = [:]
52        def df = new DataFormatter()
53        def property = new String()
54
55        //for (Cell c: sheet.getRow(datamatrix_start)) {
56
57        (0..sheetrow.getLastCellNum() -1 ).each { columnindex ->
58
59            //def index =   c.getColumnIndex()
60            def datamatrix_celltype = sheet.getRow(datamatrix_start).getCell(columnindex,Row.CREATE_NULL_AS_BLANK).getCellType()
61            def datamatrix_celldata = df.formatCellValue(sheet.getRow(datamatrix_start).getCell(columnindex))
62            def datamatrix_cell     = sheet.getRow(datamatrix_start).getCell(columnindex)           
63            def headercell = sheet.getRow(headerrow-1+sheet.getFirstRowNum()).getCell(columnindex)
64            def tft = TemplateFieldType.STRING //default templatefield type
65
66            // Check for every celltype, currently redundant code, but possibly this will be
67            // a piece of custom code for every cell type like specific formatting         
68               
69            switch (datamatrix_celltype) {
70                    case Cell.CELL_TYPE_STRING:
71                            //parse cell value as double
72                            def doubleBoolean = true
73                            def fieldtype = TemplateFieldType.STRING
74
75                            // is this string perhaps a double?
76                            try {
77                                formatValue(datamatrix_celldata, TemplateFieldType.DOUBLE)
78                            } catch (NumberFormatException nfe) { doubleBoolean = false }
79                            finally {
80                                if (doubleBoolean) fieldtype = TemplateFieldType.DOUBLE
81                            }
82
83                            header[columnindex] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell),
84                                                                            templatefieldtype:fieldtype,
85                                                                            index:columnindex,
86                                                                            entity:theEntity,
87                                                                            property:property);
88
89                            break
90                    case Cell.CELL_TYPE_NUMERIC:
91                            def fieldtype = TemplateFieldType.LONG
92                            def doubleBoolean = true
93                            def longBoolean = true
94
95                            // is this cell really an integer?
96                            try {
97                                Long.valueOf(datamatrix_celldata)
98                            } catch (NumberFormatException nfe) { longBoolean = false }
99                            finally {
100                                if (longBoolean) fieldtype = TemplateFieldType.LONG
101                            }
102
103                            // it's not an long, perhaps a double?
104                            if (!longBoolean)
105                                try {
106                                    formatValue(datamatrix_celldata, TemplateFieldType.DOUBLE)
107                                } catch (NumberFormatException nfe) { doubleBoolean = false }
108                                finally {
109                                    if (doubleBoolean) fieldtype = TemplateFieldType.DOUBLE
110                                }
111
112                            if (DateUtil.isCellDateFormatted(datamatrix_cell)) fieldtype = TemplateFieldType.DATE
113
114                            header[columnindex] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell),
115                                                                            templatefieldtype:fieldtype,
116                                                                            index:columnindex,
117                                                                            entity:theEntity,
118                                                                            property:property);
119                            break
120                    case Cell.CELL_TYPE_BLANK:
121                            header[columnindex] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell),
122                                                                            templatefieldtype:TemplateFieldType.STRING,
123                                                                            index:columnindex,
124                                                                            entity:theEntity,
125                                                                            property:property);
126                            break
127                    default:
128                            header[columnindex] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell),
129                                                                            templatefieldtype:TemplateFieldType.STRING,
130                                                                            index:columnindex,
131                                                                            entity:theEntity,
132                                                                            property:property);
133                            break
134            } // end of switch
135        } // end of cell loop
136        return header
137    }
138
139    /**
140     * This method is meant to return a matrix of the rows and columns
141     * used in the preview
142     *
143     * @param wb workbook object
144     * @param sheetindex sheet index used
145     * @param rows amount of rows returned
146     * @return two dimensional array (matrix) of Cell objects
147     */
148
149    Cell[][] getDatamatrix(Workbook wb, header, int sheetindex, int datamatrix_start, int count) {
150        def sheet = wb.getSheetAt(sheetindex)
151        def rows  = []
152        def df = new DataFormatter()
153
154        count = (count < sheet.getLastRowNum()) ? count : sheet.getLastRowNum()
155
156        // walk through all rows       
157        ((datamatrix_start+sheet.getFirstRowNum())..count).each { rowindex ->
158            def row = []
159
160            // walk through every cell
161            /*for (Cell c: sheet.getRow(rowindex)) {
162                row.add(c)
163                println c.getColumnIndex() + "=" +c
164            }*/
165           
166            (0..header.size()-1).each { columnindex ->
167                def c = sheet.getRow(rowindex).getCell(columnindex, Row.CREATE_NULL_AS_BLANK)
168                //row.add(df.formatCellValue(c))
169                row.add(c)
170            }
171            rows.add(row)
172        }
173
174        return rows
175    }
176
177    /**
178    * This method will move a file to a new location.
179    *
180    * @param file File object to move
181    * @param folderpath folder to move the file to
182    * @param filename (new) filename to give
183    * @return if file has been moved succesful, the new path and filename will be returned, otherwise an empty string will be returned
184    */
185    def moveFile(File file, String folderpath, String filename) {
186        try {
187                def rnd = ""; //System.currentTimeMillis()
188                file.transferTo(new File(folderpath, rnd+filename))
189                return folderpath + filename
190            } catch(Exception exception) {
191                log.error "File move error, ${exception}"
192                return ""
193                }
194    }
195
196    /**
197    * @return random numeric value
198    */
199    def random = {
200            return System.currentTimeMillis() + Runtime.runtime.freeMemory()
201        }
202
203    /**
204    * Method to read data from a workbook and to import data into a two dimensional
205    * array
206    *
207    * @param template_id template identifier to use fields from
208    * @param wb POI horrible spreadsheet formatted workbook object
209    * @param mcmap linked hashmap (preserved order) of MappingColumns
210    * @param sheetindex sheet to use when using multiple sheets
211    * @param rowindex first row to start with reading the actual data (NOT the header)
212    * @return two dimensional array containing records (with entities)
213    *
214    * @see dbnp.importer.MappingColumn
215    */
216    def importData(template_id, Workbook wb, int sheetindex, int rowindex, mcmap) {
217        def sheet = wb.getSheetAt(sheetindex)
218        def table = []
219        def failedcells = [] // list of records
220       
221        // walk through all rows and fill the table with records
222        (rowindex..sheet.getLastRowNum()).each { i ->       
223            // Create an entity record based on a row read from Excel and store the cells which failed to be mapped
224            def (record, failed) = createRecord(template_id, sheet.getRow(i), mcmap)
225
226            // Add record with entity and its values to the table
227            table.add(record)
228
229            // If failed cells have been found, add them to the failed cells list           
230            if (failed?.importcells?.size()>0) failedcells.add(failed)
231        }
232
233        return [table,failedcells]
234    }
235
236    /** Method to put failed cells back into the datamatrix. Failed cells are cell values
237     * which could not be stored in an entity (e.g. Humu Supiuns in an ontology field).
238     * Empty corrections should not be stored
239     *
240     * @param datamatrix two dimensional array containing entities and possibly also failed cells
241     * @param failedcells list with maps of failed cells in [mappingcolumn, cell] format
242     * @param correctedcells map of corrected cells in [cellhashcode, value] format
243     **/
244    def saveCorrectedCells(datamatrix, failedcells, correctedcells) {       
245       
246        // Loop through all failed cells (stored as
247        failedcells.each { record ->
248            record.value.importcells.each { cell ->
249
250                  // Get the corrected value
251                  def correctedvalue = correctedcells.find { it.key.toInteger() == cell.getIdentifier()}.value
252
253                  // Find the record in the table which the mappingcolumn belongs to
254                  def tablerecord = datamatrix.find { it.hashCode() == record.key }
255
256                  // Loop through all entities in the record and correct them if necessary
257                  tablerecord.each { rec ->
258                      rec.each { entity ->
259                            try {
260                                // Update the entity field
261                                entity.setFieldValue(cell.mappingcolumn.property, correctedvalue)
262                                //println "Adjusted " + cell.mappingcolumn.property + " to " + correctedvalue
263                            }
264                            catch (Exception e) {
265                                //println "Could not map corrected ontology: " + cell.mappingcolumn.property + " to " + correctedvalue
266                            }
267                      }
268                  } // end of table record
269               } // end of cell record
270            } // end of failedlist
271    }
272   
273    /**
274     * Method to store a matrix containing the entities in a record like structure. Every row in the table
275     * contains one or more entity objects (which contain fields with values). So actually a row represents
276     * a record with fields from one or more different entities.
277     *
278     * @param study entity Study
279     * @param datamatrix two dimensional array containing entities with values read from Excel file
280     */   
281    def saveDatamatrix(Study study, datamatrix) {
282        def validatedSuccesfully = 0
283        def entitystored = null
284        def failedtopersist = []
285        def updatedentities = []
286        study.refresh()
287       
288        // go through the data matrix, read every record and validate the entity and try to persist it
289        datamatrix.each { record ->
290            record.each { entity ->
291                        switch (entity.getClass()) {
292                        case Study       :  print "Persisting Study `" + entity + "`: "
293                                                entity.owner = AuthenticationService.getLoggedInUser()
294                                                if (persistEntity(entity)) validatedSuccesfully++;
295                                                    else failedtopersist.add(entity)
296                                                break
297                        case Subject     :  print "Persisting Subject `" + entity + "`: "
298                                                entity.parent = study
299                                               
300                                                // is the current entity not already in the database?
301                                                entitystored = isEntityStored(entity)
302                                               
303                                                // this entity is new, so add it to the study
304                                                if (entitystored==null) study.addToSubjects(entity)
305                                                else { // existing entity, so update it
306                                                    updateEntity(entitystored, entity)
307                                                    updatedentities.add(entity)
308                                                }
309
310                                                if (persistEntity(study)) validatedSuccesfully++;
311                                                    else failedtopersist.add(entity)
312                                                break
313                        case Event       :  print "Persisting Event `" + entity + "`: "
314                                                entity.parent = study
315                                                study.addToEvents(entity)
316                                                if (persistEntity(entity)) validatedSuccesfully++;
317                                                    else failedtopersist.add(entity)
318                                                break
319                        case Sample      :  print "Persisting Sample `" + entity +"`: "                                               
320                                                entity.parent = study
321                                               
322                                                // is this sample validatable (sample name unique for example?)
323                                                if (entity.validate()) {
324                                                    study.addToSamples(entity)
325                                                    if (persistEntity(study)) validatedSuccesfully++;                                                       
326                                                } else failedtopersist.add(entity)
327                                               
328                                                break
329                        case SamplingEvent: print "Persisting SamplingEvent `" + entity + "`: "
330                                                entity.parent = study
331                                                study.addToSamplingEvents(entity)
332                                                if (persistEntity(entity)) validatedSuccesfully++;
333                                                    else failedtopersist.add(entity)
334                                                break
335                        default          :  println "Skipping persisting of `" + entity.getclass() +"`"
336                                                failedtopersist.add(entity)
337                                                break
338                        } // end switch
339            } // end record
340        } // end datamatrix
341        return [validatedSuccesfully, updatedentities, failedtopersist]
342    }
343
344    /**
345     * Check whether an entity already exist. A unique field in the entity is
346     * used to check whether the instantiated entity (read from Excel) is new.
347     * If the entity is found in the database it will be returned as is.
348     *
349     * @param entity entity object like a Study, Subject, Sample et cetera
350     * @return entity if found, otherwise null
351     */
352    def isEntityStored(entity) {
353            switch (entity.getClass()) {
354                        case Study          :  return Study.findByCode(entity.code)
355                                               break
356                        case Subject        :  return Subject.findByParentAndName(entity.parent, entity.name)
357                                               break
358                        case Event          :  break
359                        case Sample         :
360                                               break
361                        case SamplingEvent  :  break
362                        default             :  // unknown entity
363                                               return null
364            }
365    }
366
367    /**
368     * Find the entity and update the fields. The entity is an instance
369     * read from Excel. This method looks in the database for the entity
370     * having the same identifier. If it has found the same entity
371     * already in the database, it will update the record.
372     *
373     * @param entitystored existing record in the database to update
374     * @param entity entity read from Excel
375     */
376    def updateEntity(entitystored, entity) {
377        switch (entity.getClass()) {
378                        case Study          :  break
379                        case Subject        :  entitystored.properties = entity.properties
380                                               entitystored.save()
381                                               break
382                        case Event          :  break
383                        case Sample         :  break
384                        case SamplingEvent  :  break
385                        default             :  // unknown entity
386                                               return null
387        }
388    }
389
390    /**
391     * Method to persist entities into the database
392     * Checks whether entity already exists (based on identifier column 'name')
393     *
394     * @param entity entity object like Study, Subject, Protocol et cetera
395     *
396     */
397    boolean persistEntity(entity) {
398            println "persisting ${entity}"           
399            // if not validated
400                if (entity.validate()) {
401                        if (entity.save(flush:true)) { //.merge?
402                                return true
403                        }
404                        else { // if save was unsuccesful
405                                entity.errors.allErrors.each {
406                                        println it
407                                }
408                                return false
409                        }
410                }
411            else { // if not validated
412                    entity.errors.each {
413                            println it
414                    }
415                        return false
416            }
417         }
418
419        /**
420         * This method creates a record (array) containing entities with values
421         *
422         * @param template_id template identifier
423         * @param excelrow POI based Excel row containing the cells
424         * @param mcmap map containing MappingColumn objects
425         * @return list of entities and list of failed cells
426         */
427        def createRecord(template_id, Row excelrow, mcmap) {
428                def df = new DataFormatter()
429                def template = Template.get(template_id)
430                def tft = TemplateFieldType
431                def record = [] // list of entities and the read values
432                def failed = new ImportRecord() // map with entity identifier and failed mappingcolumn
433
434                // Initialize all possible entities with the chosen template
435                def study = new Study(template: template)
436                def subject = new Subject(template: template)
437                def samplingEvent = new SamplingEvent(template: template)
438                def event = new Event(template: template)
439                def sample = new Sample(template: template)
440
441                // Go through the Excel row cell by cell
442                for (Cell cell: excelrow) {
443                        // get the MappingColumn information of the current cell
444                        def mc = mcmap[cell.getColumnIndex()]
445                        def value                       
446
447                        // Check if column must be imported
448                        if (mc!=null) if (!mc.dontimport) {
449                                try {
450                                        value = formatValue(df.formatCellValue(cell), mc.templatefieldtype)
451                                } catch (NumberFormatException nfe) {
452                                        value = ""
453                                }
454
455                                try {
456                                // which entity does the current cell (field) belong to?
457                                    switch (mc.entity) {
458                                        case Study: // does the entity already exist in the record? If not make it so.
459                                                (record.any {it.getClass() == mc.entity}) ? 0 : record.add(study)
460                                                study.setFieldValue(mc.property, value)
461                                                break
462                                        case Subject: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(subject)
463                                                subject.setFieldValue(mc.property, value)
464                                                break
465                                        case SamplingEvent: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(samplingEvent)
466                                                samplingEvent.setFieldValue(mc.property, value)
467                                                break
468                                        case Event: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(event)
469                                                event.setFieldValue(mc.property, value)
470                                                break
471                                        case Sample: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(sample)
472                                                sample.setFieldValue(mc.property, value)
473                                                break
474                                        case Object:   // don't import
475                                                break
476                                    } // end switch
477                                } catch (IllegalArgumentException iae) {
478                                    // store the mapping column and value which failed
479                                    def identifier
480
481                                    switch (mc.entity) {
482                                        case Study:  identifier = study.getIdentifier()
483                                                break
484                                        case Subject: identifier = subject.getIdentifier()
485                                                break
486                                        case SamplingEvent: identifier = samplingEvent.getIdentifier()
487                                                break
488                                        case Event: identifier = event.getIdentifier()                                         
489                                                break
490                                        case Sample: identifier = sample.getIdentifier()
491                                                break
492                                        case Object:   // don't import
493                                                break
494                                    }
495                                   
496                                    def mcInstance = new MappingColumn()
497                                    mcInstance.properties = mc.properties
498                                    failed.addToImportcells(new ImportCell(mappingcolumn:mcInstance, value:value, entityidentifier:identifier))
499                                }
500                        } // end
501                } // end for
502        // a failed column means that using the entity.setFieldValue() threw an exception       
503        return [record, failed]
504    }
505
506    /**
507    * Method to parse a value conform a specific type
508    * @param value string containing the value
509    * @return object corresponding to the TemplateFieldType
510    */
511    def formatValue(String value, TemplateFieldType type) throws NumberFormatException {
512            switch (type) {
513                case TemplateFieldType.STRING       :   return value.trim()
514                case TemplateFieldType.TEXT         :   return value.trim()
515                case TemplateFieldType.LONG         :   return (long) Double.valueOf(value)
516                //case TemplateFieldType.FLOAT      :   return Float.valueOf(value.replace(",","."));
517                case TemplateFieldType.DOUBLE       :   return Double.valueOf(value.replace(",","."));
518                case TemplateFieldType.STRINGLIST   :   return value.trim()
519                case TemplateFieldType.ONTOLOGYTERM :   return value.trim()
520                case TemplateFieldType.DATE         :   return value
521                default                             :   return value
522            }
523    }
524
525    // classes for fuzzy string matching
526    // <FUZZY MATCHING>
527    static def similarity(l_seq, r_seq, degree=2) {
528        def l_histo = countNgramFrequency(l_seq, degree)
529        def r_histo = countNgramFrequency(r_seq, degree)
530
531        dotProduct(l_histo, r_histo) /
532        Math.sqrt(dotProduct(l_histo, l_histo) *
533            dotProduct(r_histo, r_histo))
534    }
535
536    static def countNgramFrequency(sequence, degree) {
537        def histo = [:]
538        def items = sequence.size()
539
540        for (int i = 0; i + degree <= items; i++)
541        {
542            def gram = sequence[i..<(i + degree)]
543            histo[gram] = 1 + histo.get(gram, 0)
544        }
545        histo
546    }
547
548    static def dotProduct(l_histo, r_histo) {
549        def sum = 0
550        l_histo.each { key, value ->
551            sum = sum + l_histo[key] * r_histo.get(key, 0)
552        }
553        sum
554    }
555
556    static def stringSimilarity (l_str, r_str, degree=2) {
557       
558        similarity(l_str.toString().toLowerCase().toCharArray(),
559            r_str.toString().toLowerCase().toCharArray(),
560            degree)
561    }
562
563    static def mostSimilar(pattern, candidates, threshold=0) {
564        def topScore = 0
565        def bestFit = null
566
567        candidates.each { candidate ->
568            def score = stringSimilarity(pattern, candidate)
569            if (score > topScore) {
570                topScore = score
571                bestFit = candidate
572            }
573        }
574
575        if (topScore < threshold)
576        bestFit = null
577
578        bestFit
579    }
580    // </FUZZY MATCHING>
581
582}
Note: See TracBrowser for help on using the repository browser.