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      * open the database tree
 412      */
 413     database.waitForInput();
 414   }
 415
 416   private void pdbSourceAction()
 417   {
 418     databaseButt.setText(database.getSelectedItem());
 419     new PDBFTSPanel(this);
 420     frame.dispose();
 421   }
 422
 423   private void uniprotSourceAction()
 424   {
 425     databaseButt.setText(database.getSelectedItem());
 426     new UniprotFTSPanel(this);
 427     frame.dispose();
 428   }
 429   private void otherSourceAction()
 430   {
 431     try
 432     {
 433       databaseButt.setText(database.getSelectedItem()
 434               + (database.getSelectedSources().size() > 1 ? " (and "
 435                       + database.getSelectedSources().size() + " others)"
 436                       : ""));
 437       String eq = database.getExampleQueries();
 438       dbeg.setText(MessageManager.formatMessage(
 439               "label.example_query_param", new String[] { eq }));
 440       boolean enablePunct = !(eq != null && eq.indexOf(",") > -1);
 441       for (DbSourceProxy dbs : database.getSelectedSources())
 442       {
 443         if (dbs instanceof jalview.ws.dbsources.das.datamodel.DasSequenceSource)
 444         {
 445           enablePunct = false;
 446           break;
 447         }
 448       }
 449       replacePunctuation.setEnabled(enablePunct);
 450
 451     } catch (Exception ex)
 452     {
 453       dbeg.setText("");
 454       replacePunctuation.setEnabled(true);
 455     }
 456     jPanel2.repaint();
 457   }
 458
 459   protected void example_actionPerformed()
 460   {
 461     DbSourceProxy db = null;
 462     try
 463     {
 464       textArea.setText(database.getExampleQueries());
 465     } catch (Exception ex)
 466     {
 467     }
 468     jPanel3.repaint();
 469   }
 470
 471   protected void clear_actionPerformed()
 472   {
 473     textArea.setText("");
 474     jPanel3.repaint();
 475   }
 476
 477   public void close_actionPerformed(ActionEvent e)
 478   {
 479     try
 480     {
 481       frame.setClosed(true);
 482     } catch (Exception ex)
 483     {
 484     }
 485   }
 486
 487   public void ok_actionPerformed()
 488   {
 489     databaseButt.setEnabled(false);
 490     example.setEnabled(false);
 491     textArea.setEnabled(false);
 492     ok.setEnabled(false);
 493     close.setEnabled(false);
 494
 495     Thread worker = new Thread(this);
 496     worker.start();
 497   }
 498
 499   private void resetDialog()
 500   {
 501     databaseButt.setEnabled(true);
 502     example.setEnabled(true);
 503     textArea.setEnabled(true);
 504     ok.setEnabled(true);
 505     close.setEnabled(true);
 506   }
 507
 508   @Override
 509   public void run()
 510   {
 511     String error = "";
 512     if (!database.hasSelection())
 513     {
 514       error += "Please select the source database\n";
 515     }
 516     // TODO: make this transformation more configurable
 517     com.stevesoft.pat.Regex empty;
 518     if (replacePunctuation.isEnabled() && replacePunctuation.isSelected())
 519     {
 520       empty = new com.stevesoft.pat.Regex(
 521       // replace commas and spaces with a semicolon
 522               "(\\s|[,; ])+", ";");
 523     }
 524     else
 525     {
 526       // just turn spaces and semicolons into single semicolons
 527       empty = new com.stevesoft.pat.Regex("(\\s|[; ])+", ";");
 528     }
 529     textArea.setText(empty.replaceAll(textArea.getText()));
 530     // see if there's anthing to search with
 531     if (!new com.stevesoft.pat.Regex("[A-Za-z0-9_.]").search(textArea
 532             .getText()))
 533     {
 534       error += "Please enter a (semi-colon separated list of) database id(s)";
 535     }
 536     if (error.length() > 0)
 537     {
 538       showErrorMessage(error);
 539       resetDialog();
 540       return;
 541     }
 542     // TODO: Refactor to GUI independent code and write tests.
 543     // indicate if successive sources should be merged into one alignment.
 544     boolean addToLast = false;
 545     List<String> aresultq = new ArrayList<String>();
 546     List<String> presultTitle = new ArrayList<String>();
 547     List<AlignmentI> presult = new ArrayList<AlignmentI>();
 548     List<AlignmentI> aresult = new ArrayList<AlignmentI>();
 549     Iterator<DbSourceProxy> proxies = database.getSelectedSources()
 550             .iterator();
 551     String[] qries;
 552     List<String> nextFetch = Arrays.asList(qries = textArea.getText()
 553             .split(";"));
 554     Iterator<String> en = Arrays.asList(new String[0]).iterator();
 555     int nqueries = qries.length;
 556
 557     FeatureSettingsModelI preferredFeatureColours = null;
 558     while (proxies.hasNext() && (en.hasNext() || nextFetch.size() > 0))
 559     {
 560       if (!en.hasNext() && nextFetch.size() > 0)
 561       {
 562         en = nextFetch.iterator();
 563         nqueries = nextFetch.size();
 564         // save the remaining queries in the original array
 565         qries = nextFetch.toArray(new String[nqueries]);
 566         nextFetch = new ArrayList<String>();
 567       }
 568
 569       DbSourceProxy proxy = proxies.next();
 570       try
 571       {
 572         // update status
 573         guiWindow
 574                 .setProgressBar(MessageManager.formatMessage(
 575                         "status.fetching_sequence_queries_from",
 576                         new String[] {
 577                             Integer.valueOf(nqueries).toString(),
 578                             proxy.getDbName() }), Thread.currentThread()
 579                         .hashCode());
 580         if (proxy.getMaximumQueryCount() == 1)
 581         {
 582           /*
 583            * proxy only handles one accession id at a time
 584            */
 585           while (en.hasNext())
 586           {
 587             String acc = en.next();
 588             if (!fetchSingleAccession(proxy, acc, aresultq, aresult))
 589             {
 590               nextFetch.add(acc);
 591             }
 592           }
 593         }
 594         else
 595         {
 596           /*
 597            * proxy can fetch multiple accessions at one time
 598            */
 599           fetchMultipleAccessions(proxy, en, aresultq, aresult, nextFetch);
 600         }
 601       } catch (Exception e)
 602       {
 603         showErrorMessage("Error retrieving " + textArea.getText()
 604                 + " from " + database.getSelectedItem());
 605         // error
 606         // +="Couldn't retrieve sequences from "+database.getSelectedItem();
 607         System.err.println("Retrieval failed for source ='"
 608                 + database.getSelectedItem() + "' and query\n'"
 609                 + textArea.getText() + "'\n");
 610         e.printStackTrace();
 611       } catch (OutOfMemoryError e)
 612       {
 613         showErrorMessage("Out of Memory when retrieving "
 614                 + textArea.getText()
 615                 + " from "
 616                 + database.getSelectedItem()
 617                 + "\nPlease see the Jalview FAQ for instructions for increasing the memory available to Jalview.\n");
 618         e.printStackTrace();
 619       } catch (Error e)
 620       {
 621         showErrorMessage("Serious Error retrieving " + textArea.getText()
 622                 + " from " + database.getSelectedItem());
 623         e.printStackTrace();
 624       }
 625
 626       // Stack results ready for opening in alignment windows
 627       if (aresult != null && aresult.size() > 0)
 628       {
 629         FeatureSettingsModelI proxyColourScheme = proxy
 630                 .getFeatureColourScheme();
 631         if (proxyColourScheme != null)
 632         {
 633           preferredFeatureColours = proxyColourScheme;
 634         }
 635
 636         AlignmentI ar = null;
 637         if (proxy.isAlignmentSource())
 638         {
 639           addToLast = false;
 640           // new window for each result
 641           while (aresult.size() > 0)
 642           {
 643             presult.add(aresult.remove(0));
 644             presultTitle.add(aresultq.remove(0) + " "
 645                     + getDefaultRetrievalTitle());
 646           }
 647         }
 648         else
 649         {
 650           String titl = null;
 651           if (addToLast && presult.size() > 0)
 652           {
 653             ar = presult.remove(presult.size() - 1);
 654             titl = presultTitle.remove(presultTitle.size() - 1);
 655           }
 656           // concatenate all results in one window
 657           while (aresult.size() > 0)
 658           {
 659             if (ar == null)
 660             {
 661               ar = aresult.remove(0);
 662             }
 663             else
 664             {
 665               ar.append(aresult.remove(0));
 666             }
 667           }
 668           addToLast = true;
 669           presult.add(ar);
 670           presultTitle.add(titl);
 671         }
 672       }
 673       guiWindow.setProgressBar(MessageManager
 674               .getString("status.finshed_querying"), Thread.currentThread()
 675               .hashCode());
 676     }
 677     guiWindow.setProgressBar(
 678             (presult.size() > 0) ? MessageManager
 679                     .getString("status.parsing_results") : MessageManager
 680                     .getString("status.processing"), Thread.currentThread()
 681                     .hashCode());
 682     // process results
 683     while (presult.size() > 0)
 684     {
 685       parseResult(presult.remove(0), presultTitle.remove(0), null,
 686               preferredFeatureColours);
 687     }
 688     // only remove visual delay after we finished parsing.
 689     guiWindow.setProgressBar(null, Thread.currentThread().hashCode());
 690     if (nextFetch.size() > 0)
 691     {
 692       StringBuffer sb = new StringBuffer();
 693       sb.append("Didn't retrieve the following "
 694               + (nextFetch.size() == 1 ? "query" : nextFetch.size()
 695                       + " queries") + ": \n");
 696       int l = sb.length(), lr = 0;
 697       for (String s : nextFetch)
 698       {
 699         if (l != sb.length())
 700         {
 701           sb.append("; ");
 702         }
 703         if (lr - sb.length() > 40)
 704         {
 705           sb.append("\n");
 706         }
 707         sb.append(s);
 708       }
 709       showErrorMessage(sb.toString());
 710     }
 711     resetDialog();
 712   }
 713
 714   /**
 715    * Tries to fetch one or more accession ids from the database proxy
 716    *
 717    * @param proxy
 718    * @param accessions
 719    *          the queries to fetch
 720    * @param aresultq
 721    *          a successful queries list to add to
 722    * @param aresult
 723    *          a list of retrieved alignments to add to
 724    * @param nextFetch
 725    *          failed queries are added to this list
 726    * @throws Exception
 727    */
 728   void fetchMultipleAccessions(DbSourceProxy proxy,
 729           Iterator<String> accessions, List<String> aresultq,
 730           List<AlignmentI> aresult, List<String> nextFetch)
 731           throws Exception
 732   {
 733     StringBuilder multiacc = new StringBuilder();
 734     List<String> tosend = new ArrayList<String>();
 735     while (accessions.hasNext())
 736     {
 737       String nel = accessions.next();
 738       tosend.add(nel);
 739       multiacc.append(nel);
 740       if (accessions.hasNext())
 741       {
 742         multiacc.append(proxy.getAccessionSeparator());
 743       }
 744     }
 745
 746     try
 747     {
 748       String query = multiacc.toString();
 749       AlignmentI rslt = proxy.getSequenceRecords(query);
 750       if (rslt == null || rslt.getHeight() == 0)
 751       {
 752         // no results - pass on all queries to next source
 753         nextFetch.addAll(tosend);
 754       }
 755       else
 756       {
 757         aresultq.add(query);
 758         aresult.add(rslt);
 759         if (tosend.size() > 1)
 760         {
 761           checkResultForQueries(rslt, tosend, nextFetch, proxy);
 762         }
 763       }
 764     } catch (OutOfMemoryError oome)
 765     {
 766       new OOMWarning("fetching " + multiacc + " from "
 767               + database.getSelectedItem(), oome, this);
 768     }
 769   }
 770
 771   /**
 772    * Query for a single accession id via the database proxy
 773    *
 774    * @param proxy
 775    * @param accession
 776    * @param aresultq
 777    *          a list of successful queries to add to
 778    * @param aresult
 779    *          a list of retrieved alignments to add to
 780    * @return true if the fetch was successful, else false
 781    */
 782   boolean fetchSingleAccession(DbSourceProxy proxy, String accession,
 783           List<String> aresultq, List<AlignmentI> aresult)
 784   {
 785     boolean success = false;
 786     try
 787     {
 788       if (aresult != null)
 789       {
 790         try
 791         {
 792           // give the server a chance to breathe
 793           Thread.sleep(5);
 794         } catch (Exception e)
 795         {
 796           //
 797         }
 798       }
 799
 800       AlignmentI indres = null;
 801       try
 802       {
 803         indres = proxy.getSequenceRecords(accession);
 804       } catch (OutOfMemoryError oome)
 805       {
 806         new OOMWarning("fetching " + accession + " from "
 807                 + proxy.getDbName(), oome, this);
 808       }
 809       if (indres != null)
 810       {
 811         aresultq.add(accession);
 812         aresult.add(indres);
 813         success = true;
 814       }
 815     } catch (Exception e)
 816     {
 817       Cache.log.info(
 818               "Error retrieving " + accession
 819               + " from " + proxy.getDbName(), e);
 820     }
 821     return success;
 822   }
 823
 824   /**
 825    * Checks which of the queries were successfully retrieved by searching the
 826    * DBRefs of the retrieved sequences for a match. Any not found are added to
 827    * the 'nextFetch' list.
 828    *
 829    * @param rslt
 830    * @param queries
 831    * @param nextFetch
 832    * @param proxy
 833    */
 834   void checkResultForQueries(AlignmentI rslt, List<String> queries,
 835           List<String> nextFetch, DbSourceProxy proxy)
 836   {
 837     SequenceI[] rs = rslt.getSequencesArray();
 838
 839     for (String q : queries)
 840     {
 841       DBRefEntry dbr = new DBRefEntry();
 842       dbr.setSource(proxy.getDbSource());
 843       dbr.setVersion(null);
 844       String accId = proxy.getAccessionIdFromQuery(q);
 845       dbr.setAccessionId(accId);
 846       boolean rfound = false;
 847       for (int r = 0; r < rs.length; r++)
 848       {
 849         if (rs[r] != null)
 850         {
 851           List<DBRefEntry> found = DBRefUtils.searchRefs(rs[r].getDBRefs(),
 852                   accId);
 853           if (!found.isEmpty())
 854           {
 855             rfound = true;
 856             break;
 857           }
 858         }
 859       }
 860       if (!rfound)
 861       {
 862         nextFetch.add(q);
 863       }
 864     }
 865   }
 866
 867   /**
 868    *
 869    * @return a standard title for any results retrieved using the currently
 870    *         selected source and settings
 871    */
 872   public String getDefaultRetrievalTitle()
 873   {
 874     return "Retrieved from " + database.getSelectedItem();
 875   }
 876
 877   AlignmentI parseResult(AlignmentI al, String title,
 878           String currentFileFormat,
 879           FeatureSettingsModelI preferredFeatureColours)
 880   {
 881
 882     if (al != null && al.getHeight() > 0)
 883     {
 884       if (title == null)
 885       {
 886         title = getDefaultRetrievalTitle();
 887       }
 888       if (alignFrame == null)
 889       {
 890         AlignFrame af = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
 891                 AlignFrame.DEFAULT_HEIGHT);
 892         if (currentFileFormat != null)
 893         {
 894           af.currentFileFormat = currentFileFormat; // WHAT IS THE DEFAULT
 895           // FORMAT FOR
 896           // NON-FormatAdapter Sourced
 897           // Alignments?
 898         }
 899
 900         SequenceFeature[] sfs = null;
 901         List<SequenceI> alsqs;
 902         synchronized (alsqs = al.getSequences())
 903         {
 904           for (SequenceI sq : alsqs)
 905           {
 906             if ((sfs = sq.getSequenceFeatures()) != null)
 907             {
 908               if (sfs.length > 0)
 909               {
 910                 af.setShowSeqFeatures(true);
 911                 break;
 912               }
 913             }
 914
 915           }
 916         }
 917
 918         if (preferredFeatureColours != null)
 919         {
 920           af.getViewport().applyFeaturesStyle(preferredFeatureColours);
 921         }
 922         if (Cache.getDefault("HIDE_INTRONS", true))
 923         {
 924           af.hideFeatureColumns(SequenceOntologyI.EXON, false);
 925         }
 926
 927         Desktop.addInternalFrame(af, title, AlignFrame.DEFAULT_WIDTH,
 928                 AlignFrame.DEFAULT_HEIGHT);
 929
 930         af.statusBar.setText(MessageManager
 931                 .getString("label.successfully_pasted_alignment_file"));
 932
 933         try
 934         {
 935           af.setMaximum(Cache.getDefault("SHOW_FULLSCREEN",
 936                   false));
 937         } catch (Exception ex)
 938         {
 939         }
 940       }
 941       else
 942       {
 943         alignFrame.viewport.addAlignment(al, title);
 944       }
 945     }
 946     return al;
 947   }
 948
 949   void showErrorMessage(final String error)
 950   {
 951     resetDialog();
 952     javax.swing.SwingUtilities.invokeLater(new Runnable()
 953     {
 954       @Override
 955       public void run()
 956       {
 957         JOptionPane.showInternalMessageDialog(Desktop.desktop, error,
 958                 MessageManager.getString("label.error_retrieving_data"),
 959                 JOptionPane.WARNING_MESSAGE);
 960       }
 961     });
 962   }
 963
 964   public IProgressIndicator getProgressIndicator()
 965   {
 966     return progressIndicator;
 967   }
 968
 969   public void setProgressIndicator(IProgressIndicator progressIndicator)
 970   {
 971     this.progressIndicator = progressIndicator;
 972   }
 973 }