Changeset 735

Timestamp:

Jul 27, 2010, 4:26:35 PM (13 years ago)

Author:

tabma

Message:

• improved partial missing code documentation

Location:

trunk/grails-app

Files:

• controllers/dbnp/importer/ImporterController.groovy (modified) (7 diffs)
• services/dbnp/importer/ImporterService.groovy (modified) (5 diffs)

trunk/grails-app/controllers/dbnp/importer/ImporterController.groovy

@@ -79 +79 @@
         def entityClass = Class.forName(entity, true, this.getClass().getClassLoader())
 
+        // Initialize some session variables
         session.importer_workbook = wb
         session.importer_study = Study.get(params.study.id.toInteger())
@@ -86 +87 @@
         session.importer_headerrow = params.headerrow.toInteger()
 
+        // Get the header from the Excel file using the arguments given in the first step of the wizard
         session.importer_header = ImporterService.getHeader(wb,
                                                             session.importer_sheetindex,
@@ -92 +94 @@
                                                             entityClass)
         
-        session.importer_header.each {      
+        // Initialize 'selected entities', used to show entities above the columns
+        session.importer_header.each {
             selectedentities.add([name:params.entity, columnindex:it.key.toInteger()])
         }
@@ -125 +128 @@
 
     /**
+     * Method to save the missing properties
      * @param entity entity class we are using (dbnp.studycapturing.Subject etc.)
      */
 
     def saveMissingProperties = {
-        
+
         session.importer_importeddata.each { table ->
             table.each { entity ->
@@ -185 +189 @@
             }
             
+            // Set the templatefield type for this column
             session.importer_header[columnindex.toInteger()].templatefieldtype = tft
         }
 
+        // Detect the entity type
         params.entity.index.each { columnindex, entityname ->
             Class clazz = null
@@ -206 +212 @@
             }
 
+            // Store properties for this column
             session.importer_header[columnindex.toInteger()].identifier = (columnindex.toInteger() == identifiercolumnindex) ? true : false
             session.importer_header[columnindex.toInteger()].index = columnindex.toInteger()
@@ -259 +266 @@
     }
 
+    /**
+     * Method which saves the data matrix to the database
+     */
     def savePostview = {
         def validatedSuccesfully = ImporterService.saveDatamatrix(session.importer_study, session.importer_importeddata)

trunk/grails-app/services/dbnp/importer/ImporterService.groovy

@@ -225 +225 @@
         def table = []
         
-        // walk through all rows        
+        // walk through all rows and fill the table with records
         (rowindex..sheet.getLastRowNum()).each { i ->
             table.add(createRecord(template_id, sheet.getRow(i), mcmap))
         }
-
-        /*table.each {
-            it.each { entity ->
-                entity.giveFields().each { field ->
-                    print field.name + ":" + entity.getFieldValue(field.name) + "/"
-                }
-                println
-            }
-        }*/
-
         return table    
     }
@@ -254 +244 @@
         study.refresh()
         
+        // go through the data matrix, read every record and validate the entity and try to persist it
         datamatrix.each { record ->
             record.each { entity ->
@@ -312 +303 @@
                 def template = Template.get(template_id)
                 def record = []
-        def samplingevent = new SamplingEvent(template:template)
-
+
+                // Initialize all possible entities with the chosen template
                 def study = new Study(template: template)
                 def subject = new Subject(template: template)
@@ -320 +311 @@
                 def sample = new Sample(template: template)
 
+                // Go through the Excel row cell by cell
                 for (HSSFCell cell: excelrow) {
+                        // get the MappingColumn information of the current cell
                         def mc = mcmap[cell.getColumnIndex()]
                         def value
@@ -332 +325 @@
                                 }
 
+                                // which entity does the current cell (field) belong to?
                                 switch (mc.entity) {
                                         case Study: (record.any {it.getClass() == mc.entity}) ? 0 : record.add(study)