2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
23 import jalview.api.ComplexAlignFile;
24 import jalview.api.FeatureSettingsModelI;
25 import jalview.api.FeaturesDisplayedI;
26 import jalview.api.FeaturesSourceI;
27 import jalview.bin.Cache;
28 import jalview.bin.Jalview;
29 import jalview.datamodel.AlignmentI;
30 import jalview.datamodel.HiddenColumns;
31 import jalview.datamodel.PDBEntry;
32 import jalview.datamodel.SequenceI;
33 import jalview.gui.AlignFrame;
34 import jalview.gui.AlignViewport;
35 import jalview.gui.Desktop;
36 import jalview.gui.Jalview2XML;
37 import jalview.gui.JvOptionPane;
38 import jalview.json.binding.biojson.v1.ColourSchemeMapper;
39 import jalview.schemes.ColourSchemeI;
40 import jalview.structure.StructureSelectionManager;
41 import jalview.util.MessageManager;
42 import jalview.ws.utils.UrlDownloadClient;
45 import java.io.IOException;
46 import java.util.StringTokenizer;
47 import java.util.Vector;
49 import javax.swing.SwingUtilities;
51 public class FileLoader implements Runnable
55 DataSourceType protocol;
59 AlignmentFileReaderI source = null; // alternative specification of where data
64 AlignViewport viewport;
66 AlignFrame alignFrame;
72 boolean raiseGUI = true;
75 * default constructor always raised errors in GUI dialog boxes
83 * construct a Fileloader that may raise errors non-interactively
86 * true if errors are to be raised as GUI dialog boxes
88 public FileLoader(boolean raiseGUI)
90 this.raiseGUI = raiseGUI;
93 public void LoadFile(AlignViewport viewport, String file,
94 DataSourceType protocol, FileFormatI format)
96 this.viewport = viewport;
97 LoadFile(file, protocol, format);
100 public void LoadFile(String file, DataSourceType protocol,
104 this.protocol = protocol;
105 this.format = format;
107 final Thread loader = new Thread(this);
109 SwingUtilities.invokeLater(new Runnable()
120 * Load a (file, protocol) source of unknown type
125 public void LoadFile(String file, DataSourceType protocol)
127 LoadFile(file, protocol, null);
131 * Load alignment from (file, protocol) and wait till loaded
135 * @return alignFrame constructed from file contents
137 public AlignFrame LoadFileWaitTillLoaded(String file,
138 DataSourceType sourceType)
140 return LoadFileWaitTillLoaded(file, sourceType, null);
144 * Load alignment from (file, protocol) of type format and wait till loaded
149 * @return alignFrame constructed from file contents
151 public AlignFrame LoadFileWaitTillLoaded(String file,
152 DataSourceType sourceType, FileFormatI format)
155 this.protocol = sourceType;
156 this.format = format;
157 return _LoadFileWaitTillLoaded();
161 * Load alignment from FileParse source of type format and wait till loaded
165 * @return alignFrame constructed from file contents
167 public AlignFrame LoadFileWaitTillLoaded(AlignmentFileReaderI source,
170 this.source = source;
172 file = source.getInFile();
173 protocol = source.getDataSourceType();
174 this.format = format;
175 return _LoadFileWaitTillLoaded();
179 * start thread and wait until finished, then return the alignFrame that's
180 * (hopefully) been read.
184 protected AlignFrame _LoadFileWaitTillLoaded()
186 Thread loader = new Thread(this);
189 while (loader.isAlive())
194 } catch (Exception ex)
202 public void updateRecentlyOpened()
204 Vector recent = new Vector();
205 if (protocol == DataSourceType.PASTE)
207 // do nothing if the file was pasted in as text... there is no filename to
212 && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
214 // ignore files loaded from the system's temporary directory
217 String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
220 String historyItems = jalview.bin.Cache.getProperty(type);
224 if (historyItems != null)
226 st = new StringTokenizer(historyItems, "\t");
228 while (st.hasMoreTokens())
230 recent.addElement(st.nextElement().toString().trim());
234 if (recent.contains(file))
239 StringBuffer newHistory = new StringBuffer(file);
240 for (int i = 0; i < recent.size() && i < 10; i++)
242 newHistory.append("\t");
243 newHistory.append(recent.elementAt(i));
246 Cache.setProperty(type, newHistory.toString());
248 if (protocol == DataSourceType.FILE)
250 Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
257 String title = protocol == DataSourceType.PASTE ? "Copied From Clipboard"
259 Runtime rt = Runtime.getRuntime();
262 if (Desktop.instance != null)
264 Desktop.instance.startLoading(file);
268 // just in case the caller didn't identify the file for us
271 format = new IdentifyFile().identify(source, false);
272 // identify stream and rewind rather than close
276 format = new IdentifyFile().identify(file, protocol);
283 Desktop.instance.stopLoading();
284 System.err.println("The input file \"" + file
285 + "\" has null or unidentifiable data content!");
286 if (!Jalview.isHeadlessMode())
288 JvOptionPane.showInternalMessageDialog(
290 MessageManager.getString("label.couldnt_read_data")
291 + " in " + file + "\n"
292 + AppletFormatAdapter.getSupportedFormats(),
293 MessageManager.getString("label.couldnt_read_data"),
294 JvOptionPane.WARNING_MESSAGE);
298 // TODO: cache any stream datasources as a temporary file (eg. PDBs
299 // retrieved via URL)
300 if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
303 memused = (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // free
308 loadtime = -System.currentTimeMillis();
309 AlignmentI al = null;
311 if (FileFormat.Jalview.equals(format))
315 // Tell the user (developer?) that this is going to cause a problem
317 .println("IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
318 // We read the data anyway - it might make sense.
320 alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(file);
324 String error = AppletFormatAdapter.getSupportedFormats();
329 // read from the provided source
330 al = new FormatAdapter().readFromFile(source, format);
335 // open a new source and read from it
336 FormatAdapter fa = new FormatAdapter();
337 boolean downloadStructureFile = format.isStructureFile()
338 && protocol.equals(DataSourceType.URL);
339 if (downloadStructureFile)
341 String structExt = format.getExtensions().split(",")[0];
342 String urlLeafName = file.substring(file.lastIndexOf(System
343 .getProperty("file.separator")), file
345 String tempStructureFileStr = createNamedJvTempFile(
346 urlLeafName, structExt);
347 UrlDownloadClient.download(file, tempStructureFileStr);
348 al = fa.readFile(tempStructureFileStr, DataSourceType.FILE,
350 source = fa.getAlignFile();
354 al = fa.readFile(file, protocol, format);
355 source = fa.getAlignFile(); // keep reference for later if
359 } catch (java.io.IOException ex)
361 error = ex.getMessage();
364 if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
366 // construct and register dataset sequences
367 for (SequenceI sq : al.getSequences())
369 while (sq.getDatasetSequence() != null)
371 sq = sq.getDatasetSequence();
373 if (sq.getAllPDBEntries() != null)
375 for (PDBEntry pdbe : sq.getAllPDBEntries())
377 // register PDB entries with desktop's structure selection
379 StructureSelectionManager.getStructureSelectionManager(
380 Desktop.instance).registerPDBEntry(pdbe);
385 FeatureSettingsModelI proxyColourScheme = source
386 .getFeatureColourScheme();
387 if (viewport != null)
389 if (proxyColourScheme != null)
391 viewport.applyFeaturesStyle(proxyColourScheme);
393 // append to existing alignment
394 viewport.addAlignment(al, title);
398 // otherwise construct the alignFrame
400 if (source instanceof ComplexAlignFile)
402 HiddenColumns colSel = ((ComplexAlignFile) source)
404 SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
405 .getHiddenSequences();
406 String colourSchemeName = ((ComplexAlignFile) source)
407 .getGlobalColourScheme();
408 FeaturesDisplayedI fd = ((ComplexAlignFile) source)
409 .getDisplayedFeatures();
410 alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
411 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
412 alignFrame.getViewport().setFeaturesDisplayed(fd);
413 alignFrame.getViewport().setShowSequenceFeatures(
414 ((ComplexAlignFile) source).isShowSeqFeatures());
415 ColourSchemeI cs = ColourSchemeMapper.getJalviewColourScheme(
416 colourSchemeName, al);
419 alignFrame.changeColour(cs);
424 alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
425 AlignFrame.DEFAULT_HEIGHT);
426 if (source instanceof FeaturesSourceI)
428 alignFrame.getViewport().setShowSequenceFeatures(true);
431 // add metadata and update ui
432 if (!(protocol == DataSourceType.PASTE))
434 alignFrame.setFileName(file, format);
436 if (proxyColourScheme != null)
438 alignFrame.getViewport()
439 .applyFeaturesStyle(proxyColourScheme);
441 alignFrame.statusBar.setText(MessageManager.formatMessage(
442 "label.successfully_loaded_file",
443 new String[] { title }));
447 // add the window to the GUI
448 // note - this actually should happen regardless of raiseGUI
449 // status in Jalview 3
450 // TODO: define 'virtual desktop' for benefit of headless scripts
451 // that perform queries to find the 'current working alignment'
452 Desktop.addInternalFrame(alignFrame, title,
453 AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
458 alignFrame.setMaximum(jalview.bin.Cache.getDefault(
459 "SHOW_FULLSCREEN", false));
460 } catch (java.beans.PropertyVetoException ex)
467 if (Desktop.instance != null)
469 Desktop.instance.stopLoading();
472 final String errorMessage = MessageManager
473 .getString("label.couldnt_load_file")
477 // TODO: refactor FileLoader to be independent of Desktop / Applet GUI
479 if (raiseGUI && Desktop.desktop != null)
481 javax.swing.SwingUtilities.invokeLater(new Runnable()
486 JvOptionPane.showInternalMessageDialog(Desktop.desktop,
487 errorMessage, MessageManager
488 .getString("label.error_loading_file"),
489 JvOptionPane.WARNING_MESSAGE);
495 System.err.println(errorMessage);
500 updateRecentlyOpened();
502 } catch (Exception er)
504 System.err.println("Exception whilst opening file '" + file);
505 er.printStackTrace();
508 javax.swing.SwingUtilities.invokeLater(new Runnable()
513 JvOptionPane.showInternalMessageDialog(
514 Desktop.desktop, MessageManager.formatMessage(
515 "label.problems_opening_file",
516 new String[] { file }), MessageManager
517 .getString("label.file_open_error"),
518 JvOptionPane.WARNING_MESSAGE);
523 } catch (OutOfMemoryError er)
526 er.printStackTrace();
530 javax.swing.SwingUtilities.invokeLater(new Runnable()
535 JvOptionPane.showInternalMessageDialog(
536 Desktop.desktop, MessageManager.formatMessage(
537 "warn.out_of_memory_loading_file", new String[]
538 { file }), MessageManager
539 .getString("label.out_of_memory"),
540 JvOptionPane.WARNING_MESSAGE);
544 System.err.println("Out of memory loading file " + file + "!!");
547 loadtime += System.currentTimeMillis();
548 // TODO: Estimate percentage of memory used by a newly loaded alignment -
549 // warn if more memory will be needed to work with it
552 - (rt.maxMemory() - rt.totalMemory() + rt.freeMemory()); // difference
557 if (Desktop.desktop != null && Desktop.desktop.isShowMemoryUsage())
559 if (alignFrame != null)
561 AlignmentI al = alignFrame.getViewport().getAlignment();
563 System.out.println("Loaded '" + title + "' in "
564 + (loadtime / 1000.0) + "s, took an additional "
565 + (1.0 * memused / (1024.0 * 1024.0)) + " MB ("
566 + al.getHeight() + " seqs by " + al.getWidth() + " cols)");
570 // report that we didn't load anything probably due to an out of memory
572 System.out.println("Failed to load '" + title + "' in "
573 + (loadtime / 1000.0) + "s, took an additional "
574 + (1.0 * memused / (1024.0 * 1024.0))
575 + " MB (alignment is null)");
578 // remove the visual delay indicator
579 if (Desktop.instance != null)
581 Desktop.instance.stopLoading();
587 * This method creates the file -
588 * {tmpdir}/jalview/{current_timestamp}/fileName.exetnsion using the supplied
589 * file name and extension
592 * the name of the temp file to be created
594 * the extension of the temp file to be created
597 private static String createNamedJvTempFile(String fileName,
598 String extension) throws IOException
600 String seprator = System.getProperty("file.separator");
601 String jvTempDir = System.getProperty("java.io.tmpdir") + "jalview"
602 + seprator + System.currentTimeMillis();
603 File tempStructFile = new File(jvTempDir + seprator + fileName + "."
605 tempStructFile.mkdirs();
606 return tempStructFile.toString();
612 * @see java.lang.Object#finalize()
615 protected void finalize() throws Throwable