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

Last change on this file since 307 was 307, checked in by tabma, 10 years ago
  • dynamic finder used instead of getTerm-method to retrieve a term
  • Property svn:keywords set to Author Rev Date
File size: 10.4 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: 307 $
13 * $Author: tabma $
14 * $Date: 2010-03-23 13:34:57 +0000 (di, 23 mrt 2010) $
15 */
16
17package dbnp.importer
18import org.apache.poi.hssf.usermodel.*
19import org.apache.poi.poifs.filesystem.POIFSFileSystem
20import org.apache.poi.ss.usermodel.DataFormatter
21import org.apache.poi.hssf.usermodel.HSSFDateUtil
22import dbnp.studycapturing.TemplateFieldType
23import dbnp.studycapturing.Template
24import dbnp.studycapturing.Study
25import dbnp.studycapturing.Subject
26import dbnp.studycapturing.Event
27import dbnp.studycapturing.Protocol
28import dbnp.studycapturing.Sample
29
30import dbnp.data.Ontology
31import dbnp.data.Term
32
33class ImporterService {
34
35    boolean transactional = true
36
37    /**
38    * @param is input stream representing the (workbook) resource
39    * @return high level representation of the workbook
40    */
41    HSSFWorkbook getWorkbook(InputStream is) {
42        POIFSFileSystem fs = new POIFSFileSystem(is)
43        HSSFWorkbook    wb = new HSSFWorkbook(fs);
44        return wb;
45    }
46
47    /**
48     * @param wb high level representation of the workbook
49     * @return header representation as a MappingColumn hashmap
50     */
51    def getHeader(HSSFWorkbook wb, int sheetindex){
52
53        def sheet = wb.getSheetAt(sheetindex)
54        def datamatrix_start = sheet.getFirstRowNum() + 1
55        //def header = []
56        def header = [:]
57        def df = new DataFormatter()
58
59
60        for (HSSFCell c: sheet.getRow(datamatrix_start)) {
61            def datamatrix_celltype = sheet.getRow(datamatrix_start).getCell(c.getColumnIndex()).getCellType()
62            def headercell = sheet.getRow(sheet.getFirstRowNum()).getCell(c.getColumnIndex())
63
64            // Check for every celltype, currently redundant code, but possibly this will be
65            // a piece of custom code for every cell type like specific formatting
66               
67            switch (datamatrix_celltype) {
68                    case HSSFCell.CELL_TYPE_STRING:
69                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
70                            break
71                    case HSSFCell.CELL_TYPE_NUMERIC:                   
72                            if (HSSFDateUtil.isCellDateFormatted(c)) {
73                                header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.DATE)
74                            }
75                            else
76                                header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.INTEGER);
77                            break
78                    case HSSFCell.CELL_TYPE_BLANK:
79                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
80                            break
81                    default:
82                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
83                            break
84            }
85        }
86        return header
87    }
88
89    /**
90     * This method is meant to return a matrix of the rows and columns
91     * used in the preview
92     *
93     * @param wb workbook object
94     * @param sheetindex sheet index used
95     * @param rows amount of rows returned
96     * @return two dimensional array (matrix) of HSSFCell objects
97     */
98
99    HSSFCell[][] getDatamatrix(HSSFWorkbook wb, int sheetindex, int count) {
100        def sheet = wb.getSheetAt(sheetindex)
101        def rows  = []
102        def df = new DataFormatter()
103        def datamatrix_start = 1
104
105        // walk through all rows
106        (count <= sheet.getLastRowNum()) ?
107        ((datamatrix_start+sheet.getFirstRowNum())..count).each { rowindex ->
108            def row = []
109
110            // walk through every cell
111            for (HSSFCell c: sheet.getRow(rowindex))
112                row.add(c)
113                //row.add(df.formatCellValue(c))
114            rows.add(row)
115        } : 0
116
117        return rows
118    }
119
120    /**
121    * This method will move a file to a new location.
122    *
123    * @param file File object to move
124    * @param folderpath folder to move the file to
125    * @param filename (new) filename to give
126    * @return if file has been moved succesful, the new path and filename will be returned, otherwise an empty string will be returned
127    */
128    def moveFile(File file, String folderpath, String filename) {
129        try {
130                def rnd = ""; //System.currentTimeMillis()
131                file.transferTo(new File(folderpath, rnd+filename))
132                return folderpath + filename
133            } catch(Exception exception) {
134                log.error "File move error, ${exception}"
135                return ""
136                }
137    }
138
139    /**
140    * @return random numeric value
141    */
142    def random = {
143            return System.currentTimeMillis() + Runtime.runtime.freeMemory()
144        }
145
146    /**
147    * Method to read data from a workbook and to import data into the database
148    * by using mapping information
149    *
150    * @param template_id template identifier to use fields from
151    * @param wb POI horrible spreadsheet formatted workbook object
152    * @param mcmap linked hashmap (preserved order) of MappingColumns
153    * @param sheetindex sheet to use when using multiple sheets
154    * @param rowindex first row to start with reading the actual data (NOT the header)
155    * @return two dimensional array containing records (with entities)
156    *
157    * @see dbnp.importer.MappingColumn
158    */
159    def importdata(template_id, HSSFWorkbook wb, int sheetindex, int rowindex, mcmap) {
160        def sheet = wb.getSheetAt(sheetindex)
161        def table = []
162       
163        // walk through all rows       
164        (rowindex..sheet.getLastRowNum()).each { i ->
165            table.add(createRecord(template_id, sheet.getRow(i), mcmap))           
166        }
167
168        /*table.each {
169            it.each { entity ->
170                entity.giveFields().each { field ->
171                    print field.name + ":" + entity.getFieldValue(field.name) + "/"
172                }
173                println
174            }
175        }*/
176
177        return table   
178    }
179   
180     /**
181                     // start transaction
182                        def transaction = sessionFactory.getCurrentSession().beginTransaction()
183                              // persist data to the database
184                                try {
185                                   // commit transaction
186                                        println "commit"
187                                        transaction.commit()
188                                        success()
189                                } catch (Exception e) {
190                                        // rollback
191                                        // stacktrace in flash scope
192                                        flash.debug = e.getStackTrace()
193
194                                        println "rollback"
195                                        transaction.rollback()
196                                        error()
197                                }
198      */
199
200    /**
201     * @param datamatrix two dimensional array containing entities with values read from Excel file
202     */   
203    def savedata(datamatrix) {
204        datamatrix.each { record ->
205            record.each { entity ->
206                switch (entity.getClass()) {
207                    case Study   :  print "Persisting Study `" + entity.title + "`: "
208                                    persistEntity(entity)
209                                    break
210                    case Subject :  print "Persisting Subject `" + entity.name + "`: "
211                                    persistEntity(entity)
212                                    break
213                    case Event   :  print "Persisting Event `" + entity.eventdescription + "`: "
214                                    persistEntity(entity)
215                                    break
216                    case Protocol:  print "Persisting Protocol `" + entity.name + "`: "
217                                    persistEntity(entity)
218                                    break
219                    case Sample  :  print "Persisting Sample `" + entity.name +"`: "
220                                    persistEntity(entity)
221                                    break
222                    default      :  println "Skipping persisting of `" + entity.getclass() +"`"
223                                    break
224                }
225            }
226        }       
227    }
228
229    /**
230     * Method to persist entities into the database
231     *
232     * @param entity entity object like Study, Subject, Protocol et cetera
233     *
234     */
235    def persistEntity(entity) {
236        println entity.dump()
237        if (entity.save(flush:true)) {  //.merge?
238            println "OK"
239        } else entity.errors.allErrors.each {
240                println it
241        }
242    }
243
244    /**
245     * This method creates a record (array) containing entities with values
246     *
247     * @param template_id template identifier
248     * @param excelrow POI based Excel row containing the cells
249     * @param mcmap map containing MappingColumn objects
250     */
251    def createRecord(template_id, HSSFRow excelrow, mcmap) {
252        def df = new DataFormatter()
253        def template = Template.get(template_id)
254        def record = [] 
255       
256        def study = new Study(title:"New study", template:template)
257        def subject = new Subject(name:"New subject", species:Term.findByName("Homo sapiens"), template:template)
258        def event = new Event(eventdescription:"New event", template:template)
259        def protocol = new Protocol(name:"New protocol", template:template)
260        def sample = new Sample(name:"New sample", template:template)
261
262        for (HSSFCell cell: excelrow) {
263            def mc = mcmap[cell.getColumnIndex()]
264            def value = formatValue(df.formatCellValue(cell), mc.templatefieldtype)
265
266            switch(mc.entity) {
267                case Study      :   (record.any {it.getClass()==mc.entity}) ? 0 : record.add(study)
268                                    study.setFieldValue(mc.property.name, value)
269                                    break
270                case Subject    :   (record.any {it.getClass()==mc.entity}) ? 0 : record.add(subject)
271                                    subject.setFieldValue(mc.property.name, value)
272                                    break
273                case Event      :   (record.any {it.getClass()==mc.entity}) ? 0 : record.add(event)
274                                    event.setFieldValue(mc.property.name, value)
275                                    break
276                case Protocol   :   (record.any {it.getClass()==mc.entity}) ? 0 : record.add(protocol)
277                                    protocol.setFieldValue(mc.property.name, value)
278                                    break
279                case Sample     :   (record.any {it.getClass()==mc.entity}) ? record.add(sample) : 0
280                                    sample.setFieldValue(mc.property.name, value)
281                                    break
282                case Object     :   // don't import
283                                    break
284            } // end switch
285        } // end for
286
287        return record
288    }
289
290    /**
291    * Method to parse a value conform a specific type
292    * @param value string containing the value
293    * @return object corresponding to the TemplateFieldType
294    */
295    def formatValue(String value, TemplateFieldType type) {
296        switch (type) {
297            case TemplateFieldType.STRING       :   return value
298            case TemplateFieldType.TEXT         :   return value
299            case TemplateFieldType.INTEGER      :   return Integer.valueOf(value.replaceAll("[^0-9]",""))
300            case TemplateFieldType.FLOAT        :   return Float.valueOf(value.replace(",","."));
301            case TemplateFieldType.DOUBLE       :   return Double.valueOf(value.replace(",","."));
302            case TemplateFieldType.STRINGLIST   :   return value
303            case TemplateFieldType.ONTOLOGYTERM :   return value
304            case TemplateFieldType.DATE         :   return value
305            default                             :   return value
306        }
307    }
308}
Note: See TracBrowser for help on using the repository browser.