validate PDB selections on mouse release event
[jalview.git] / src / jalview / gui / StructureChooser.java
index 5c86ce2..2f24c61 100644 (file)
@@ -46,6 +46,7 @@ import java.util.List;
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JLabel;
+import javax.swing.JOptionPane;
 import javax.swing.table.DefaultTableModel;
 
 
@@ -139,6 +140,7 @@ public class StructureChooser extends GStructureChooser
             .getStructureSummaryFields();
 
     discoveredStructuresSet = new LinkedHashSet<PDBResponseSummary>();
+    HashSet<String> errors = new HashSet<String>();
     for (SequenceI seq : selectedSequences)
     {
       PDBRestRequest pdbRequest = new PDBRestRequest();
@@ -149,17 +151,27 @@ public class StructureChooser extends GStructureChooser
       pdbRequest.setSearchTerm(buildQuery(seq) + ")");
       pdbRequest.setAssociatedSequence(seq.getName());
       pdbRestCleint = new PDBRestClient();
-      PDBRestResponse resultList = pdbRestCleint.executeRequest(pdbRequest);
+      PDBRestResponse resultList;
+      try
+      {
+        resultList = pdbRestCleint.executeRequest(pdbRequest);
+      } catch (Exception e)
+      {
+        errors.add(e.getMessage());
+        continue;
+      }
       lastPdbRequest = pdbRequest;
       if (resultList.getSearchSummary() != null
               && !resultList.getSearchSummary().isEmpty())
       {
         discoveredStructuresSet.addAll(resultList.getSearchSummary());
-        updateSequenceDbRef(seq, resultList.getSearchSummary());
+        updateSequencePDBEntries(seq, resultList.getSearchSummary());
       }
     }
 
     int noOfStructuresFound = 0;
+    String totalTime = (System.currentTimeMillis() - startTime)
+            + " milli secs";
     if (discoveredStructuresSet != null
             && !discoveredStructuresSet.isEmpty())
     {
@@ -167,11 +179,25 @@ public class StructureChooser extends GStructureChooser
               discoveredStructuresSet));
       structuresDiscovered = true;
       noOfStructuresFound = discoveredStructuresSet.size();
+      mainFrame.setTitle("Structure Chooser - " + noOfStructuresFound
+              + " Found (" + totalTime + ")");
+    }
+    else
+    {
+      mainFrame
+.setTitle("Structure Chooser - Manual association");
+      if (errors.size() > 0)
+      {
+        StringBuilder errorMsg = new StringBuilder();
+        // "Operation was unsucessful due to the following: \n");
+        for (String error : errors)
+        {
+          errorMsg.append(error).append("\n");
+        }
+        JOptionPane.showMessageDialog(this, errorMsg.toString(),
+                "PDB Web-service Error", JOptionPane.ERROR_MESSAGE);
+      }
     }
-    String totalTime = (System.currentTimeMillis() - startTime)
-            + " milli secs";
-    mainFrame.setTitle("Structure Chooser - " + noOfStructuresFound
-            + " Found (" + totalTime + ")");
   }
 
   public void loadLocalCachedPDBEntries()
@@ -179,6 +205,7 @@ public class StructureChooser extends GStructureChooser
     DefaultTableModel tableModel = new DefaultTableModel();
     tableModel.addColumn("Sequence");
     tableModel.addColumn("PDB Id");
+    tableModel.addColumn("Chain");
     tableModel.addColumn("Type");
     tableModel.addColumn("File");
     cachedEntryMap = new Hashtable<String, PDBEntry>();
@@ -189,11 +216,19 @@ public class StructureChooser extends GStructureChooser
       {
         for (PDBEntry pdbEntry : seq.getDatasetSequence().getPDBId())
         {
+
+          String chain = pdbEntry.getChainCode() == null ? "_" : pdbEntry
+                  .getChainCode();
           String[] pdbEntryRowData = new String[]
-          { seq.getDisplayId(false), pdbEntry.getId(), pdbEntry.getType(),
+          { seq.getDisplayId(false), pdbEntry.getId(),
+ chain,
+              pdbEntry.getType(),
               pdbEntry.getFile() };
-          tableModel.addRow(pdbEntryRowData);
-          cachedEntryMap.put(seq.getDisplayId(false) + pdbEntry.getId(),
+          if (pdbEntry.getFile() != null)
+          {
+            tableModel.addRow(pdbEntryRowData);
+          }
+          cachedEntryMap.put(pdbEntry.getId().toLowerCase(),
                   pdbEntry);
         }
       }
@@ -202,7 +237,7 @@ public class StructureChooser extends GStructureChooser
   }
 
   /**
-   * Update the DBRef entry for a given sequence with values retrieved from
+   * Update the PDBEntry for a given sequence with values retrieved from
    * PDBResponseSummary
    * 
    * @param seq
@@ -210,15 +245,20 @@ public class StructureChooser extends GStructureChooser
    * @param responseSummaries
    *          a collection of PDBResponseSummary
    */
-  public void updateSequenceDbRef(SequenceI seq,
+  public void updateSequencePDBEntries(SequenceI seq,
           Collection<PDBResponseSummary> responseSummaries)
   {
     for (PDBResponseSummary response : responseSummaries)
     {
-      PDBEntry newEntry = new PDBEntry();
-      newEntry.setId(response.getPdbId());
-      newEntry.setType("PDB");
-      seq.getDatasetSequence().addPDBId(newEntry);
+      String pdbIdStr = response.getPdbId();
+      PDBEntry pdbEntry = cachedEntryMap.get(pdbIdStr.toLowerCase());
+      if (pdbEntry == null)
+      {
+        pdbEntry = new PDBEntry();
+        pdbEntry.setId(pdbIdStr);
+        pdbEntry.setType(PDBEntry.Type.PDB);
+      }
+      seq.getDatasetSequence().addPDBId(pdbEntry);
     }
   }
 
@@ -232,38 +272,82 @@ public class StructureChooser extends GStructureChooser
 
   public static String buildQuery(SequenceI seq)
   {
-    String query = seq.getName();
-    StringBuilder queryBuilder = new StringBuilder();
-    int count = 0;
+    HashSet<String> seqRefs = new LinkedHashSet<String>();
+    String seqName = seq.getName();
+    String[] names = seqName.toLowerCase().split("\\|");
+    for (String name : names)
+    {
+      // System.out.println("Found name : " + name);
+      name.trim();
+      if (isValidSeqName(name))
+      {
+        seqRefs.add(name);
+      }
+    }
 
     if (seq.getPDBId() != null)
     {
       for (PDBEntry entry : seq.getPDBId())
       {
-        queryBuilder.append("text:").append(entry.getId()).append(" OR ");
+        seqRefs.add(entry.getId());
       }
     }
 
     if (seq.getDBRef() != null && seq.getDBRef().length != 0)
     {
+      int count = 0;
       for (DBRefEntry dbRef : seq.getDBRef())
       {
-        queryBuilder.append("text:")
-                .append(dbRef.getAccessionId().replaceAll("GO:", ""))
-                .append(" OR ");
+        seqRefs.add(getDBRefId(dbRef));
         ++count;
         if (count > 10)
         {
           break;
         }
       }
-      int endIndex = queryBuilder.lastIndexOf(" OR ");
-      query = queryBuilder.toString().substring(5, endIndex);
     }
+
+    StringBuilder queryBuilder = new StringBuilder();
+    for (String seqRef : seqRefs)
+    {
+      queryBuilder.append("text:").append(seqRef).append(" OR ");
+    }
+    int endIndex = queryBuilder.lastIndexOf(" OR ");
+    String query = queryBuilder.toString().substring(5, endIndex);
     return query;
   }
 
   /**
+   * Ensures sequence ref names are not less than 3 characters and does not
+   * contain a database name
+   * 
+   * @param seqName
+   * @return
+   */
+  public static boolean isValidSeqName(String seqName)
+  {
+    String ignoreList = "pdb,uniprot";
+    if (seqName.length() < 3)
+    {
+      return false;
+    }
+    for (String ignoredEntry : ignoreList.split(","))
+    {
+      if (seqName.equalsIgnoreCase(ignoredEntry))
+      {
+        return false;
+      }
+    }
+    return true;
+  }
+
+  public static String getDBRefId(DBRefEntry dbRef)
+  {
+    String ref = dbRef.getAccessionId().replaceAll("GO:", "");
+    return ref;
+  }
+
+  /**
    * Filters a given list of discovered structures based on supplied argument
    * 
    * @param fieldToFilterBy
@@ -277,60 +361,76 @@ public class StructureChooser extends GStructureChooser
       public void run()
       {
         long startTime = System.currentTimeMillis();
-        try
+        lbl_loading.setVisible(true);
+        Collection<PDBDocField> wantedFields = PDBDocFieldPreferences
+                .getStructureSummaryFields();
+        Collection<PDBResponseSummary> filteredResponse = new HashSet<PDBResponseSummary>();
+        HashSet<String> errors = new HashSet<String>();
+        for (SequenceI seq : selectedSequences)
         {
-          lbl_loading.setVisible(true);
-
-          Collection<PDBDocField> wantedFields = PDBDocFieldPreferences
-                  .getStructureSummaryFields();
-          Collection<PDBResponseSummary> filteredResponse = new HashSet<PDBResponseSummary>();
-          for (SequenceI seq : selectedSequences)
+          PDBRestRequest pdbRequest = new PDBRestRequest();
+          pdbRequest.setAllowEmptySeq(false);
+          pdbRequest.setResponseSize(1);
+          pdbRequest.setFieldToSearchBy("(text:");
+          pdbRequest.setFieldToSortBy(fieldToFilterBy,
+                  !chk_invertFilter.isSelected());
+          pdbRequest.setSearchTerm(buildQuery(seq) + ")");
+          pdbRequest.setWantedFields(wantedFields);
+          pdbRequest.setAssociatedSequence(seq.getName());
+          pdbRestCleint = new PDBRestClient();
+          PDBRestResponse resultList;
+          try
           {
-            PDBRestRequest pdbRequest = new PDBRestRequest();
-            pdbRequest.setAllowEmptySeq(false);
-            pdbRequest.setResponseSize(1);
-            pdbRequest.setFieldToSearchBy("(text:");
-            pdbRequest.setFieldToSortBy(fieldToFilterBy,
-                    !chk_invertFilter.isSelected());
-            pdbRequest.setSearchTerm(buildQuery(seq) + ")");
-            pdbRequest.setWantedFields(wantedFields);
-            pdbRequest.setAssociatedSequence(seq.getName());
-            pdbRestCleint = new PDBRestClient();
-            PDBRestResponse resultList = pdbRestCleint
-                    .executeRequest(pdbRequest);
-            lastPdbRequest = pdbRequest;
-            if (resultList.getSearchSummary() != null
-                    && !resultList.getSearchSummary().isEmpty())
-            {
-              filteredResponse.addAll(resultList.getSearchSummary());
-            }
+            resultList = pdbRestCleint.executeRequest(pdbRequest);
+          } catch (Exception e)
+          {
+            errors.add(e.getMessage());
+            continue;
           }
-
-          if (!filteredResponse.isEmpty())
+          lastPdbRequest = pdbRequest;
+          if (resultList.getSearchSummary() != null
+                  && !resultList.getSearchSummary().isEmpty())
           {
-            final int filterResponseCount = filteredResponse.size();
-            Collection<PDBResponseSummary> reorderedStructuresSet = new LinkedHashSet<PDBResponseSummary>();
-            reorderedStructuresSet.addAll(filteredResponse);
-            reorderedStructuresSet.addAll(discoveredStructuresSet);
-            tbl_summary.setModel(PDBRestResponse.getTableModel(
-                    lastPdbRequest, reorderedStructuresSet));
+            filteredResponse.addAll(resultList.getSearchSummary());
+          }
+        }
 
-            // Update table selection model here
-            tbl_summary.addRowSelectionInterval(0, filterResponseCount - 1);
+        String totalTime = (System.currentTimeMillis() - startTime)
+                + " milli secs";
+        if (!filteredResponse.isEmpty())
+        {
+          final int filterResponseCount = filteredResponse.size();
+          Collection<PDBResponseSummary> reorderedStructuresSet = new LinkedHashSet<PDBResponseSummary>();
+          reorderedStructuresSet.addAll(filteredResponse);
+          reorderedStructuresSet.addAll(discoveredStructuresSet);
+          tbl_summary.setModel(PDBRestResponse.getTableModel(
+                  lastPdbRequest, reorderedStructuresSet));
 
-          }
+          // Update table selection model here
+          tbl_summary.addRowSelectionInterval(0, filterResponseCount - 1);
 
-          lbl_loading.setVisible(false);
-          String totalTime = (System.currentTimeMillis() - startTime)
-                  + " milli secs";
           mainFrame.setTitle("Structure Chooser - Filter time ("
                   + totalTime + ")");
-
-          validateSelections();
-        } catch (Exception e)
+        }
+        else
         {
-          e.printStackTrace();
+          mainFrame.setTitle("Structure Chooser - Filter time ("
+                  + totalTime + ")");
+          if (errors.size() > 0)
+          {
+            StringBuilder errorMsg = new StringBuilder();
+            for (String error : errors)
+            {
+              errorMsg.append(error).append("\n");
+            }
+            JOptionPane.showMessageDialog(null, errorMsg.toString(),
+                    "PDB Web-service Error", JOptionPane.ERROR_MESSAGE);
+          }
         }
+
+        lbl_loading.setVisible(false);
+
+        validateSelections();
       }
     });
     filterThread.start();
@@ -411,6 +511,7 @@ public class StructureChooser extends GStructureChooser
     else if (selectedFilterOpt.getView() == VIEWS_ENTER_ID
             || selectedFilterOpt.getView() == VIEWS_FROM_FILE)
     {
+      mainFrame.setTitle(filterTitle);
       idInputAssSeqPanel.loadCmbAssSeq();
       fileChooserAssSeqPanel.loadCmbAssSeq();
     }
@@ -459,6 +560,21 @@ public class StructureChooser extends GStructureChooser
     AssociateSeqOptions assSeqOpt = (AssociateSeqOptions) idInputAssSeqPanel
             .getCmb_assSeq().getSelectedItem();
     lbl_pdbManualFetchStatus.setIcon(errorImage);
+    lbl_pdbManualFetchStatus.setToolTipText("");
+    if (txt_search.getText().length() > 0)
+    {
+      lbl_pdbManualFetchStatus.setToolTipText(JvSwingUtils.wrapTooltip(
+              true, "No PDB entry found for \'" + txt_search.getText()
+                      + "\'"));
+    }
+
+    if (errorWarning.length() > 0)
+    {
+      lbl_pdbManualFetchStatus.setIcon(warningImage);
+      lbl_pdbManualFetchStatus.setToolTipText(JvSwingUtils.wrapTooltip(
+              true, errorWarning.toString()));
+    }
+
     if (selectedSequences.length == 1
             || !assSeqOpt.getName().equalsIgnoreCase(
                     "-Select Associated Seq-"))
@@ -467,6 +583,7 @@ public class StructureChooser extends GStructureChooser
       if (isValidPBDEntry)
       {
         btn_view.setEnabled(true);
+        lbl_pdbManualFetchStatus.setToolTipText("");
         lbl_pdbManualFetchStatus.setIcon(goodImage);
       }
     }
@@ -551,12 +668,16 @@ public class StructureChooser extends GStructureChooser
       {
         String pdbIdStr = tbl_summary.getValueAt(summaryRow, pdbIdCol)
                 .toString();
-        PDBEntry pdbEntry = new PDBEntry();
-        pdbEntry.setId(pdbIdStr);
-        pdbEntry.setType("PDB");
+
+        PDBEntry pdbEntry = cachedEntryMap.get(pdbIdStr.toLowerCase());
+        if (pdbEntry == null)
+        {
+          pdbEntry = new PDBEntry();
+          pdbEntry.setId(pdbIdStr);
+          pdbEntry.setType(PDBEntry.Type.PDB);
+        }
         pdbEntriesToView[count++] = pdbEntry;
       }
-
       launchStructureViewer(ap.getStructureSelectionManager(),
               pdbEntriesToView, ap, selectedSequences);
     }
@@ -566,7 +687,8 @@ public class StructureChooser extends GStructureChooser
       int count = 0;
       for (int row : selectedRows)
       {
-         String entryKey = tbl_local_pdb.getValueAt(row, 0).toString() + tbl_local_pdb.getValueAt(row, 1).toString();
+        String entryKey = tbl_local_pdb.getValueAt(row, 1).toString()
+                .toLowerCase();
         pdbEntriesToView[count++] = cachedEntryMap.get(entryKey);
       }
       launchStructureViewer(ap.getStructureSelectionManager(),
@@ -580,9 +702,16 @@ public class StructureChooser extends GStructureChooser
       {
         selectedSequence = userSelectedSeq;
       }
-      PDBEntry pdbEntry = new PDBEntry();
-      pdbEntry.setId(txt_search.getText());
-      pdbEntry.setType("PDB");
+
+      String pdbIdStr = txt_search.getText();
+      PDBEntry pdbEntry = cachedEntryMap.get(pdbIdStr.toLowerCase());
+      if (pdbEntry == null)
+      {
+        pdbEntry = new PDBEntry();
+        pdbEntry.setId(txt_search.getText());
+        pdbEntry.setType(PDBEntry.Type.PDB);
+      }
+
       selectedSequence.getDatasetSequence().addPDBId(pdbEntry);
       PDBEntry[] pdbEntriesToView = new PDBEntry[]
       { pdbEntry };
@@ -675,6 +804,7 @@ public class StructureChooser extends GStructureChooser
   @Override
   protected void txt_search_ActionPerformed()
   {
+    errorWarning.setLength(0);
     isValidPBDEntry = false;
     if (txt_search.getText().length() > 0)
     {
@@ -688,7 +818,21 @@ public class StructureChooser extends GStructureChooser
       pdbRequest.setSearchTerm(txt_search.getText() + ")");
       pdbRequest.setAssociatedSequence(selectedSequence.getName());
       pdbRestCleint = new PDBRestClient();
-      PDBRestResponse resultList = pdbRestCleint.executeRequest(pdbRequest);
+      PDBRestResponse resultList;
+      try
+      {
+        resultList = pdbRestCleint.executeRequest(pdbRequest);
+      } catch (Exception e)
+      {
+        // JOptionPane.showMessageDialog(this, e.getMessage(),
+        // "PDB Web-service Error", JOptionPane.ERROR_MESSAGE);
+        errorWarning.append(e.getMessage());
+        return;
+      } finally
+      {
+        // System.out.println(">>>>> executing finally block");
+        validateSelections();
+      }
       if (resultList.getSearchSummary() != null
               && resultList.getSearchSummary().size() > 0)
       {