src/jalview/gui/SequenceFetcher.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.gui;
  22
  23 import jalview.api.FeatureSettingsModelI;
  24 import jalview.bin.Cache;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.DBRefEntry;
  27 import jalview.datamodel.SequenceFeature;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.fts.service.pdb.PDBFTSPanel;
  30 import jalview.fts.service.uniprot.UniprotFTSPanel;
  31 import jalview.io.gff.SequenceOntologyI;
  32 import jalview.util.DBRefUtils;
  33 import jalview.util.MessageManager;
  34 import jalview.ws.dbsources.das.api.DasSourceRegistryI;
  35 import jalview.ws.seqfetcher.DbSourceProxy;
  36
  37 import java.awt.BorderLayout;
  38 import java.awt.Font;
  39 import java.awt.event.ActionEvent;
  40 import java.awt.event.ActionListener;
  41 import java.awt.event.KeyAdapter;
  42 import java.awt.event.KeyEvent;
  43 import java.util.ArrayList;
  44 import java.util.Arrays;
  45 import java.util.Iterator;
  46 import java.util.List;
  47
  48 import javax.swing.JButton;
  49 import javax.swing.JCheckBox;
  50 import javax.swing.JInternalFrame;
  51 import javax.swing.JLabel;
  52 import javax.swing.JOptionPane;
  53 import javax.swing.JPanel;
  54 import javax.swing.JScrollPane;
  55 import javax.swing.JTextArea;
  56 import javax.swing.SwingConstants;
  57 import javax.swing.tree.DefaultMutableTreeNode;
  58
  59 public class SequenceFetcher extends JPanel implements Runnable
  60 {
  61   JLabel dbeg = new JLabel();
  62
  63   JDatabaseTree database;
  64
  65   JButton databaseButt;
  66
  67   JLabel jLabel1 = new JLabel();
  68
  69   JCheckBox replacePunctuation = new JCheckBox();
  70
  71   JButton ok = new JButton();
  72
  73   JButton clear = new JButton();
  74
  75   JButton example = new JButton();
  76
  77   JButton close = new JButton();
  78
  79   JPanel jPanel1 = new JPanel();
  80
  81   JTextArea textArea = new JTextArea();
  82
  83   JScrollPane jScrollPane1 = new JScrollPane();
  84
  85   JPanel jPanel2 = new JPanel();
  86
  87   JPanel jPanel3 = new JPanel();
  88
  89   JPanel jPanel4 = new JPanel();
  90
  91   BorderLayout borderLayout1 = new BorderLayout();
  92
  93   BorderLayout borderLayout2 = new BorderLayout();
  94
  95   BorderLayout borderLayout3 = new BorderLayout();
  96
  97   JInternalFrame frame;
  98
  99   IProgressIndicator guiWindow;
 100
 101   AlignFrame alignFrame;
 102
 103   StringBuffer result;
 104
 105   final String noDbSelected = "-- Select Database --";
 106
 107   private static jalview.ws.SequenceFetcher sfetch = null;
 108
 109   private static long lastDasSourceRegistry = -3;
 110
 111   private static DasSourceRegistryI dasRegistry = null;
 112
 113   private static boolean _initingFetcher = false;
 114
 115   private static Thread initingThread = null;
 116
 117   int debounceTrap = 0;
 118
 119   public JTextArea getTextArea()
 120   {
 121     return textArea;
 122   }
 123
 124   /**
 125    * Blocking method that initialises and returns the shared instance of the
 126    * SequenceFetcher client
 127    *
 128    * @param guiWindow
 129    *          - where the initialisation delay message should be shown
 130    * @return the singleton instance of the sequence fetcher client
 131    */
 132   public static jalview.ws.SequenceFetcher getSequenceFetcherSingleton(
 133           final IProgressIndicator guiWindow)
 134   {
 135     if (_initingFetcher && initingThread != null && initingThread.isAlive())
 136     {
 137       if (guiWindow != null)
 138       {
 139         guiWindow
 140                 .setProgressBar(
 141                         MessageManager
 142                                 .getString("status.waiting_sequence_database_fetchers_init"),
 143                         Thread.currentThread().hashCode());
 144       }
 145       // initting happening on another thread - so wait around to see if it
 146       // finishes.
 147       while (_initingFetcher && initingThread != null
 148               && initingThread.isAlive())
 149       {
 150         try
 151         {
 152           Thread.sleep(10);
 153         } catch (Exception e)
 154         {
 155         }
 156         ;
 157       }
 158       if (guiWindow != null)
 159       {
 160         guiWindow
 161                 .setProgressBar(
 162                         MessageManager
 163                                 .getString("status.waiting_sequence_database_fetchers_init"),
 164                         Thread.currentThread().hashCode());
 165       }
 166     }
 167     if (sfetch == null
 168             || dasRegistry != Cache.getDasSourceRegistry()
 169             || lastDasSourceRegistry != (Cache.getDasSourceRegistry()
 170                     .getDasRegistryURL() + Cache
 171                     .getDasSourceRegistry().getLocalSourceString())
 172                     .hashCode())
 173     {
 174       _initingFetcher = true;
 175       initingThread = Thread.currentThread();
 176       /**
 177        * give a visual indication that sequence fetcher construction is occuring
 178        */
 179       if (guiWindow != null)
 180       {
 181         guiWindow.setProgressBar(MessageManager
 182                 .getString("status.init_sequence_database_fetchers"),
 183                 Thread.currentThread().hashCode());
 184       }
 185       dasRegistry = Cache.getDasSourceRegistry();
 186       dasRegistry.refreshSources();
 187
 188       jalview.ws.SequenceFetcher sf = new jalview.ws.SequenceFetcher();
 189       if (guiWindow != null)
 190       {
 191         guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
 192       }
 193       lastDasSourceRegistry = (dasRegistry.getDasRegistryURL() + dasRegistry
 194               .getLocalSourceString()).hashCode();
 195       sfetch = sf;
 196       _initingFetcher = false;
 197       initingThread = null;
 198     }
 199     return sfetch;
 200   }
 201
 202   private IProgressIndicator progressIndicator;
 203
 204   public SequenceFetcher(IProgressIndicator guiIndic)
 205   {
 206     this.progressIndicator = guiIndic;
 207     final SequenceFetcher us = this;
 208     // launch initialiser thread
 209     Thread sf = new Thread(new Runnable()
 210     {
 211
 212       @Override
 213       public void run()
 214       {
 215         if (getSequenceFetcherSingleton(progressIndicator) != null)
 216         {
 217           us.initGui(progressIndicator);
 218         }
 219         else
 220         {
 221           javax.swing.SwingUtilities.invokeLater(new Runnable()
 222           {
 223             @Override
 224             public void run()
 225             {
 226               JOptionPane
 227                       .showInternalMessageDialog(
 228                               Desktop.desktop,
 229                               MessageManager
 230                                       .getString("warn.couldnt_create_sequence_fetcher_client"),
 231                               MessageManager
 232                                       .getString("label.couldnt_create_sequence_fetcher"),
 233                               JOptionPane.ERROR_MESSAGE);
 234             }
 235           });
 236
 237           // raise warning dialog
 238         }
 239       }
 240     });
 241     sf.start();
 242   }
 243
 244   private class DatabaseAuthority extends DefaultMutableTreeNode
 245   {
 246
 247   };
 248
 249   private class DatabaseSource extends DefaultMutableTreeNode
 250   {
 251
 252   };
 253
 254   /**
 255    * called by thread spawned by constructor
 256    *
 257    * @param guiWindow
 258    */
 259   private void initGui(IProgressIndicator guiWindow)
 260   {
 261     this.guiWindow = guiWindow;
 262     if (guiWindow instanceof AlignFrame)
 263     {
 264       alignFrame = (AlignFrame) guiWindow;
 265     }
 266     database = new JDatabaseTree(sfetch);
 267     try
 268     {
 269       jbInit();
 270     } catch (Exception ex)
 271     {
 272       ex.printStackTrace();
 273     }
 274
 275     frame = new JInternalFrame();
 276     frame.setContentPane(this);
 277     if (new jalview.util.Platform().isAMac())
 278     {
 279       Desktop.addInternalFrame(frame, getFrameTitle(), 400, 240);
 280     }
 281     else
 282     {
 283       Desktop.addInternalFrame(frame, getFrameTitle(), 400, 180);
 284     }
 285   }
 286
 287   private String getFrameTitle()
 288   {
 289     return ((alignFrame == null) ? MessageManager
 290             .getString("label.new_sequence_fetcher") : MessageManager
 291             .getString("label.additional_sequence_fetcher"));
 292   }
 293
 294   private void jbInit() throws Exception
 295   {
 296     this.setLayout(borderLayout2);
 297
 298     database.setFont(JvSwingUtils.getLabelFont());
 299     dbeg.setFont(new java.awt.Font("Verdana", Font.BOLD, 11));
 300     jLabel1.setFont(new java.awt.Font("Verdana", Font.ITALIC, 11));
 301     jLabel1.setHorizontalAlignment(SwingConstants.CENTER);
 302     jLabel1.setText(MessageManager
 303             .getString("label.separate_multiple_accession_ids"));
 304
 305     replacePunctuation.setHorizontalAlignment(SwingConstants.CENTER);
 306     replacePunctuation
 307             .setFont(new java.awt.Font("Verdana", Font.ITALIC, 11));
 308     replacePunctuation.setText(MessageManager
 309             .getString("label.replace_commas_semicolons"));
 310     ok.setText(MessageManager.getString("action.ok"));
 311     ok.addActionListener(new ActionListener()
 312     {
 313       @Override
 314       public void actionPerformed(ActionEvent e)
 315       {
 316         ok_actionPerformed();
 317       }
 318     });
 319     clear.setText(MessageManager.getString("action.clear"));
 320     clear.addActionListener(new ActionListener()
 321     {
 322       @Override
 323       public void actionPerformed(ActionEvent e)
 324       {
 325         clear_actionPerformed();
 326       }
 327     });
 328
 329     example.setText(MessageManager.getString("label.example"));
 330     example.addActionListener(new ActionListener()
 331     {
 332       @Override
 333       public void actionPerformed(ActionEvent e)
 334       {
 335         example_actionPerformed();
 336       }
 337     });
 338     close.setText(MessageManager.getString("action.close"));
 339     close.addActionListener(new ActionListener()
 340     {
 341       @Override
 342       public void actionPerformed(ActionEvent e)
 343       {
 344         close_actionPerformed(e);
 345       }
 346     });
 347     textArea.setFont(JvSwingUtils.getLabelFont());
 348     textArea.setLineWrap(true);
 349     textArea.addKeyListener(new KeyAdapter()
 350     {
 351       @Override
 352       public void keyPressed(KeyEvent e)
 353       {
 354         if (e.getKeyCode() == KeyEvent.VK_ENTER)
 355         {
 356           ok_actionPerformed();
 357         }
 358       }
 359     });
 360     jPanel3.setLayout(borderLayout1);
 361     borderLayout1.setVgap(5);
 362     jPanel1.add(ok);
 363     jPanel1.add(example);
 364     jPanel1.add(clear);
 365     jPanel1.add(close);
 366     jPanel3.add(jPanel2, java.awt.BorderLayout.CENTER);
 367     jPanel2.setLayout(borderLayout3);
 368     databaseButt = database.getDatabaseSelectorButton();
 369     databaseButt.setFont(JvSwingUtils.getLabelFont());
 370     database.addActionListener(new ActionListener()
 371     {
 372       @Override
 373       public void actionPerformed(ActionEvent e)
 374       {
 375         debounceTrap++;
 376         String currentSelection = database.getSelectedItem();
 377
 378         if (currentSelection.equalsIgnoreCase("pdb")
 379                 && (database.action == KeyEvent.VK_ENTER || ((debounceTrap % 2) == 0)))
 380         {
 381           pdbSourceAction();
 382         }
 383         else if (currentSelection.equalsIgnoreCase("uniprot")
 384                 && (database.action == KeyEvent.VK_ENTER || ((debounceTrap % 2) == 0)))
 385         {
 386           uniprotSourceAction();
 387         }
 388         else
 389         {
 390           otherSourceAction();
 391         }
 392         database.action = -1;
 393       }
 394     });
 395
 396     dbeg.setText("");
 397     jPanel2.add(databaseButt, java.awt.BorderLayout.NORTH);
 398     jPanel2.add(dbeg, java.awt.BorderLayout.CENTER);
 399     JPanel jPanel2a = new JPanel(new BorderLayout());
 400     jPanel2a.add(jLabel1, java.awt.BorderLayout.NORTH);
 401     jPanel2a.add(replacePunctuation, java.awt.BorderLayout.SOUTH);
 402     jPanel2.add(jPanel2a, java.awt.BorderLayout.SOUTH);
 403     // jPanel2.setPreferredSize(new Dimension())
 404     jPanel3.add(jScrollPane1, java.awt.BorderLayout.CENTER);
 405     this.add(jPanel1, java.awt.BorderLayout.SOUTH);
 406     this.add(jPanel3, java.awt.BorderLayout.CENTER);
 407     this.add(jPanel2, java.awt.BorderLayout.NORTH);
 408     jScrollPane1.getViewport().add(textArea);
 409
 410   }
 411
 412   private void pdbSourceAction()
 413   {
 414     databaseButt.setText(database.getSelectedItem());
 415     new PDBFTSPanel(this);
 416     frame.dispose();
 417   }
 418
 419   private void uniprotSourceAction()
 420   {
 421     databaseButt.setText(database.getSelectedItem());
 422     new UniprotFTSPanel(this);
 423     frame.dispose();
 424   }
 425   private void otherSourceAction()
 426   {
 427     try
 428     {
 429       databaseButt.setText(database.getSelectedItem()
 430               + (database.getSelectedSources().size() > 1 ? " (and "
 431                       + database.getSelectedSources().size() + " others)"
 432                       : ""));
 433       String eq = database.getExampleQueries();
 434       dbeg.setText(MessageManager.formatMessage(
 435               "label.example_query_param", new String[] { eq }));
 436       boolean enablePunct = !(eq != null && eq.indexOf(",") > -1);
 437       for (DbSourceProxy dbs : database.getSelectedSources())
 438       {
 439         if (dbs instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)
 440         {
 441           enablePunct = false;
 442           break;
 443         }
 444       }
 445       replacePunctuation.setEnabled(enablePunct);
 446
 447     } catch (Exception ex)
 448     {
 449       dbeg.setText("");
 450       replacePunctuation.setEnabled(true);
 451     }
 452     jPanel2.repaint();
 453   }
 454
 455   protected void example_actionPerformed()
 456   {
 457     DbSourceProxy db = null;
 458     try
 459     {
 460       textArea.setText(database.getExampleQueries());
 461     } catch (Exception ex)
 462     {
 463     }
 464     jPanel3.repaint();
 465   }
 466
 467   protected void clear_actionPerformed()
 468   {
 469     textArea.setText("");
 470     jPanel3.repaint();
 471   }
 472
 473   public void close_actionPerformed(ActionEvent e)
 474   {
 475     try
 476     {
 477       frame.setClosed(true);
 478     } catch (Exception ex)
 479     {
 480     }
 481   }
 482
 483   public void ok_actionPerformed()
 484   {
 485     databaseButt.setEnabled(false);
 486     example.setEnabled(false);
 487     textArea.setEnabled(false);
 488     ok.setEnabled(false);
 489     close.setEnabled(false);
 490
 491     Thread worker = new Thread(this);
 492     worker.start();
 493   }
 494
 495   private void resetDialog()
 496   {
 497     databaseButt.setEnabled(true);
 498     example.setEnabled(true);
 499     textArea.setEnabled(true);
 500     ok.setEnabled(true);
 501     close.setEnabled(true);
 502   }
 503
 504   @Override
 505   public void run()
 506   {
 507     String error = "";
 508     if (!database.hasSelection())
 509     {
 510       error += "Please select the source database\n";
 511     }
 512     // TODO: make this transformation more configurable
 513     com.stevesoft.pat.Regex empty;
 514     if (replacePunctuation.isEnabled() && replacePunctuation.isSelected())
 515     {
 516       empty = new com.stevesoft.pat.Regex(
 517       // replace commas and spaces with a semicolon
 518               "(\\s|[,; ])+", ";");
 519     }
 520     else
 521     {
 522       // just turn spaces and semicolons into single semicolons
 523       empty = new com.stevesoft.pat.Regex("(\\s|[; ])+", ";");
 524     }
 525     textArea.setText(empty.replaceAll(textArea.getText()));
 526     // see if there's anthing to search with
 527     if (!new com.stevesoft.pat.Regex("[A-Za-z0-9_.]").search(textArea
 528             .getText()))
 529     {
 530       error += "Please enter a (semi-colon separated list of) database id(s)";
 531     }
 532     if (error.length() > 0)
 533     {
 534       showErrorMessage(error);
 535       resetDialog();
 536       return;
 537     }
 538     // TODO: Refactor to GUI independent code and write tests.
 539     // indicate if successive sources should be merged into one alignment.
 540     boolean addToLast = false;
 541     List<String> aresultq = new ArrayList<String>();
 542     List<String> presultTitle = new ArrayList<String>();
 543     List<AlignmentI> presult = new ArrayList<AlignmentI>();
 544     List<AlignmentI> aresult = new ArrayList<AlignmentI>();
 545     Iterator<DbSourceProxy> proxies = database.getSelectedSources()
 546             .iterator();
 547     String[] qries;
 548     List<String> nextFetch = Arrays.asList(qries = textArea.getText()
 549             .split(";"));
 550     Iterator<String> en = Arrays.asList(new String[0]).iterator();
 551     int nqueries = qries.length;
 552
 553     FeatureSettingsModelI preferredFeatureColours = null;
 554     while (proxies.hasNext() && (en.hasNext() || nextFetch.size() > 0))
 555     {
 556       if (!en.hasNext() && nextFetch.size() > 0)
 557       {
 558         en = nextFetch.iterator();
 559         nqueries = nextFetch.size();
 560         // save the remaining queries in the original array
 561         qries = nextFetch.toArray(new String[nqueries]);
 562         nextFetch = new ArrayList<String>();
 563       }
 564
 565       DbSourceProxy proxy = proxies.next();
 566       try
 567       {
 568         // update status
 569         guiWindow
 570                 .setProgressBar(MessageManager.formatMessage(
 571                         "status.fetching_sequence_queries_from",
 572                         new String[] {
 573                             Integer.valueOf(nqueries).toString(),
 574                             proxy.getDbName() }), Thread.currentThread()
 575                         .hashCode());
 576         if (proxy.getMaximumQueryCount() == 1)
 577         {
 578           /*
 579            * proxy only handles one accession id at a time
 580            */
 581           while (en.hasNext())
 582           {
 583             String acc = en.next();
 584             if (!fetchSingleAccession(proxy, acc, aresultq, aresult))
 585             {
 586               nextFetch.add(acc);
 587             }
 588           }
 589         }
 590         else
 591         {
 592           /*
 593            * proxy can fetch multiple accessions at one time
 594            */
 595           fetchMultipleAccessions(proxy, en, aresultq, aresult, nextFetch);
 596         }
 597       } catch (Exception e)
 598       {
 599         showErrorMessage("Error retrieving " + textArea.getText()
 600                 + " from " + database.getSelectedItem());
 601         // error
 602         // +="Couldn't retrieve sequences from "+database.getSelectedItem();
 603         System.err.println("Retrieval failed for source ='"
 604                 + database.getSelectedItem() + "' and query\n'"
 605                 + textArea.getText() + "'\n");
 606         e.printStackTrace();
 607       } catch (OutOfMemoryError e)
 608       {
 609         showErrorMessage("Out of Memory when retrieving "
 610                 + textArea.getText()
 611                 + " from "
 612                 + database.getSelectedItem()
 613                 + "\nPlease see the Jalview FAQ for instructions for increasing the memory available to Jalview.\n");
 614         e.printStackTrace();
 615       } catch (Error e)
 616       {
 617         showErrorMessage("Serious Error retrieving " + textArea.getText()
 618                 + " from " + database.getSelectedItem());
 619         e.printStackTrace();
 620       }
 621
 622       // Stack results ready for opening in alignment windows
 623       if (aresult != null && aresult.size() > 0)
 624       {
 625         FeatureSettingsModelI proxyColourScheme = proxy
 626                 .getFeatureColourScheme();
 627         if (proxyColourScheme != null)
 628         {
 629           preferredFeatureColours = proxyColourScheme;
 630         }
 631
 632         AlignmentI ar = null;
 633         if (proxy.isAlignmentSource())
 634         {
 635           addToLast = false;
 636           // new window for each result
 637           while (aresult.size() > 0)
 638           {
 639             presult.add(aresult.remove(0));
 640             presultTitle.add(aresultq.remove(0) + " "
 641                     + getDefaultRetrievalTitle());
 642           }
 643         }
 644         else
 645         {
 646           String titl = null;
 647           if (addToLast && presult.size() > 0)
 648           {
 649             ar = presult.remove(presult.size() - 1);
 650             titl = presultTitle.remove(presultTitle.size() - 1);
 651           }
 652           // concatenate all results in one window
 653           while (aresult.size() > 0)
 654           {
 655             if (ar == null)
 656             {
 657               ar = aresult.remove(0);
 658             }
 659             else
 660             {
 661               ar.append(aresult.remove(0));
 662             }
 663           }
 664           addToLast = true;
 665           presult.add(ar);
 666           presultTitle.add(titl);
 667         }
 668       }
 669       guiWindow.setProgressBar(MessageManager
 670               .getString("status.finshed_querying"), Thread.currentThread()
 671               .hashCode());
 672     }
 673     guiWindow.setProgressBar(
 674             (presult.size() > 0) ? MessageManager
 675                     .getString("status.parsing_results") : MessageManager
 676                     .getString("status.processing"), Thread.currentThread()
 677                     .hashCode());
 678     // process results
 679     while (presult.size() > 0)
 680     {
 681       parseResult(presult.remove(0), presultTitle.remove(0), null,
 682               preferredFeatureColours);
 683     }
 684     // only remove visual delay after we finished parsing.
 685     guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
 686     if (nextFetch.size() > 0)
 687     {
 688       StringBuffer sb = new StringBuffer();
 689       sb.append("Didn't retrieve the following "
 690               + (nextFetch.size() == 1 ? "query" : nextFetch.size()
 691                       + " queries") + ": \n");
 692       int l = sb.length(), lr = 0;
 693       for (String s : nextFetch)
 694       {
 695         if (l != sb.length())
 696         {
 697           sb.append("; ");
 698         }
 699         if (lr - sb.length() > 40)
 700         {
 701           sb.append("\n");
 702         }
 703         sb.append(s);
 704       }
 705       showErrorMessage(sb.toString());
 706     }
 707     resetDialog();
 708   }
 709
 710   /**
 711    * Tries to fetch one or more accession ids from the database proxy
 712    *
 713    * @param proxy
 714    * @param accessions
 715    *          the queries to fetch
 716    * @param aresultq
 717    *          a successful queries list to add to
 718    * @param aresult
 719    *          a list of retrieved alignments to add to
 720    * @param nextFetch
 721    *          failed queries are added to this list
 722    * @throws Exception
 723    */
 724   void fetchMultipleAccessions(DbSourceProxy proxy,
 725           Iterator<String> accessions, List<String> aresultq,
 726           List<AlignmentI> aresult, List<String> nextFetch)
 727           throws Exception
 728   {
 729     StringBuilder multiacc = new StringBuilder();
 730     List<String> tosend = new ArrayList<String>();
 731     while (accessions.hasNext())
 732     {
 733       String nel = accessions.next();
 734       tosend.add(nel);
 735       multiacc.append(nel);
 736       if (accessions.hasNext())
 737       {
 738         multiacc.append(proxy.getAccessionSeparator());
 739       }
 740     }
 741
 742     try
 743     {
 744       String query = multiacc.toString();
 745       AlignmentI rslt = proxy.getSequenceRecords(query);
 746       if (rslt == null || rslt.getHeight() == 0)
 747       {
 748         // no results - pass on all queries to next source
 749         nextFetch.addAll(tosend);
 750       }
 751       else
 752       {
 753         aresultq.add(query);
 754         aresult.add(rslt);
 755         if (tosend.size() > 1)
 756         {
 757           checkResultForQueries(rslt, tosend, nextFetch, proxy);
 758         }
 759       }
 760     } catch (OutOfMemoryError oome)
 761     {
 762       new OOMWarning("fetching " + multiacc + " from "
 763               + database.getSelectedItem(), oome, this);
 764     }
 765   }
 766
 767   /**
 768    * Query for a single accession id via the database proxy
 769    *
 770    * @param proxy
 771    * @param accession
 772    * @param aresultq
 773    *          a list of successful queries to add to
 774    * @param aresult
 775    *          a list of retrieved alignments to add to
 776    * @return true if the fetch was successful, else false
 777    */
 778   boolean fetchSingleAccession(DbSourceProxy proxy, String accession,
 779           List<String> aresultq, List<AlignmentI> aresult)
 780   {
 781     boolean success = false;
 782     try
 783     {
 784       if (aresult != null)
 785       {
 786         try
 787         {
 788           // give the server a chance to breathe
 789           Thread.sleep(5);
 790         } catch (Exception e)
 791         {
 792           //
 793         }
 794       }
 795
 796       AlignmentI indres = null;
 797       try
 798       {
 799         indres = proxy.getSequenceRecords(accession);
 800       } catch (OutOfMemoryError oome)
 801       {
 802         new OOMWarning("fetching " + accession + " from "
 803                 + proxy.getDbName(), oome, this);
 804       }
 805       if (indres != null)
 806       {
 807         aresultq.add(accession);
 808         aresult.add(indres);
 809         success = true;
 810       }
 811     } catch (Exception e)
 812     {
 813       Cache.log.info(
 814               "Error retrieving " + accession
 815               + " from " + proxy.getDbName(), e);
 816     } finally
 817     {
 818       return success;
 819     }
 820   }
 821
 822   /**
 823    * Checks which of the queries were successfully retrieved by searching the
 824    * DBRefs of the retrieved sequences for a match. Any not found are added to
 825    * the 'nextFetch' list.
 826    *
 827    * @param rslt
 828    * @param queries
 829    * @param nextFetch
 830    * @param proxy
 831    */
 832   void checkResultForQueries(AlignmentI rslt, List<String> queries,
 833           List<String> nextFetch, DbSourceProxy proxy)
 834   {
 835     SequenceI[] rs = rslt.getSequencesArray();
 836
 837     for (String q : queries)
 838     {
 839       DBRefEntry[] found = null;
 840       DBRefEntry dbr = new DBRefEntry();
 841       dbr.setSource(proxy.getDbSource());
 842       dbr.setVersion(null);
 843       String accId = proxy.getAccessionIdFromQuery(q);
 844       dbr.setAccessionId(accId);
 845       boolean rfound = false;
 846       for (int r = 0; r < rs.length; r++)
 847       {
 848         if (rs[r] != null)
 849         {
 850           found = DBRefUtils.searchRefs(rs[r].getDBRefs(), accId);
 851           if (found != null && found.length > 0)
 852           {
 853             rfound = true;
 854             break;
 855           }
 856         }
 857       }
 858       if (!rfound)
 859       {
 860         nextFetch.add(q);
 861       }
 862     }
 863   }
 864
 865   /**
 866    *
 867    * @return a standard title for any results retrieved using the currently
 868    *         selected source and settings
 869    */
 870   public String getDefaultRetrievalTitle()
 871   {
 872     return "Retrieved from " + database.getSelectedItem();
 873   }
 874
 875   AlignmentI parseResult(AlignmentI al, String title,
 876           String currentFileFormat,
 877           FeatureSettingsModelI preferredFeatureColours)
 878   {
 879
 880     if (al != null && al.getHeight() > 0)
 881     {
 882       if (title == null)
 883       {
 884         title = getDefaultRetrievalTitle();
 885       }
 886       if (alignFrame == null)
 887       {
 888         AlignFrame af = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 889                 AlignFrame.DEFAULT_HEIGHT);
 890         if (currentFileFormat != null)
 891         {
 892           af.currentFileFormat = currentFileFormat; // WHAT IS THE DEFAULT
 893           // FORMAT FOR
 894           // NON-FormatAdapter Sourced
 895           // Alignments?
 896         }
 897
 898         SequenceFeature[] sfs = null;
 899         List<SequenceI> alsqs;
 900         synchronized (alsqs = al.getSequences())
 901         {
 902           for (SequenceI sq : alsqs)
 903           {
 904             if ((sfs = sq.getSequenceFeatures()) != null)
 905             {
 906               if (sfs.length > 0)
 907               {
 908                 af.setShowSeqFeatures(true);
 909                 break;
 910               }
 911             }
 912
 913           }
 914         }
 915
 916         if (preferredFeatureColours != null)
 917         {
 918           af.getViewport().applyFeaturesStyle(preferredFeatureColours);
 919         }
 920         if (Cache.getDefault("HIDE_INTRONS", true))
 921         {
 922           af.hideFeatureColumns(SequenceOntologyI.EXON, false);
 923         }
 924
 925         Desktop.addInternalFrame(af, title, AlignFrame.DEFAULT_WIDTH,
 926                 AlignFrame.DEFAULT_HEIGHT);
 927
 928         af.statusBar.setText(MessageManager
 929                 .getString("label.successfully_pasted_alignment_file"));
 930
 931         try
 932         {
 933           af.setMaximum(Cache.getDefault("SHOW_FULLSCREEN",
 934                   false));
 935         } catch (Exception ex)
 936         {
 937         }
 938       }
 939       else
 940       {
 941         alignFrame.viewport.addAlignment(al, title);
 942       }
 943     }
 944     return al;
 945   }
 946
 947   void showErrorMessage(final String error)
 948   {
 949     resetDialog();
 950     javax.swing.SwingUtilities.invokeLater(new Runnable()
 951     {
 952       @Override
 953       public void run()
 954       {
 955         JOptionPane.showInternalMessageDialog(Desktop.desktop, error,
 956                 MessageManager.getString("label.error_retrieving_data"),
 957                 JOptionPane.WARNING_MESSAGE);
 958       }
 959     });
 960   }
 961
 962   public IProgressIndicator getProgressIndicator()
 963   {
 964     return progressIndicator;
 965   }
 966
 967   public void setProgressIndicator(IProgressIndicator progressIndicator)
 968   {
 969     this.progressIndicator = progressIndicator;
 970   }
 971 }