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

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