Changeset 1532

Timestamp:

Feb 7, 2012, 2:58:02 PM (11 years ago)

Author:

Nicklas Nordborg

Message:

References #355: Partition wizard should use local storage to save form

The partition wizard now remember all values in step 3 (Enter weight information). It is saved in the web browser local storage if the browser supports it (FF9 and IE9 should work). If something goes wrong with the registration the user can simply restart the wizard and select the same specimen tubes in step 1 (they are marked with a *) and continue as if nothing has happened.

Note that this feature is browser-specific and locally stored data can only be accesed with the same browser that saved it in the first place.

Location:

extensions/net.sf.basedb.reggie/trunk

Files:

• resources/partitionform.jsp (modified) (12 diffs)
• resources/reggie.js (modified) (1 diff)
• src/net/sf/basedb/reggie/servlet/PartitionRegistrationServlet.java (modified) (2 diffs)

extensions/net.sf.basedb.reggie/trunk/resources/partitionform.jsp

@@ -39 +39 @@
 var oneOrMoreWeightsAreSet;
 var nofPiecesAreValid;
+var isRestoringFromLocalStorage = false; // A flag to keep track of what is happening
 
 function init()
@@ -52 +53 @@
     {
       var tube = specimenTubes[i];
-      selectList.options[selectList.length] = new Option(tube.name, tube.name);
+      var storeInfo = getStoredInfo(tube.id);
+      selectList.options[selectList.length] = new Option(tube.name + (storeInfo ? ' [*]' : ''), tube.name, storeInfo ? true : false);
     }
   }
@@ -189 +191 @@
     }
     
-    inputWeightHtml = '';
+    inputWeightHtml = '<table border="0" cellspacing="0" cellpadding="0" width="100%">';
     var spTitle = 'SpWeight<br>';
     var apTitle = 'ApWeight<br>';
@@ -226 +228 @@
       var tube = selectedTubes[i];
       var nextStep = i<(selectedTubes.length-1) ? 'focusOnEnter(event, \'bloody'+(i+1)+'\')' : '';
-      
+        
       inputWeightHtml += '<tr>';
       inputWeightHtml += '<td rowspan=2 class=prompt>'+tube.name;
@@ -238 +240 @@
       inputWeightHtml += '<td style="width:400px;">';
       inputWeightHtml += '<table style="width:100%"><tr>';      
-      inputWeightHtml += '<td>'+bloodyTitle+'<input type=checkbox onkeypress="checkOnNumber(event, this);focusOnEnter(event, \'appearance'+i+'\')" onfocus="messageOnFocus(0,'+i+')" name=bloody'+i+' /></td>';
-      inputWeightHtml += '<td>'+appearanceTitle+'<select name=appearance'+i+' onfocus="messageOnFocus(1,'+i+')" onkeypress="focusOnEnter(event, \'necrosis'+i+'\')">'+appearanceOptions+'</select></td>';
-      inputWeightHtml += '<td>'+necrosisTitle+'<select name=necrosis'+i+' onfocus="messageOnFocus(2,'+i+')" onkeypress="focusOnEnter(event, \'fat'+i+'\')">'+necrosisOptions+'</select></td>';  
-      inputWeightHtml += '<td>'+fatTitle+'<select name=fat'+i+' onfocus="messageOnFocus(3,'+i+')" onkeypress="focusOnEnter(event, \'coloured'+i+'\')">'+fatOptions+'</select></td>';
-      inputWeightHtml += '<td>'+colouredTitle+'<input type=checkbox name=coloured'+i+' onfocus="messageOnFocus(4,'+i+')" onkeypress="checkOnNumber(event, this);focusOnEnter(event, \'nofPieces'+i+'\')" /></td>'
+      inputWeightHtml += '<td>'+bloodyTitle+'<input type=checkbox onkeypress="checkOnNumber(event, this);focusOnEnter(event, \'appearance'+i+'\')" onchange="saveToLocalStorage('+i+')" onfocus="messageOnFocus(0,'+i+')" name=bloody'+i+' /></td>';
+      inputWeightHtml += '<td>'+appearanceTitle+'<select name=appearance'+i+' onfocus="messageOnFocus(1,'+i+')" onchange="saveToLocalStorage('+i+')" onkeypress="focusOnEnter(event, \'necrosis'+i+'\')">'+appearanceOptions+'</select></td>';
+      inputWeightHtml += '<td>'+necrosisTitle+'<select name=necrosis'+i+' onfocus="messageOnFocus(2,'+i+')" onchange="saveToLocalStorage('+i+')" onkeypress="focusOnEnter(event, \'fat'+i+'\')">'+necrosisOptions+'</select></td>'; 
+      inputWeightHtml += '<td>'+fatTitle+'<select name=fat'+i+' onfocus="messageOnFocus(3,'+i+')" onchange="saveToLocalStorage('+i+')" onkeypress="focusOnEnter(event, \'coloured'+i+'\')">'+fatOptions+'</select></td>';
+      inputWeightHtml += '<td>'+colouredTitle+'<input type=checkbox name=coloured'+i+' onfocus="messageOnFocus(4,'+i+')" onchange="saveToLocalStorage('+i+')" onkeypress="checkOnNumber(event, this);focusOnEnter(event, \'nofPieces'+i+'\')" /></td>'
       inputWeightHtml += '<td>'+nofTitle+'<input name="nofPieces'+i+'" onfocus="messageOnFocus(5,'+i+')" onblur="nofPiecesOnChange('+i+')" onkeypress="focusOnEnter(event, \'spWeight'+i+'\');return isNumberKey(event)" size=2 /></td>';
       inputWeightHtml += '<td>'+spTitle+'<input name="spWeight'+i+'" onfocus="messageOnFocus(6,'+i+')" onblur="spWeightOnChange('+i+')" onkeypress="focusOnEnter(event, \'hisWeight'+i+'\');return isNumberKey(event)" size=4 /></td>';
@@ -250 +252 @@
       inputWeightHtml += '</table>';
       inputWeightHtml += '</td>';
-      inputWeightHtml += '<td rowspan=2 class="status" id="'+i+'.status"></td>';      
+      inputWeightHtml += '<td rowspan=2 class="status" id="'+i+'.status"></td>';
       inputWeightHtml += '</tr>';
       
@@ -258 +260 @@
       inputWeightHtml += '<tr><td>&nbsp;</td></tr>';
     }
+    inputWeightHtml += '</table>';
     setInnerHTML('weightInputs', inputWeightHtml);
-  } 
+    
+    // Restore saved information
+    isRestoringFromLocalStorage = true;
+    for (var i=0;i<selectedTubes.length; i++)
+    {
+      var tube = selectedTubes[i];
+      var storeInfo = getStoredInfo(tube.id);
+      if (storeInfo)
+      {
+        frm['bloody'+i].checked = storeInfo.bloody;
+        setSelectedValue(frm['appearance'+i], storeInfo.appearance);
+        setSelectedValue(frm['necrosis'+i], storeInfo.necrosis);
+        setSelectedValue(frm['fat'+i], storeInfo.fat);
+        frm['coloured'+i].checked = storeInfo.coloured;
+        frm['nofPieces'+i].value = storeInfo.nofPieces;
+        frm['spWeight'+i].value = storeInfo.spWeight;
+        frm['hisWeight'+i].value = storeInfo.hisWeight;
+        frm['apWeight'+i].value = storeInfo.apWeight;
+        nofPiecesOnChange(i);
+        spWeightOnChange(i);
+        hisWeightOnChange(i);
+        apWeightOnChange(i);
+      }
+    }
+    isRestoringFromLocalStorage = false;
+  }
+  
+  
+  
   Main.show('weightSection');
   Main.hide('gonext');
@@ -340 +371 @@
 }
 
+
+
+/**
+  Save as much information as possible about the partitioned
+  specimen tube. The information is stored in the localStorage()
+  under the key 'reggie.specimen.<id>.partitionInfo' where
+  <id> is the ID of the specimen tube.
+*/
+function saveToLocalStorage(tubeIndex)
+{
+  if (window.localStorage && !isRestoringFromLocalStorage)
+  {
+    var tube = selectedTubes[tubeIndex];
+    var frm = document.forms['reggie'];
+    var storeInfo = new Object();
+    storeInfo.tubeId = tube.id;
+    storeInfo.bloody = frm['bloody'+tubeIndex].checked;
+    storeInfo.appearance = getSelectedValue(frm['appearance'+tubeIndex]);
+    storeInfo.necrosis = getSelectedValue(frm['necrosis'+tubeIndex]);
+    storeInfo.fat = getSelectedValue(frm['fat'+tubeIndex]);
+    storeInfo.coloured = frm['coloured'+tubeIndex].checked;
+    storeInfo.nofPieces = frm['nofPieces'+tubeIndex].value;
+    storeInfo.spWeight = frm['spWeight'+tubeIndex].value;
+    storeInfo.hisWeight = frm['hisWeight'+tubeIndex].value;
+    storeInfo.apWeight = frm['apWeight'+tubeIndex].value;
+    window.localStorage.setItem('reggie.specimen.' + tube.id + '.partitionInfo', JSON.stringify(storeInfo));
+    if (debug)
+    {
+      Main.debug(tubeIndex + ': ' + window.localStorage.getItem('reggie.specimen.' + tube.id + '.partitionInfo'));
+    }
+  }
+}
+
+function removeFromLocalStorage(tubeId)
+{
+  if (!window.localStorage) return;
+  if (debug) Main.debug('removeFromLocalStorage:' + tubeId);
+  window.localStorage.removeItem('reggie.specimen.' + tubeId + '.partitionInfo');
+}
+  
+function getStoredInfo(tubeId)
+{
+  if (!window.localStorage) return null;
+  try
+  {
+    var stored = window.localStorage.getItem('reggie.specimen.' + tubeId + '.partitionInfo');
+    if (debug) Main.debug(stored);
+    return stored ? JSON.parse(stored) : null;
+  }
+  catch (e)
+  {
+    Main.debug('Could not load stored information for tube ' + tubeId + ': ' + e);
+  }
+}
+
 function updateInputStatus(tubeIndex)
 {
+  saveToLocalStorage(tubeIndex);
   var frm = document.forms['reggie'];
   if(nofPiecesAreValid[tubeIndex] == false)
@@ -586 +673 @@
   submitInfo.tubeInfo = tubeInfo;
   
-  if (debug) Main.debug(JSON.stringify(caseInfo));      
+  if (debug) Main.debug(JSON.stringify(submitInfo));      
   var request = Ajax.getXmlHttpRequest();
   var url = 'PartitionRegistration.servlet?ID=<%=ID%>&cmd=CreatePartitions';
@@ -610 +697 @@
   setInnerHTML('done', msg);
   
+  for (var i = 0; i < response.partitioned.length; i++)
+  {
+    removeFromLocalStorage(response.partitioned[i]);
+  }
   
   Main.show('done');
@@ -664 +755 @@
         <td class="input"><select style="width:50%" name="tubeSelect" id="tubesSelect" multiple="multiple" size="12" onkeypress='doOnTab(event, goNextAuto)'></select></td>
         <td class="status" id="tubes.status"></td>
-        <td class="help"><span id="tubes.message" class="message" style="display: none;"></span>Select specimen tubes to include in the partition.</td>
+        <td class="help"><span id="tubes.message" class="message" style="display: none;"></span>Select specimen tubes to include in the partition.<br>
+        * = There is unsaved partitioning information for this tube
+        </td>
       </tr>
       </table>
@@ -711 +804 @@
     </tr>
     <tr>
-      <td class="stepfields">
-        <table id="weightInputs" border="0" cellspacing="0" cellpadding="0" width="100%"></table>
+      <td class="stepfields" id="weightInputs">
+        
       </td>
     </tr>

extensions/net.sf.basedb.reggie/trunk/resources/reggie.js

@@ -247 +247 @@
   return caseName.match(/^\d{7}$/);
 }
+
+/**
+  Get the selected value from a selection list.
+*/
+function getSelectedValue(list)
+{
+  if (list.selectedIndex < 0) return '';
+  return list[list.selectedIndex].value;
+}
+/**
+  Select the first option in the list that has the given value.
+*/
+function setSelectedValue(list, value)
+{
+  for (var i = 0; i < list.length; i++)
+  {
+    if (list[i].value == value)
+    {
+      list.selectedIndex = i;
+      return;
+    }
+  }
+}

extensions/net.sf.basedb.reggie/trunk/src/net/sf/basedb/reggie/servlet/PartitionRegistrationServlet.java

@@ -154 +154 @@
         JSONObject jsonInfo = (JSONObject)jsonReq.get("tubeInfo");        
         JSONArray jsonSpecimens = (JSONArray)jsonInfo.get("specimens");
+        JSONArray jsonPartitioned = new JSONArray();
         
         AnnotationType partitionDateType = Reggie.findAnnotationType(dc, new Item[]{Item.EXTRACT, Item.SAMPLE}, Reggie.ANNOTATION_PARTITION_DATE, true);
@@ -253 +254 @@
             specimen.setOriginalQuantity(originalQuantity);
             
-            jsonMessages.add("Specimen tube " + specimen.getName() + " partitioned successfully");            
+            jsonMessages.add("Specimen tube " + specimen.getName() + " partitioned successfully");
+            jsonPartitioned.add(specimen.getId());
           }
         }
         dc.commit();
+        json.put("partitioned", jsonPartitioned);
       } 
       json.put("messages", jsonMessages);