JAL-2944 tidies for review comments
[jalview.git] / src / jalview / gui / SequenceFetcher.java
index 5d4ea68..f545e70 100755 (executable)
@@ -26,8 +26,10 @@ import jalview.datamodel.AlignmentI;
 import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
+import jalview.fts.core.GFTSPanel;
 import jalview.fts.service.pdb.PDBFTSPanel;
 import jalview.fts.service.uniprot.UniprotFTSPanel;
+import jalview.io.FileFormatI;
 import jalview.io.gff.SequenceOntologyI;
 import jalview.util.DBRefUtils;
 import jalview.util.MessageManager;
@@ -51,7 +53,6 @@ import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JInternalFrame;
 import javax.swing.JLabel;
-import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.JTextArea;
@@ -78,6 +79,8 @@ public class SequenceFetcher extends JPanel implements Runnable
 
   JButton close = new JButton();
 
+  JButton back = new JButton();
+
   JPanel jPanel1 = new JPanel();
 
   JTextArea textArea = new JTextArea();
@@ -136,11 +139,10 @@ public class SequenceFetcher extends JPanel implements Runnable
     {
       if (guiWindow != null)
       {
-        guiWindow
-                .setProgressBar(
-                        MessageManager
-                                .getString("status.waiting_sequence_database_fetchers_init"),
-                        Thread.currentThread().hashCode());
+        guiWindow.setProgressBar(
+                MessageManager.getString(
+                        "status.waiting_sequence_database_fetchers_init"),
+                Thread.currentThread().hashCode());
       }
       // initting happening on another thread - so wait around to see if it
       // finishes.
@@ -157,19 +159,17 @@ public class SequenceFetcher extends JPanel implements Runnable
       }
       if (guiWindow != null)
       {
-        guiWindow
-                .setProgressBar(
-                        MessageManager
-                                .getString("status.waiting_sequence_database_fetchers_init"),
-                        Thread.currentThread().hashCode());
+        guiWindow.setProgressBar(
+                MessageManager.getString(
+                        "status.waiting_sequence_database_fetchers_init"),
+                Thread.currentThread().hashCode());
       }
     }
-    if (sfetch == null
-            || dasRegistry != Cache.getDasSourceRegistry()
+    if (sfetch == null || dasRegistry != Cache.getDasSourceRegistry()
             || lastDasSourceRegistry != (Cache.getDasSourceRegistry()
-                    .getDasRegistryURL() + Cache
-                    .getDasSourceRegistry().getLocalSourceString())
-                    .hashCode())
+                    .getDasRegistryURL()
+                    + Cache.getDasSourceRegistry().getLocalSourceString())
+                            .hashCode())
     {
       _initingFetcher = true;
       initingThread = Thread.currentThread();
@@ -178,8 +178,9 @@ public class SequenceFetcher extends JPanel implements Runnable
        */
       if (guiWindow != null)
       {
-        guiWindow.setProgressBar(MessageManager
-                .getString("status.init_sequence_database_fetchers"),
+        guiWindow.setProgressBar(
+                MessageManager.getString(
+                        "status.init_sequence_database_fetchers"),
                 Thread.currentThread().hashCode());
       }
       dasRegistry = Cache.getDasSourceRegistry();
@@ -190,8 +191,8 @@ public class SequenceFetcher extends JPanel implements Runnable
       {
         guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
       }
-      lastDasSourceRegistry = (dasRegistry.getDasRegistryURL() + dasRegistry
-              .getLocalSourceString()).hashCode();
+      lastDasSourceRegistry = (dasRegistry.getDasRegistryURL()
+              + dasRegistry.getLocalSourceString()).hashCode();
       sfetch = sf;
       _initingFetcher = false;
       initingThread = null;
@@ -213,7 +214,7 @@ public class SequenceFetcher extends JPanel implements Runnable
   public SequenceFetcher(IProgressIndicator guiIndic,
           final String selectedDb, final String queryString)
   {
-    this._isConstructing=true;
+    this._isConstructing = true;
     this.progressIndicator = guiIndic;
     final SequenceFetcher us = this;
     // launch initialiser thread
@@ -226,7 +227,7 @@ public class SequenceFetcher extends JPanel implements Runnable
         if (getSequenceFetcherSingleton(progressIndicator) != null)
         {
           us.initGui(progressIndicator, selectedDb, queryString);
-          us._isConstructing=false;
+          us._isConstructing = false;
         }
         else
         {
@@ -235,14 +236,12 @@ public class SequenceFetcher extends JPanel implements Runnable
             @Override
             public void run()
             {
-              JOptionPane
-                      .showInternalMessageDialog(
-                              Desktop.desktop,
-                              MessageManager
-                                      .getString("warn.couldnt_create_sequence_fetcher_client"),
-                              MessageManager
-                                      .getString("label.couldnt_create_sequence_fetcher"),
-                              JOptionPane.ERROR_MESSAGE);
+              JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+                      MessageManager.getString(
+                              "warn.couldnt_create_sequence_fetcher_client"),
+                      MessageManager.getString(
+                              "label.couldnt_create_sequence_fetcher"),
+                      JvOptionPane.ERROR_MESSAGE);
             }
           });
 
@@ -252,23 +251,29 @@ public class SequenceFetcher extends JPanel implements Runnable
     });
     sf.start();
   }
+
   /**
-   * blocking call which creates a new sequence fetcher panel, configures it and presses the OK button with the given database and query.
+   * blocking call which creates a new sequence fetcher panel, configures it and
+   * presses the OK button with the given database and query.
+   * 
    * @param database
    * @param query
    */
   public static List<AlignFrame> fetchAndShow(String database, String query)
   {
-    final SequenceFetcher sf = new SequenceFetcher(Desktop.instance, database, query);
+    final SequenceFetcher sf = new SequenceFetcher(Desktop.instance,
+            database, query);
     while (sf._isConstructing)
     {
-      try { Thread.sleep(50);
+      try
+      {
+        Thread.sleep(50);
       } catch (Exception q)
       {
         return Collections.emptyList();
       }
     }
-    sf.newAlframes = new ArrayList<AlignFrame>();
+    sf.newAlframes = new ArrayList<>();
     sf.run();
     return sf.newAlframes;
   }
@@ -282,7 +287,7 @@ public class SequenceFetcher extends JPanel implements Runnable
   {
 
   };
-  
+
   /**
    * initialise the database and query for this fetcher panel
    * 
@@ -306,14 +311,15 @@ public class SequenceFetcher extends JPanel implements Runnable
         if (sourcep.getTier() == 0)
         {
           database.selection = Arrays
-                  .asList(new DbSourceProxy[] { sourcep });
+                  .asList(new DbSourceProxy[]
+                  { sourcep });
           break;
         }
       }
       if (database.selection == null || database.selection.size() == 0)
       {
-        System.err.println("Ignoring fetch parameter db='" + selectedDb
-                + "'");
+        System.err.println(
+                "Ignoring fetch parameter db='" + selectedDb + "'");
         return false;
       }
       textArea.setText(queryString);
@@ -374,11 +380,21 @@ public class SequenceFetcher extends JPanel implements Runnable
 
   private String getFrameTitle()
   {
-    return ((alignFrame == null) ? MessageManager
-            .getString("label.new_sequence_fetcher") : MessageManager
-            .getString("label.additional_sequence_fetcher"));
+    return ((alignFrame == null)
+            ? MessageManager.getString("label.new_sequence_fetcher")
+            : MessageManager
+                    .getString("label.additional_sequence_fetcher"));
   }
 
+  GFTSPanel parentFTSframe = null;
+  /**
+   * change the buttons so they fit with the FTS panel.
+   */
+  public void embedWithFTSPanel(GFTSPanel toClose)
+  {
+    back.setVisible(true);
+    parentFTSframe = toClose;
+  }
   private void jbInit() throws Exception
   {
     this.setLayout(borderLayout2);
@@ -393,8 +409,8 @@ public class SequenceFetcher extends JPanel implements Runnable
     replacePunctuation.setHorizontalAlignment(SwingConstants.CENTER);
     replacePunctuation
             .setFont(new java.awt.Font("Verdana", Font.ITALIC, 11));
-    replacePunctuation.setText(MessageManager
-            .getString("label.replace_commas_semicolons"));
+    replacePunctuation.setText(
+            MessageManager.getString("label.replace_commas_semicolons"));
     ok.setText(MessageManager.getString("action.ok"));
     ok.addActionListener(new ActionListener()
     {
@@ -423,7 +439,7 @@ public class SequenceFetcher extends JPanel implements Runnable
         example_actionPerformed();
       }
     });
-    close.setText(MessageManager.getString("action.close"));
+    close.setText(MessageManager.getString("action.cancel"));
     close.addActionListener(new ActionListener()
     {
       @Override
@@ -432,6 +448,17 @@ public class SequenceFetcher extends JPanel implements Runnable
         close_actionPerformed(e);
       }
     });
+    back.setText(MessageManager.getString("action.back"));
+    back.addActionListener(new ActionListener()
+    {
+      @Override
+      public void actionPerformed(ActionEvent e)
+      {
+        parentFTSframe.btn_back_ActionPerformed();
+      }
+    });
+    // back not visible unless embedded
+    back.setVisible(false);
     textArea.setFont(JvSwingUtils.getLabelFont());
     textArea.setLineWrap(true);
     textArea.addKeyListener(new KeyAdapter()
@@ -447,9 +474,10 @@ public class SequenceFetcher extends JPanel implements Runnable
     });
     jPanel3.setLayout(borderLayout1);
     borderLayout1.setVgap(5);
-    jPanel1.add(ok);
+    jPanel1.add(back);
     jPanel1.add(example);
     jPanel1.add(clear);
+    jPanel1.add(ok);
     jPanel1.add(close);
     jPanel2.setLayout(borderLayout3);
     databaseButt = /*database.getDatabaseSelectorButton();
@@ -523,6 +551,7 @@ public class SequenceFetcher extends JPanel implements Runnable
     new UniprotFTSPanel(this);
     frame.dispose();
   }
+
   private void otherSourceAction()
   {
     try
@@ -532,8 +561,9 @@ public class SequenceFetcher extends JPanel implements Runnable
                       + database.getSelectedSources().size() + " others)"
                       : ""));
       String eq = database.getExampleQueries();
-      dbeg.setText(MessageManager.formatMessage(
-              "label.example_query_param", new String[] { eq }));
+      dbeg.setText(MessageManager.formatMessage("label.example_query_param",
+              new String[]
+              { eq }));
       boolean enablePunct = !(eq != null && eq.indexOf(",") > -1);
       for (DbSourceProxy dbs : database.getSelectedSources())
       {
@@ -576,6 +606,10 @@ public class SequenceFetcher extends JPanel implements Runnable
     try
     {
       frame.setClosed(true);
+      if (parentFTSframe!=null)
+      {
+        parentFTSframe.btn_cancel_ActionPerformed();
+      }
     } catch (Exception ex)
     {
     }
@@ -588,7 +622,7 @@ public class SequenceFetcher extends JPanel implements Runnable
     textArea.setEnabled(false);
     ok.setEnabled(false);
     close.setEnabled(false);
-
+    back.setEnabled(false);
     Thread worker = new Thread(this);
     worker.start();
   }
@@ -600,6 +634,7 @@ public class SequenceFetcher extends JPanel implements Runnable
     textArea.setEnabled(true);
     ok.setEnabled(true);
     close.setEnabled(true);
+    back.setEnabled(parentFTSframe != null);
   }
 
   @Override
@@ -615,7 +650,7 @@ public class SequenceFetcher extends JPanel implements Runnable
     if (replacePunctuation.isEnabled() && replacePunctuation.isSelected())
     {
       empty = new com.stevesoft.pat.Regex(
-      // replace commas and spaces with a semicolon
+              // replace commas and spaces with a semicolon
               "(\\s|[,; ])+", ";");
     }
     else
@@ -625,8 +660,8 @@ public class SequenceFetcher extends JPanel implements Runnable
     }
     textArea.setText(empty.replaceAll(textArea.getText()));
     // see if there's anthing to search with
-    if (!new com.stevesoft.pat.Regex("[A-Za-z0-9_.]").search(textArea
-            .getText()))
+    if (!new com.stevesoft.pat.Regex("[A-Za-z0-9_.]")
+            .search(textArea.getText()))
     {
       error += "Please enter a (semi-colon separated list of) database id(s)";
     }
@@ -639,15 +674,15 @@ public class SequenceFetcher extends JPanel implements Runnable
     // TODO: Refactor to GUI independent code and write tests.
     // indicate if successive sources should be merged into one alignment.
     boolean addToLast = false;
-    List<String> aresultq = new ArrayList<String>();
-    List<String> presultTitle = new ArrayList<String>();
-    List<AlignmentI> presult = new ArrayList<AlignmentI>();
-    List<AlignmentI> aresult = new ArrayList<AlignmentI>();
+    List<String> aresultq = new ArrayList<>();
+    List<String> presultTitle = new ArrayList<>();
+    List<AlignmentI> presult = new ArrayList<>();
+    List<AlignmentI> aresult = new ArrayList<>();
     Iterator<DbSourceProxy> proxies = database.getSelectedSources()
             .iterator();
     String[] qries;
-    List<String> nextFetch = Arrays.asList(qries = textArea.getText()
-            .split(";"));
+    List<String> nextFetch = Arrays
+            .asList(qries = textArea.getText().split(";"));
     Iterator<String> en = Arrays.asList(new String[0]).iterator();
     int nqueries = qries.length;
 
@@ -660,20 +695,18 @@ public class SequenceFetcher extends JPanel implements Runnable
         nqueries = nextFetch.size();
         // save the remaining queries in the original array
         qries = nextFetch.toArray(new String[nqueries]);
-        nextFetch = new ArrayList<String>();
+        nextFetch = new ArrayList<>();
       }
 
       DbSourceProxy proxy = proxies.next();
       try
       {
         // update status
-        guiWindow
-                .setProgressBar(MessageManager.formatMessage(
-                        "status.fetching_sequence_queries_from",
-                        new String[] {
-                            Integer.valueOf(nqueries).toString(),
-                            proxy.getDbName() }), Thread.currentThread()
-                        .hashCode());
+        guiWindow.setProgressBar(MessageManager.formatMessage(
+                "status.fetching_sequence_queries_from", new String[]
+                { Integer.valueOf(nqueries).toString(),
+                    proxy.getDbName() }),
+                Thread.currentThread().hashCode());
         if (proxy.getMaximumQueryCount() == 1)
         {
           /*
@@ -697,8 +730,8 @@ public class SequenceFetcher extends JPanel implements Runnable
         }
       } catch (Exception e)
       {
-        showErrorMessage("Error retrieving " + textArea.getText()
-                + " from " + database.getSelectedItem());
+        showErrorMessage("Error retrieving " + textArea.getText() + " from "
+                + database.getSelectedItem());
         // error
         // +="Couldn't retrieve sequences from "+database.getSelectedItem();
         System.err.println("Retrieval failed for source ='"
@@ -708,9 +741,7 @@ public class SequenceFetcher extends JPanel implements Runnable
       } catch (OutOfMemoryError e)
       {
         showErrorMessage("Out of Memory when retrieving "
-                + textArea.getText()
-                + " from "
-                + database.getSelectedItem()
+                + textArea.getText() + " from " + database.getSelectedItem()
                 + "\nPlease see the Jalview FAQ for instructions for increasing the memory available to Jalview.\n");
         e.printStackTrace();
       } catch (Error e)
@@ -738,8 +769,8 @@ public class SequenceFetcher extends JPanel implements Runnable
           while (aresult.size() > 0)
           {
             presult.add(aresult.remove(0));
-            presultTitle.add(aresultq.remove(0) + " "
-                    + getDefaultRetrievalTitle());
+            presultTitle.add(
+                    aresultq.remove(0) + " " + getDefaultRetrievalTitle());
           }
         }
         else
@@ -767,15 +798,17 @@ public class SequenceFetcher extends JPanel implements Runnable
           presultTitle.add(titl);
         }
       }
-      guiWindow.setProgressBar(MessageManager
-              .getString("status.finshed_querying"), Thread.currentThread()
-              .hashCode());
+      guiWindow.setProgressBar(
+              MessageManager.getString("status.finshed_querying"),
+              Thread.currentThread().hashCode());
     }
-    guiWindow.setProgressBar(
-            (presult.size() > 0) ? MessageManager
-                    .getString("status.parsing_results") : MessageManager
-                    .getString("status.processing"), Thread.currentThread()
-                    .hashCode());
+    guiWindow
+            .setProgressBar(
+                    (presult.size() > 0)
+                            ? MessageManager
+                                    .getString("status.parsing_results")
+                            : MessageManager.getString("status.processing"),
+                    Thread.currentThread().hashCode());
     // process results
     while (presult.size() > 0)
     {
@@ -788,8 +821,9 @@ public class SequenceFetcher extends JPanel implements Runnable
     {
       StringBuffer sb = new StringBuffer();
       sb.append("Didn't retrieve the following "
-              + (nextFetch.size() == 1 ? "query" : nextFetch.size()
-                      + " queries") + ": \n");
+              + (nextFetch.size() == 1 ? "query"
+                      : nextFetch.size() + " queries")
+              + ": \n");
       int l = sb.length(), lr = 0;
       for (String s : nextFetch)
       {
@@ -824,11 +858,10 @@ public class SequenceFetcher extends JPanel implements Runnable
    */
   void fetchMultipleAccessions(DbSourceProxy proxy,
           Iterator<String> accessions, List<String> aresultq,
-          List<AlignmentI> aresult, List<String> nextFetch)
-          throws Exception
+          List<AlignmentI> aresult, List<String> nextFetch) throws Exception
   {
     StringBuilder multiacc = new StringBuilder();
-    List<String> tosend = new ArrayList<String>();
+    List<String> tosend = new ArrayList<>();
     while (accessions.hasNext())
     {
       String nel = accessions.next();
@@ -900,8 +933,9 @@ public class SequenceFetcher extends JPanel implements Runnable
         indres = proxy.getSequenceRecords(accession);
       } catch (OutOfMemoryError oome)
       {
-        new OOMWarning("fetching " + accession + " from "
-                + proxy.getDbName(), oome, this);
+        new OOMWarning(
+                "fetching " + accession + " from " + proxy.getDbName(),
+                oome, this);
       }
       if (indres != null)
       {
@@ -911,9 +945,8 @@ public class SequenceFetcher extends JPanel implements Runnable
       }
     } catch (Exception e)
     {
-      Cache.log.info(
-              "Error retrieving " + accession
-              + " from " + proxy.getDbName(), e);
+      Cache.log.info("Error retrieving " + accession + " from "
+              + proxy.getDbName(), e);
     }
     return success;
   }
@@ -972,7 +1005,7 @@ public class SequenceFetcher extends JPanel implements Runnable
   }
 
   AlignmentI parseResult(AlignmentI al, String title,
-          String currentFileFormat,
+          FileFormatI currentFileFormat,
           FeatureSettingsModelI preferredFeatureColours)
   {
 
@@ -1000,15 +1033,11 @@ public class SequenceFetcher extends JPanel implements Runnable
         {
           for (SequenceI sq : alsqs)
           {
-            if ((sfs = sq.getSequenceFeatures()) != null)
+            if (sq.getFeatures().hasFeatures())
             {
-              if (sfs.length > 0)
-              {
-                af.setShowSeqFeatures(true);
-                break;
-              }
+              af.setShowSeqFeatures(true);
+              break;
             }
-
           }
         }
 
@@ -1032,8 +1061,7 @@ public class SequenceFetcher extends JPanel implements Runnable
 
         try
         {
-          af.setMaximum(Cache.getDefault("SHOW_FULLSCREEN",
-                  false));
+          af.setMaximum(Cache.getDefault("SHOW_FULLSCREEN", false));
         } catch (Exception ex)
         {
         }
@@ -1054,9 +1082,9 @@ public class SequenceFetcher extends JPanel implements Runnable
       @Override
       public void run()
       {
-        JOptionPane.showInternalMessageDialog(Desktop.desktop, error,
+        JvOptionPane.showInternalMessageDialog(Desktop.desktop, error,
                 MessageManager.getString("label.error_retrieving_data"),
-                JOptionPane.WARNING_MESSAGE);
+                JvOptionPane.WARNING_MESSAGE);
       }
     });
   }
@@ -1088,4 +1116,9 @@ public class SequenceFetcher extends JPanel implements Runnable
   {
     frame.setVisible(false);
   }
+
+  public void setDatabaseChooserVisible(boolean b)
+  {
+    databaseButt.setVisible(b);
+  }
 }