Changeset 2015

Timestamp:

Sep 12, 2011, 2:35:43 PM (6 years ago)

Author:

taco@…

Message:

VisualizeController?.groovy, improved infoMessage system.

File:

• trunk/grails-app/controllers/dbnp/visualization/VisualizeController.groovy (modified) (9 diffs)

trunk/grails-app/controllers/dbnp/visualization/VisualizeController.groovy

@@ -23 +23 @@
         def authenticationService
         def moduleCommunicationService
-    def infoMessage = ""
+    def infoMessage = []
+    def infoMessageOfflineModules = []
     final int CATEGORICALDATA = 0
     final int NUMERICALDATA = 1
@@ -58 +59 @@
         // Check to see if we have enough information
         if(input_object==null || input_object?.studyIds==null){
-            infoMessage = "Please select a study."
+            setInfoMessage("Please select a study.")
             return sendInfoMessage()
         } else {
@@ -108 +109 @@
             }
 
+            // Make sure any informational messages regarding offline modules are submitted to the client
+            setInfoMessageOfflineModules()
+
 
             // TODO: Maybe we should add study's own fields
@@ -132 +136 @@
 
         if(inputData.columnIds == null || inputData.columnIds == [] || inputData.columnIds[0] == null || inputData.columnIds[0] == ""){
-            infoMessage = "Please select a data source for the x-axis."
+            setInfoMessage("Please select a data source for the x-axis.")
             return sendInfoMessage()
         }
         if(inputData.rowIds == null || inputData.rowIds == [] ||  inputData.rowIds[0] == null ||   inputData.rowIds[0] == ""){
-            infoMessage = "Please select a data source for the y-axis."
+            setInfoMessage("Please select a data source for the y-axis.")
             return sendInfoMessage()
         }
@@ -184 +188 @@
         } catch(Exception e){
             //returnError(404, "An error occured while trying to collect field data from a module. Most likely, this module is offline.")
-            infoMessage = "Unfortunately, "+assay.module.name+" could not be reached. As a result, we cannot at this time visualize data contained in this module."
+            infoMessageOfflineModules.add(assay.module.name)
             log.error("VisualizationController: getFields: "+e)
         }
@@ -620 +624 @@
    }
 
-   /**
-   * Returns the objects within the given study that should be used with the given entity string
-   *
-   * For example:
-   *            What object should be consulted if the user asks for "samples"
-   *            Response: study.samples
-   * @return    List of domain objects that should be used with the given entity string
-   */
-  protected def templateObjectCallback( String entity, Study study ) {
-          switch( entity ) {
-                  case "Study":
-                  case "studies":
-                          return study
-                  case "Subject":
-                  case "subjects":
-                          return study?.samples?.parentSubject
-                  case "Sample":
-                  case "samples":
-                          return study?.samples
-                  case "Event":
-                  case "events":
-                           return study?.samples?.parentEventGroup?.events?.flatten()
-                  case "SamplingEvent":
-                  case "samplingEvents":
-                          return study?.samples?.parentEvent
-                  case "Assay":
-                  case "assays":
-                                  return study?.assays
-          }
-  }
+    /**
+    * Returns the objects within the given study that should be used with the given entity string
+    *
+    * For example:
+    *           What object should be consulted if the user asks for "samples"
+    *           Response: study.samples
+    * @return   List of domain objects that should be used with the given entity string
+    */
+    protected def templateObjectCallback( String entity, Study study ) {
+      switch( entity ) {
+          case "Study":
+          case "studies":
+              return study
+          case "Subject":
+          case "subjects":
+              return study?.samples?.parentSubject
+          case "Sample":
+          case "samples":
+              return study?.samples
+          case "Event":
+          case "events":
+               return study?.samples?.parentEventGroup?.events?.flatten()
+          case "SamplingEvent":
+          case "samplingEvents":
+              return study?.samples?.parentEvent
+          case "Assay":
+          case "assays":
+                  return study?.assays
+      }
+    }
         
         /**
@@ -701 +705 @@
         * @return                       Standard error of the mean of the values or 0 if no values can be used.
         */
-   protected def computeSEM( List values, def mean = null ) {
-           if( mean == null )
-                        mean = computeMean( values )
-           
-           def sumOfDifferences = 0;
-           def sizeOfValues = 0;
-           values.each { value ->
-                   def num = getNumericValue( value );
-                   if( num != null ) {
-                           sumOfDifferences += Math.pow( num - mean, 2 );
-                           sizeOfValues++
-                   }
-           }
-
-           if( sizeOfValues > 0 ) {
-                   def std = Math.sqrt( sumOfDifferences / sizeOfValues );
-                   return std / Math.sqrt( sizeOfValues );
-           } else {
-                   return 0;
-           }
-   }
-   Exception e
+    protected def computeSEM( List values, def mean = null ) {
+       if( mean == null )
+            mean = computeMean( values )
+
+       def sumOfDifferences = 0;
+       def sizeOfValues = 0;
+       values.each { value ->
+           def num = getNumericValue( value );
+           if( num != null ) {
+               sumOfDifferences += Math.pow( num - mean, 2 );
+               sizeOfValues++
+           }
+       }
+
+       if( sizeOfValues > 0 ) {
+           def std = Math.sqrt( sumOfDifferences / sizeOfValues );
+           return std / Math.sqrt( sizeOfValues );
+       } else {
+           return 0;
+       }
+    }
+    Exception e
         /**
          * Return the numeric value of the given object, or null if no numeric value could be returned
@@ -902 +906 @@
     protected void sendResults(returnData){
         def results = [:]
-        if(infoMessage!=""){
+        if(infoMessage.size()!=0){
             results.put("infoMessage", infoMessage)
-            infoMessage = ""
+            infoMessage = []
         }
         results.put("returnData", returnData)
@@ -918 +922 @@
         def results = [:]
         results.put("infoMessage", infoMessage)
-        infoMessage = ""
+        infoMessage = []
         render results as JSON
+    }
+
+    /**
+     * Adds a new message to the infoMessage
+     * @param message The information that needs to be added to the infoMessage
+     */
+    protected void setInfoMessage(message){
+        infoMessage.add([message])
+        println "setInfoMessage: "+infoMessage
+    }
+
+    /**
+     * Adds a message to the infoMessage that gives the client information about offline modules
+     */
+    protected void setInfoMessageOfflineModules(){
+        if(infoMessageOfflineModules.size()>0){
+            String message = "Unfortunately"
+            infoMessageOfflineModules.eachWithIndex{ it, index ->
+                if(index==(infoMessageOfflineModules.size()-2)){
+                    message += ', the '+it+' and '
+                } else {
+                    if(index==(infoMessageOfflineModules.size()-1)){
+                        message += 'the '+it
+                    } else {
+                        message += ', the '+it
+                    }
+                }
+            }
+            message += " could not be reached. As a result, we cannot at this time visualize data contained in "
+            if(infoMessageOfflineModules.size()>1){
+                message += "these modules."
+            } else {
+                message += "this module."
+            }
+            setInfoMessage(message)
+        }
+        infoMessageOfflineModules = []
     }