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

Revision 1317, 23.3 KB (checked in by t.w.abma@…, 3 years ago)

- seems that depending on the Excel-sheet type a XSSFCell or HSSFCell is returned, now works with both

  • Property svn:keywords set to Date Author Rev
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 */
16
17package dbnp.importer
18import org.apache.poi.ss.usermodel.*
19import org.apache.poi.xssf.usermodel.XSSFCell
20
21import dbnp.studycapturing.TemplateFieldType
22import dbnp.studycapturing.Template
23import dbnp.studycapturing.SamplingEvent
24import dbnp.studycapturing.Study
25import dbnp.studycapturing.Subject
26import dbnp.studycapturing.Event
27import dbnp.studycapturing.Sample
28
29class ImporterService {
30    def AuthenticationService
31
32    boolean transactional = true
33
34    /**
35    * @param is input stream representing the (workbook) resource
36    * @return high level representation of the workbook
37    */
38    Workbook getWorkbook(InputStream is) {
39        WorkbookFactory.create(is)
40    }
41
42    /**
43     * @param wb high level representation of the workbook
44     * @param sheetindex sheet to use within the workbook
45     * @return header representation as a MappingColumn hashmap
46     */
47    def getHeader(Workbook wb, int sheetindex, int headerrow, int datamatrix_start, theEntity=null) {
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    Object[][] 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(c)
169            }
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 persisterrors = []
286    def updatedentities = []
287    study.refresh()
288       
289        // go through the data matrix, read every record and validate the entity and try to persist it
290        datamatrix.each { record ->
291            record.each { entity ->           
292                        switch (entity.getClass()) {
293                        case Study       :  log.info "Persisting Study `" + entity + "`: "
294                                                entity.owner = AuthenticationService.getLoggedInUser()                                             
295                                                if (persistEntity(entity)) validatedSuccesfully++;
296                                                    else failedtopersist.add(entity)
297                                        break
298                        case Subject :  log.info "Persisting Subject `" + entity + "`: "
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       :  log.info "Persisting Event `" + entity + "`: "                                     
314                                        study.addToEvents(entity)
315                                        if (persistEntity(entity)) validatedSuccesfully++;
316                                            else failedtopersist.add(entity)
317                                        break
318                        case Sample      :  log.info "Persisting Sample `" + entity +"`: "                                     
319                                               
320                                        // is this sample validatable (sample name unique for example?)
321                                        if (entity.validate()) {
322                                            study.addToSamples(entity)
323                                                if (persistEntity(study)) validatedSuccesfully++;
324                                        } else {
325                                            failedtopersist.add(entity)
326                                        }
327                                        break
328                    case SamplingEvent: log.info "Persisting SamplingEvent `" + entity + "`: "                                   
329                                        study.addToSamplingEvents(entity)
330                                        if (persistEntity(entity)) validatedSuccesfully++;
331                                            else failedtopersist.add(entity)
332                                        break
333                        default          :  log.info "Skipping persisting of `" + entity.getclass() +"`"
334                                        failedtopersist.add(entity)
335                                        break
336                        } // end switch
337            } // end record
338        } // end datamatrix   
339        return [validatedSuccesfully, updatedentities, failedtopersist]
340    }
341
342    /**
343     * Check whether an entity already exist. A unique field in the entity is
344     * used to check whether the instantiated entity (read from Excel) is new.
345     * If the entity is found in the database it will be returned as is.
346     *
347     * @param entity entity object like a Study, Subject, Sample et cetera
348     * @return entity if found, otherwise null
349     */
350    def isEntityStored(entity) {
351            switch (entity.getClass()) {
352                        case Study          :  return Study.findByCode(entity.code)
353                                               break
354                        case Subject        :  return Subject.findByParentAndName(entity.parent, entity.name)
355                                               break
356                        case Event          :  break
357                        case Sample         :
358                                               break
359                        case SamplingEvent  :  break
360                        default             :  // unknown entity
361                                               return null
362            }
363    }
364
365    /**
366     * Find the entity and update the fields. The entity is an instance
367     * read from Excel. This method looks in the database for the entity
368     * having the same identifier. If it has found the same entity
369     * already in the database, it will update the record.
370     *
371     * @param entitystored existing record in the database to update
372     * @param entity entity read from Excel
373     */
374    def updateEntity(entitystored, entity) {
375        switch (entity.getClass()) {
376                        case Study          :  break
377                        case Subject        :  entitystored.properties = entity.properties
378                                               entitystored.save()
379                                               break
380                        case Event          :  break
381                        case Sample         :  break
382                        case SamplingEvent  :  break
383                        default             :  // unknown entity
384                                               return null
385        }
386    }
387
388    /**
389     * Method to persist entities into the database
390     * Checks whether entity already exists (based on identifier column 'name')
391     *
392     * @param entity entity object like Study, Subject, Protocol et cetera
393     *
394     */
395    boolean persistEntity(entity) {
396            println "persisting ${entity}"       
397            // if not validated
398                if (entity.validate()) {
399                        if (entity.save(flush:true)) { //.merge?
400                                return true
401                        }
402                        else { // if save was unsuccesful
403                                entity.errors.allErrors.each {
404                                        println it
405                                }
406                                return false
407                        }
408                }
409            else { // if not validated
410                    entity.errors.each {
411                            println it
412                    }
413                        return false
414            }
415         }
416
417        /**
418         * This method creates a record (array) containing entities with values
419         *
420         * @param template_id template identifier
421         * @param excelrow POI based Excel row containing the cells
422         * @param mcmap map containing MappingColumn objects
423         * @return list of entities and list of failed cells
424         */
425        def createRecord(template_id, Row excelrow, mcmap) {
426                def df = new DataFormatter()
427                def template = Template.get(template_id)
428        def tft = TemplateFieldType
429                def record = [] // list of entities and the read values
430        def failed = new ImportRecord() // map with entity identifier and failed mappingcolumn
431
432                // Initialize all possible entities with the chosen template
433                def study = new Study(template: template)
434                def subject = new Subject(template: template)
435                def samplingEvent = new SamplingEvent(template: template)
436                def event = new Event(template: template)
437                def sample = new Sample(template: template)
438
439                // Go through the Excel row cell by cell
440                for (Cell cell: excelrow) {
441                        // get the MappingColumn information of the current cell
442                        def mc = mcmap[cell.getColumnIndex()]
443                        def value                       
444
445                        // Check if column must be imported
446                        if (mc!=null) if (!mc.dontimport) {
447                                try {
448                                        value = formatValue(df.formatCellValue(cell), mc.templatefieldtype)
449                                } catch (NumberFormatException nfe) {
450                                        value = ""
451                                }
452
453                try {
454                    // which entity does the current cell (field) belong to?
455                    switch (mc.entity) {
456                        case Study: // does the entity already exist in the record? If not make it so.
457                        (record.any {it.getClass() == mc.entity}) ? 0 : record.add(study)
458                                                study.setFieldValue(mc.property, value)
459                                                break
460                        case Subject: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(subject)
461                                                subject.setFieldValue(mc.property, value)
462                                                break
463                        case SamplingEvent: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(samplingEvent)
464                                                samplingEvent.setFieldValue(mc.property, value)
465                                                break
466                        case Event: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(event)
467                                                event.setFieldValue(mc.property, value)
468                                                break
469                        case Sample: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(sample)
470                                                sample.setFieldValue(mc.property, value)
471                                                break
472                        case Object:   // don't import
473                                                break
474                    } // end switch
475                } catch (IllegalArgumentException iae) {
476                    // store the mapping column and value which failed
477                    def identifier
478
479                    switch (mc.entity) {
480                        case Study:  identifier = study.getIdentifier()
481                        break
482                        case Subject: identifier = subject.getIdentifier()
483                        break
484                        case SamplingEvent: identifier = samplingEvent.getIdentifier()
485                        break
486                        case Event: identifier = event.getIdentifier()
487                        break
488                        case Sample: identifier = sample.getIdentifier()
489                        break
490                        case Object:   // don't import
491                        break
492                    }
493                                   
494                    def mcInstance = new MappingColumn()
495                    mcInstance.properties = mc.properties
496                    failed.addToImportcells(new ImportCell(mappingcolumn:mcInstance, value:value, entityidentifier:identifier))
497                }
498                        } // end
499                } // end for
500        // a failed column means that using the entity.setFieldValue() threw an exception       
501        return [record, failed]
502    }
503
504    /**
505    * Method to parse a value conform a specific type
506    * @param value string containing the value
507    * @return object corresponding to the TemplateFieldType
508    */
509   def formatValue(String value, TemplateFieldType type) throws NumberFormatException {
510            switch (type) {
511            case TemplateFieldType.STRING           :   return value.trim()
512            case TemplateFieldType.TEXT         :   return value.trim()
513            case TemplateFieldType.LONG         :   return (long) Double.valueOf(value)
514            //case TemplateFieldType.FLOAT          :   return Float.valueOf(value.replace(",","."));
515            case TemplateFieldType.DOUBLE           :   return Double.valueOf(value.replace(",","."));
516            case TemplateFieldType.STRINGLIST   :   return value.trim()
517            case TemplateFieldType.ONTOLOGYTERM :   return value.trim()
518            case TemplateFieldType.DATE         :   return value
519            default                             :   return value
520            }
521    }
522
523    // classes for fuzzy string matching
524    // <FUZZY MATCHING>
525    static def similarity(l_seq, r_seq, degree=2) {
526        def l_histo = countNgramFrequency(l_seq, degree)
527        def r_histo = countNgramFrequency(r_seq, degree)
528
529        dotProduct(l_histo, r_histo) /
530        Math.sqrt(dotProduct(l_histo, l_histo) *
531            dotProduct(r_histo, r_histo))
532    }
533
534    static def countNgramFrequency(sequence, degree) {
535        def histo = [:]
536        def items = sequence.size()
537
538        for (int i = 0; i + degree <= items; i++)
539        {
540            def gram = sequence[i..<(i + degree)]
541            histo[gram] = 1 + histo.get(gram, 0)
542        }
543        histo
544    }
545
546    static def dotProduct(l_histo, r_histo) {
547        def sum = 0
548        l_histo.each { key, value ->
549            sum = sum + l_histo[key] * r_histo.get(key, 0)
550        }
551        sum
552    }
553
554    static def stringSimilarity (l_str, r_str, degree=2) {
555       
556        similarity(l_str.toString().toLowerCase().toCharArray(),
557            r_str.toString().toLowerCase().toCharArray(),
558            degree)
559    }
560
561    static def mostSimilar(pattern, candidates, threshold=0) {
562        def topScore = 0
563        def bestFit = null
564
565        candidates.each { candidate ->
566            def score = stringSimilarity(pattern, candidate)
567            if (score > topScore) {
568                topScore = score
569                bestFit = candidate
570            }
571        }
572
573        if (topScore < threshold)
574        bestFit = null
575
576        bestFit
577    }
578    // </FUZZY MATCHING>
579
580}
Note: See TracBrowser for help on using the browser.