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