Merge branch 'bug/JAL-1707_retrieve-pdb-structure-for-rna' into Release_2_8_3_Branch
[jalview.git] / src / jalview / gui / StructureChooser.java
index f28ef68..c913213 100644 (file)
@@ -1,4 +1,5 @@
 /*
+
  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
  * Copyright (C) 2014 The Jalview Authors
  * 
@@ -26,6 +27,7 @@ import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
 import jalview.jbgui.GStructureChooser;
 import jalview.jbgui.PDBDocFieldPreferences;
+import jalview.structure.StructureSelectionManager;
 import jalview.util.MessageManager;
 import jalview.ws.dbsources.PDBRestClient;
 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
@@ -37,12 +39,15 @@ import java.awt.event.ItemEvent;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashSet;
+import java.util.Hashtable;
+import java.util.LinkedHashSet;
 import java.util.List;
-import java.util.Vector;
 
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
-import javax.swing.ListSelectionModel;
+import javax.swing.JLabel;
+import javax.swing.table.DefaultTableModel;
+
 
 /**
  * Provides the behaviors for the Structure chooser Panel
@@ -61,9 +66,9 @@ public class StructureChooser extends GStructureChooser
 
   private IProgressIndicator progressIndicator;
 
-  private Collection<PDBResponseSummary> discoveredStructuresSet = new HashSet<PDBResponseSummary>();
+  private Collection<PDBResponseSummary> discoveredStructuresSet;
 
-  private PDBRestRequest pdbRequest;
+  private PDBRestRequest lastPdbRequest;
 
   private PDBRestClient pdbRestCleint;
 
@@ -71,6 +76,8 @@ public class StructureChooser extends GStructureChooser
 
   private boolean isValidPBDEntry;
 
+  private static Hashtable<String, PDBEntry> cachedEntryMap;
+
   public StructureChooser(SequenceI[] selectedSeqs, SequenceI selectedSeq,
           AlignmentPanel ap)
   {
@@ -94,6 +101,7 @@ public class StructureChooser extends GStructureChooser
         long startTime = System.currentTimeMillis();
         String msg = MessageManager.getString("status.fetching_db_refs");
         updateProgressIndicator(msg, startTime);
+        loadLocalCachedPDBEntries();
         fetchStructuresMetaData();
         populateFilterComboBox();
         updateProgressIndicator(null, startTime);
@@ -130,17 +138,19 @@ public class StructureChooser extends GStructureChooser
     Collection<PDBDocField> wantedFields = PDBDocFieldPreferences
             .getStructureSummaryFields();
 
-    pdbRequest = new PDBRestRequest();
-    pdbRequest.setAllowEmptySeq(false);
-    pdbRequest.setResponseSize(500);
-    pdbRequest.setFieldToSearchBy("(text:");
-    pdbRequest.setWantedFields(wantedFields);
+    discoveredStructuresSet = new LinkedHashSet<PDBResponseSummary>();
     for (SequenceI seq : selectedSequences)
     {
+      PDBRestRequest pdbRequest = new PDBRestRequest();
+      pdbRequest.setAllowEmptySeq(false);
+      pdbRequest.setResponseSize(500);
+      pdbRequest.setFieldToSearchBy("(text:");
+      pdbRequest.setWantedFields(wantedFields);
       pdbRequest.setSearchTerm(buildQuery(seq) + ")");
       pdbRequest.setAssociatedSequence(seq.getName());
       pdbRestCleint = new PDBRestClient();
       PDBRestResponse resultList = pdbRestCleint.executeRequest(pdbRequest);
+      lastPdbRequest = pdbRequest;
       if (resultList.getSearchSummary() != null
               && !resultList.getSearchSummary().isEmpty())
       {
@@ -153,7 +163,7 @@ public class StructureChooser extends GStructureChooser
     if (discoveredStructuresSet != null
             && !discoveredStructuresSet.isEmpty())
     {
-      tbl_summary.setModel(PDBRestResponse.getTableModel(pdbRequest,
+      tbl_summary.setModel(PDBRestResponse.getTableModel(lastPdbRequest,
               discoveredStructuresSet));
       structuresDiscovered = true;
       noOfStructuresFound = discoveredStructuresSet.size();
@@ -164,6 +174,33 @@ public class StructureChooser extends GStructureChooser
             + " Found (" + totalTime + ")");
   }
 
+  public void loadLocalCachedPDBEntries()
+  {
+    DefaultTableModel tableModel = new DefaultTableModel();
+    tableModel.addColumn("Sequence");
+    tableModel.addColumn("PDB Id");
+    tableModel.addColumn("Type");
+    tableModel.addColumn("File");
+    cachedEntryMap = new Hashtable<String, PDBEntry>();
+    for (SequenceI seq : selectedSequences)
+    {
+      if (seq.getDatasetSequence() != null
+              && seq.getDatasetSequence().getPDBId() != null)
+      {
+        for (PDBEntry pdbEntry : seq.getDatasetSequence().getPDBId())
+        {
+          String[] pdbEntryRowData = new String[]
+          { seq.getDisplayId(false), pdbEntry.getId(), pdbEntry.getType(),
+              pdbEntry.getFile() };
+          tableModel.addRow(pdbEntryRowData);
+          cachedEntryMap.put(seq.getDisplayId(false) + pdbEntry.getId(),
+                  pdbEntry);
+        }
+      }
+    }
+    tbl_local_pdb.setModel(tableModel);
+  }
+
   /**
    * Update the DBRef entry for a given sequence with values retrieved from
    * PDBResponseSummary
@@ -192,41 +229,85 @@ public class StructureChooser extends GStructureChooser
    *          the sequences to build a query for
    * @return the built query string
    */
-  @SuppressWarnings("unchecked")
+
   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 : (Vector<PDBEntry>) seq.getPDBId())
+      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
@@ -243,19 +324,25 @@ public class StructureChooser extends GStructureChooser
         try
         {
           lbl_loading.setVisible(true);
-          pdbRequest.setResponseSize(1);
-          pdbRequest.setFieldToSearchBy("(text:");
-          pdbRequest.setFieldToSortBy(fieldToFilterBy,
-                  !chk_invertFilter.isSelected());
 
+          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 = pdbRestCleint
                     .executeRequest(pdbRequest);
+            lastPdbRequest = pdbRequest;
             if (resultList.getSearchSummary() != null
                     && !resultList.getSearchSummary().isEmpty())
             {
@@ -263,50 +350,37 @@ public class StructureChooser extends GStructureChooser
             }
           }
 
-          if (filteredResponse != null)
+          if (!filteredResponse.isEmpty())
           {
-            int filterResponseCount = filteredResponse.size();
-            List<PDBResponseSummary> originalDiscoveredStructuresList = new ArrayList<PDBResponseSummary>(
-                    discoveredStructuresSet);
-            originalDiscoveredStructuresList.removeAll(filteredResponse);
-            Collection<PDBResponseSummary> reorderedStructuresSet = new ArrayList<PDBResponseSummary>();
+            final int filterResponseCount = filteredResponse.size();
+            Collection<PDBResponseSummary> reorderedStructuresSet = new LinkedHashSet<PDBResponseSummary>();
             reorderedStructuresSet.addAll(filteredResponse);
-            reorderedStructuresSet.addAll(originalDiscoveredStructuresList);
+            reorderedStructuresSet.addAll(discoveredStructuresSet);
+            tbl_summary.setModel(PDBRestResponse.getTableModel(
+                    lastPdbRequest, reorderedStructuresSet));
 
-            tbl_summary.setModel(PDBRestResponse.getTableModel(pdbRequest,
-                    reorderedStructuresSet));
+            // Update table selection model here
+            tbl_summary.addRowSelectionInterval(0, filterResponseCount - 1);
 
-            ListSelectionModel model = tbl_summary.getSelectionModel();
-            model.clearSelection();
-            for (int x = 0; x < filterResponseCount; x++)
-            {
-              model.addSelectionInterval(x, x);
-            }
-
-            // Discard unwanted objects to make them eligible for garbage
-            // collection
-            originalDiscoveredStructuresList = null;
-            reorderedStructuresSet = null;
           }
 
           lbl_loading.setVisible(false);
+          String totalTime = (System.currentTimeMillis() - startTime)
+                  + " milli secs";
+          mainFrame.setTitle("Structure Chooser - Filter time ("
+                  + totalTime + ")");
+
+          validateSelections();
         } catch (Exception e)
         {
           e.printStackTrace();
         }
-        String totalTime = (System.currentTimeMillis() - startTime)
-                + " milli secs";
-        mainFrame.setTitle("Structure Chooser - Filter time (" + totalTime
-                + ")");
-
-        validateSelections();
       }
     });
     filterThread.start();
   }
 
 
-
   /**
    * Handles action event for btn_pdbFromFile
    */
@@ -356,6 +430,8 @@ public class StructureChooser extends GStructureChooser
             VIEWS_ENTER_ID));
     cmb_filterOption.addItem(new FilterOption("From File", "-",
             VIEWS_FROM_FILE));
+    cmb_filterOption.addItem(new FilterOption("Cached PDB Entries", "-",
+            VIEWS_LOCAL_PDB));
   }
 
   /**
@@ -376,7 +452,8 @@ public class StructureChooser extends GStructureChooser
       chk_invertFilter.setVisible(true);
       filterResultSet(selectedFilterOpt.getValue());
     }
-    else
+    else if (selectedFilterOpt.getView() == VIEWS_ENTER_ID
+            || selectedFilterOpt.getView() == VIEWS_FROM_FILE)
     {
       idInputAssSeqPanel.loadCmbAssSeq();
       fileChooserAssSeqPanel.loadCmbAssSeq();
@@ -401,6 +478,13 @@ public class StructureChooser extends GStructureChooser
         btn_view.setEnabled(true);
       }
     }
+    else if (currentView == VIEWS_LOCAL_PDB)
+    {
+      if (tbl_local_pdb.getSelectedRows().length > 0)
+      {
+        btn_view.setEnabled(true);
+      }
+    }
     else if (currentView == VIEWS_ENTER_ID)
     {
       validateAssociationEnterPdb();
@@ -409,7 +493,6 @@ public class StructureChooser extends GStructureChooser
     {
       validateAssociationFromFile();
     }
-
   }
 
   /**
@@ -504,7 +587,7 @@ public class StructureChooser extends GStructureChooser
     if (currentView == VIEWS_FILTER)
     {
       int pdbIdCol = PDBRestClient.getPDBIdColumIndex(
-              pdbRequest.getWantedFields(), true);
+              lastPdbRequest.getWantedFields(), true);
       int[] selectedRows = tbl_summary.getSelectedRows();
       PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length];
       int count = 0;
@@ -517,46 +600,90 @@ public class StructureChooser extends GStructureChooser
         pdbEntry.setType("PDB");
         pdbEntriesToView[count++] = pdbEntry;
       }
-      new StructureViewer(ap.getStructureSelectionManager())
-              .viewStructures(ap, pdbEntriesToView,
-                      ap.av.collateForPDB(pdbEntriesToView));
+
+      launchStructureViewer(ap.getStructureSelectionManager(),
+              pdbEntriesToView, ap, selectedSequences);
+    }
+    else if(currentView == VIEWS_LOCAL_PDB){
+      int[] selectedRows = tbl_local_pdb.getSelectedRows();
+      PDBEntry[] pdbEntriesToView = new PDBEntry[selectedRows.length];
+      int count = 0;
+      for (int row : selectedRows)
+      {
+         String entryKey = tbl_local_pdb.getValueAt(row, 0).toString() + tbl_local_pdb.getValueAt(row, 1).toString();
+        pdbEntriesToView[count++] = cachedEntryMap.get(entryKey);
+      }
+      launchStructureViewer(ap.getStructureSelectionManager(),
+              pdbEntriesToView, ap, selectedSequences);
     }
     else if (currentView == VIEWS_ENTER_ID)
     {
-      selectedSequence = ((AssociateSeqOptions) idInputAssSeqPanel
+      SequenceI userSelectedSeq = ((AssociateSeqOptions) idInputAssSeqPanel
               .getCmb_assSeq().getSelectedItem()).getSequence();
+      if (userSelectedSeq != null)
+      {
+        selectedSequence = userSelectedSeq;
+      }
       PDBEntry pdbEntry = new PDBEntry();
       pdbEntry.setId(txt_search.getText());
       pdbEntry.setType("PDB");
       selectedSequence.getDatasetSequence().addPDBId(pdbEntry);
       PDBEntry[] pdbEntriesToView = new PDBEntry[]
       { pdbEntry };
-      new StructureViewer(ap.getStructureSelectionManager())
-              .viewStructures(ap, pdbEntriesToView,
-                      ap.av.collateForPDB(pdbEntriesToView));
+      launchStructureViewer(ap.getStructureSelectionManager(),
+              pdbEntriesToView, ap, new SequenceI[]
+              { selectedSequence });
     }
     else if (currentView == VIEWS_FROM_FILE)
     {
-      selectedSequence = ((AssociateSeqOptions) fileChooserAssSeqPanel
+      SequenceI userSelectedSeq = ((AssociateSeqOptions) fileChooserAssSeqPanel
               .getCmb_assSeq().getSelectedItem()).getSequence();
-      new AssociatePdbFileWithSeq().associatePdbWithSeq(
+      if (userSelectedSeq != null)
+      {
+        selectedSequence = userSelectedSeq;
+      }
+      PDBEntry fileEntry = new AssociatePdbFileWithSeq()
+              .associatePdbWithSeq(
               selectedPdbFileName, jalview.io.AppletFormatAdapter.FILE,
               selectedSequence, true, Desktop.instance);
+
+      launchStructureViewer(ap.getStructureSelectionManager(),
+              new PDBEntry[]
+              { fileEntry }, ap, new SequenceI[]
+              { selectedSequence });
     }
     mainFrame.dispose();
   }
 
+  private void launchStructureViewer(StructureSelectionManager ssm,
+          PDBEntry[] pdbEntriesToView, AlignmentPanel alignPanel,
+          SequenceI[] selectedSequences)
+  {
+    StructureViewer sViewer = new StructureViewer(ssm);
+    if (pdbEntriesToView.length > 1)
+    {
+      sViewer.viewStructures(alignPanel, pdbEntriesToView,
+              alignPanel.av.collateForPDB(pdbEntriesToView));
+    }
+    else
+    {
+      sViewer.viewStructures(pdbEntriesToView[0], selectedSequences, null,
+              alignPanel);
+    }
+  }
+
   /**
    * Populates the combo-box used in associating manually fetched structures to
    * a unique sequence when more than one sequence selection is made.
    */
   public void populateCmbAssociateSeqOptions(
-          JComboBox<AssociateSeqOptions> cmb_assSeq)
+          JComboBox<AssociateSeqOptions> cmb_assSeq, JLabel lbl_associateSeq)
   {
     cmb_assSeq.removeAllItems();
     cmb_assSeq.addItem(new AssociateSeqOptions("-Select Associated Seq-",
             null));
     // cmb_assSeq.addItem(new AssociateSeqOptions("Auto Detect", null));
+    lbl_associateSeq.setVisible(false);
     if (selectedSequences.length > 1)
     {
       for (SequenceI seq : selectedSequences)
@@ -566,6 +693,10 @@ public class StructureChooser extends GStructureChooser
     }
     else
     {
+      String seqName = selectedSequence.getDisplayId(false);
+      seqName = seqName.length() <= 40 ? seqName : seqName.substring(0, 39);
+      lbl_associateSeq.setText(seqName);
+      lbl_associateSeq.setVisible(true);
       cmb_assSeq.setVisible(false);
     }
   }
@@ -593,7 +724,7 @@ public class StructureChooser extends GStructureChooser
     {
       List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
       wantedFields.add(PDBDocField.PDB_ID);
-      pdbRequest = new PDBRestRequest();
+      PDBRestRequest pdbRequest = new PDBRestRequest();
       pdbRequest.setAllowEmptySeq(false);
       pdbRequest.setResponseSize(1);
       pdbRequest.setFieldToSearchBy("(pdb_id:");
@@ -611,4 +742,23 @@ public class StructureChooser extends GStructureChooser
     validateSelections();
   }
 
+  @Override
+  public void tabRefresh()
+  {
+    if (selectedSequences != null)
+    {
+      Thread refreshThread = new Thread(new Runnable()
+      {
+        @Override
+        public void run()
+        {
+          fetchStructuresMetaData();
+          filterResultSet(((FilterOption) cmb_filterOption
+                  .getSelectedItem()).getValue());
+        }
+      });
+      refreshThread.start();
+    }
+  }
+
 }