Changeset 290 for trunk/grails-app/domain

Timestamp:

Mar 22, 2010, 11:38:25 AM (13 years ago)

Author:

keesvb

Message:

debugged EventDescription?.save, added comment field for template fields, add code comments to setFieldValue, added missing events to PPSH demo in BootStrap?, cleaned up home menu, re-added searchable

Location:

trunk/grails-app/domain/dbnp/studycapturing

Files:

• TemplateEntity.groovy (modified) (3 diffs)
• TemplateField.groovy (modified) (2 diffs)

trunk/grails-app/domain/dbnp/studycapturing/TemplateEntity.groovy

@@ -70 +70 @@
 
         /**
-         * Find a template field by its name and return its value for this subject
-         * @param fieldName The name of the template subject field
+         * Find a template field by its name and return its value for this entity
+         * @param fieldName The name of the template field
          * @return the value of the field (class depends on the field type)
          * @throws NoSuchFieldException If the field is not found or the field type is not supported
@@ -81 +81 @@
         }
 
+        /**
+         * Set a template/entity field value
+         * @param fieldName The name of the template or entity field
+         * @param value The value to be set, this should align with the (template) field type, but there are some convenience setters
+         *
+         */
         def setFieldValue(String fieldName, value) {
+
+                // First, search if there is an entity property with the given name, and if so, set that
                 if (this.properties.containsKey(fieldName)) {
                         this[fieldName] = value
                 }
-                else
-                if (template == null) {
-                        throw new NoSuchFieldException("Field ${fieldName} not found in class properties")
+                // If not the found, then it is a template field, so check if there is a template
+                else if (template == null) {
+                        throw new NoSuchFieldException("Field ${fieldName} not found in class properties: template not set")
                 }
+                // If there is a template, check the template fields
                 else {
+                        // Find the target template field, if not found, throw an error
                         TemplateField field = this.template.fields.find { it.name == fieldName}
                         if (field == null) {
                                 throw new NoSuchFieldException("Field ${fieldName} not found in class properties or template fields")
                         }
+                        // Set the value of the found template field
                         else {
+                                // Convenience setter for template string list fields: find TemplateFieldListItem by name
                                 if (field.type == TemplateFieldType.STRINGLIST && value.class == String) {
-                                        // Convenience setter: find template item by name
                                         value = field.listEntries.find { it.name == value }
                                 }
 
-                                // handle string values for date fields
+                                // Convenience setter for dates: handle string values for date fields
                                 if (field.type == TemplateFieldType.DATE && value.class == String) {
                                         // a string was given, attempt to transform it into a date instance
@@ -119 +130 @@
                                 }
 
-                                // Caution: this assumes that all template...Field Maps are already initialized
-                                // Otherwise, the results are pretty much unpredictable!
+                                // Set the field value
+                                // Caution: this assumes that all template...Field Maps are already initialized (as is done now above as [:])
+                                // If that is ever changed, the results are pretty much unpredictable (random Java object pointers?)!
                                 getStore(field.type)[fieldName] = value
                                 return this

trunk/grails-app/domain/dbnp/studycapturing/TemplateField.groovy

@@ -13 +13 @@
         TemplateFieldType type
         String unit
+        String comment // help string for the user interface
 
     static hasMany = [listEntries : TemplateFieldListItem] // to store the entries to choose from when the type is 'item from predefined list'
@@ -19 +20 @@
                 name(unique: true)
                 unit(nullable: true, blank: true)
+                comment(nullable:true, blank: true)
+        }
+
+        static mapping = {
+                comment type: 'text'
         }