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

Last change on this file since 268 was 268, checked in by tabma, 11 years ago
  • identifier column added
  • Property svn:keywords set to Author Rev Date
File size: 6.7 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: 268 $
13 * $Author: tabma $
14 * $Date: 2010-03-15 18:16:02 +0000 (ma, 15 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
30
31class ImporterService {
32
33    boolean transactional = true
34
35    /**
36    * @param is input stream representing the (workbook) resource
37    * @return high level representation of the workbook
38    */
39    HSSFWorkbook getWorkbook(InputStream is) {
40        POIFSFileSystem fs = new POIFSFileSystem(is)
41        HSSFWorkbook    wb = new HSSFWorkbook(fs);
42        return wb;
43    }
44
45    /**
46     * @param wb high level representation of the workbook
47     * @return header representation as a MappingColumn hashmap
48     */
49    def getHeader(HSSFWorkbook wb, int sheetindex){
50
51        def sheet = wb.getSheetAt(sheetindex)
52        def datamatrix_start = sheet.getFirstRowNum() + 1
53        //def header = []
54        def header = [:]
55        def df = new DataFormatter()
56
57
58        for (HSSFCell c: sheet.getRow(datamatrix_start)) {
59            def datamatrix_celltype = sheet.getRow(datamatrix_start).getCell(c.getColumnIndex()).getCellType()
60            def headercell = sheet.getRow(sheet.getFirstRowNum()).getCell(c.getColumnIndex())
61
62            // Check for every celltype, currently redundant code, but possibly this will be
63            // a piece of custom code for every cell type like specific formatting
64               
65            switch (datamatrix_celltype) {
66                    case HSSFCell.CELL_TYPE_STRING:
67                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
68                            break
69                    case HSSFCell.CELL_TYPE_NUMERIC:                   
70                            if (HSSFDateUtil.isCellDateFormatted(c)) {
71                                header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.DATE)
72                            }
73                            else
74                                header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.INTEGER);
75                            break
76                    case HSSFCell.CELL_TYPE_BLANK:
77                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
78                            break
79                    default:
80                            header[c.getColumnIndex()] = new dbnp.importer.MappingColumn(name:df.formatCellValue(headercell), templatefieldtype:TemplateFieldType.STRING);
81                            break
82            }
83        }
84        return header
85    }
86
87    /**
88     * This method is meant to return a matrix of the rows and columns
89     * used in the preview
90     *
91     * @param wb workbook object
92     * @param sheetindex sheet index used
93     * @param rows amount of rows returned
94     * @return two dimensional array (matrix) of HSSFCell objects
95     */
96
97    HSSFCell[][] getDatamatrix(HSSFWorkbook wb, int sheetindex, int count) {
98        def sheet = wb.getSheetAt(sheetindex)
99        def rows  = []
100        def df = new DataFormatter()
101        def datamatrix_start = 1
102
103        // walk through all rows
104        (count <= sheet.getLastRowNum()) ?
105        ((datamatrix_start+sheet.getFirstRowNum())..count).each { rowindex ->
106            def row = []
107
108            // walk through every cell
109            for (HSSFCell c: sheet.getRow(rowindex))
110                row.add(c)
111                //row.add(df.formatCellValue(c))
112            rows.add(row)
113        } : 0
114
115        return rows
116    }
117
118    /**
119    * This method will move a file to a new location.
120    *
121    * @param file File object to move
122    * @param folderpath folder to move the file to
123    * @param filename (new) filename to give
124    * @return if file has been moved succesful, the new path and filename will be returned, otherwise an empty string will be returned
125    */
126    def moveFile(File file, String folderpath, String filename) {
127        try {
128                def rnd = ""; //System.currentTimeMillis()
129                file.transferTo(new File(folderpath, rnd+filename))
130                return folderpath + filename
131            } catch(Exception exception) {
132                log.error "File move error, ${exception}"
133                return ""
134                }
135    }
136
137    /**
138    * @return random numeric value
139    */
140    def random = {
141            return System.currentTimeMillis() + Runtime.runtime.freeMemory()
142        }
143
144    /**
145    * Method to read data from a workbook and to import data into the database
146    * by using mapping information
147    *
148    * @param template_id template identifier to use fields from
149    * @param wb POI horrible spreadsheet formatted workbook object
150    * @param mcmap linked hashmap (preserved order) of MappingColumns
151    * @param sheetindex sheet to use when using multiple sheets
152    * @param rowindex first row to start with reading the actual data (NOT the header)
153    *
154    * @see dbnp.importer.MappingColumn
155    */
156    def importdata(template_id, HSSFWorkbook wb, int sheetindex, int rowindex, mcmap) {
157        def sheet = wb.getSheetAt(sheetindex)
158        def rows  = []
159        def df = new DataFormatter()
160
161        // walk through all rows       
162        rowindex..sheet.getLastRowNum().each { i ->
163            def record = [:]
164
165            // get the value of the cells in the row
166            for (HSSFCell cell: sheet.getRow(i)) {
167                def mc = mcmap[cell.getColumnIndex()]
168                record.add(createColumn(template_id, cell, mc))
169            }
170        }
171        println record
172    }
173
174    /**
175    * This function creates a column based on the current cell and mapping
176    *
177    * @param template_id template identifier to use fields from
178    * @param cell POI cell read from Excel
179    * @param mc mapping column
180    * @return entity object
181    *
182    */
183    def createColumn(template_id, HSSFCell cell, MappingColumn mc) {
184        def df = new DataFormatter()
185        def template = Template.get(template_id)
186
187        // check the templatefield entity of the cell
188        switch(mc.entity) {
189            case Study  :   def st = new Study(template:template)
190                            st.setFieldValue(mc.name, df.formatCellValue(cell))
191                            return st
192                            break
193            case Subject:   def su = new Subject(template:template)
194                            su.setFieldValue(mc.name, df.formatCellValue(cell))
195                            return su
196                            break
197            case Event  :   def ev = new Event(template:template)
198                            ev.setFieldValue(mc.name, df.formatCellValue(cell))
199                            return ev
200                            break
201            case Protocol:  def pr = new Protocol(template:template)
202                            pr.setFieldValue(mc.name, df.formatCellValue(cell))
203                            return pr
204                            break
205            case Sample :   def sa = new Sample(template:template)
206                            sa.setFieldValue(mc.name, df.formatCellValue(cell))
207                            return sa
208                            break
209            case Object :   break           
210        }
211    }
212}
Note: See TracBrowser for help on using the repository browser.