/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b1)
- * Copyright (C) 2015 The Jalview Authors
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
*/
package jalview.io;
+import java.io.File;
+import java.io.IOException;
+import java.util.StringTokenizer;
+import java.util.Vector;
+
+import javax.swing.SwingUtilities;
+
import jalview.api.ComplexAlignFile;
+import jalview.api.FeatureSettingsModelI;
import jalview.api.FeaturesDisplayedI;
+import jalview.api.FeaturesSourceI;
+import jalview.bin.Cache;
import jalview.bin.Jalview;
import jalview.datamodel.AlignmentI;
-import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
import jalview.datamodel.PDBEntry;
import jalview.datamodel.SequenceI;
import jalview.gui.AlignFrame;
import jalview.gui.AlignViewport;
import jalview.gui.Desktop;
-import jalview.gui.Jalview2XML;
+import jalview.gui.JvOptionPane;
+import jalview.gui.QuitHandler;
import jalview.json.binding.biojson.v1.ColourSchemeMapper;
+import jalview.project.Jalview2XML;
import jalview.schemes.ColourSchemeI;
import jalview.structure.StructureSelectionManager;
import jalview.util.MessageManager;
-
-import java.util.StringTokenizer;
-import java.util.Vector;
-
-import javax.swing.JOptionPane;
-import javax.swing.SwingUtilities;
+import jalview.ws.utils.UrlDownloadClient;
public class FileLoader implements Runnable
{
String file;
- String protocol;
+ DataSourceType protocol;
- String format;
+ FileFormatI format;
- FileParse source = null; // alternative specification of where data comes
+ AlignmentFileReaderI source = null; // alternative specification of where data
+ // comes
// from
boolean raiseGUI = true;
+ private File selectedFile;
+
+ private static boolean useDefaultFileFormat = false;
+
/**
* default constructor always raised errors in GUI dialog boxes
*/
this.raiseGUI = raiseGUI;
}
- public void LoadFile(AlignViewport viewport, String file,
- String protocol, String format)
+ public void LoadFile(AlignViewport viewport, Object file,
+ DataSourceType protocol, FileFormatI format)
+ {
+ LoadFile(viewport, file, protocol, format, true);
+ }
+
+ public void LoadFile(AlignViewport viewport, Object file,
+ DataSourceType protocol, FileFormatI format, boolean async)
{
this.viewport = viewport;
- LoadFile(file, protocol, format);
+ if (file instanceof File)
+ {
+ this.selectedFile = (File) file;
+ file = selectedFile.getPath();
+ }
+ LoadFile(file.toString(), protocol, format, async);
+ }
+
+ public void LoadFile(String file, DataSourceType protocol,
+ FileFormatI format)
+ {
+ LoadFile(file, protocol, format, true);
}
- public void LoadFile(String file, String protocol, String format)
+ public void LoadFile(String file, DataSourceType protocol,
+ FileFormatI format, boolean async)
{
this.file = file;
this.protocol = protocol;
this.format = format;
- final Thread loader = new Thread(this);
-
- SwingUtilities.invokeLater(new Runnable()
+ if (async)
{
- public void run()
+ final Thread loader = new Thread(this);
+
+ SwingUtilities.invokeLater(new Runnable()
{
- loader.start();
- }
- });
+ @Override
+ public void run()
+ {
+ loader.start();
+ }
+ });
+ }
+ else
+ {
+ this.run();
+ }
}
/**
* @param file
* @param protocol
*/
- public void LoadFile(String file, String protocol)
+ public void LoadFile(String file, DataSourceType protocol)
{
LoadFile(file, protocol, null);
}
* Load alignment from (file, protocol) and wait till loaded
*
* @param file
- * @param protocol
+ * @param sourceType
* @return alignFrame constructed from file contents
*/
- public AlignFrame LoadFileWaitTillLoaded(String file, String protocol)
+ public AlignFrame LoadFileWaitTillLoaded(String file,
+ DataSourceType sourceType)
{
- return LoadFileWaitTillLoaded(file, protocol, null);
+ return LoadFileWaitTillLoaded(file, sourceType, null);
}
/**
* Load alignment from (file, protocol) of type format and wait till loaded
*
* @param file
- * @param protocol
+ * @param sourceType
* @param format
* @return alignFrame constructed from file contents
*/
- public AlignFrame LoadFileWaitTillLoaded(String file, String protocol,
- String format)
+ public AlignFrame LoadFileWaitTillLoaded(String file,
+ DataSourceType sourceType, FileFormatI format)
{
this.file = file;
- this.protocol = protocol;
+ this.protocol = sourceType;
+ this.format = format;
+ return _LoadFileWaitTillLoaded();
+ }
+
+ /**
+ * Load alignment from (file, protocol) of type format and wait till loaded
+ *
+ * @param file
+ * @param sourceType
+ * @param format
+ * @return alignFrame constructed from file contents
+ */
+ public AlignFrame LoadFileWaitTillLoaded(File file,
+ DataSourceType sourceType, FileFormatI format)
+ {
+ this.selectedFile = file;
+ this.file = file.getPath();
+ this.protocol = sourceType;
this.format = format;
return _LoadFileWaitTillLoaded();
}
* @param format
* @return alignFrame constructed from file contents
*/
- public AlignFrame LoadFileWaitTillLoaded(FileParse source, String format)
+ public AlignFrame LoadFileWaitTillLoaded(AlignmentFileReaderI source,
+ FileFormatI format)
{
this.source = source;
file = source.getInFile();
- protocol = source.type;
+ protocol = source.getDataSourceType();
this.format = format;
return _LoadFileWaitTillLoaded();
}
/**
- * start thread and wait until finished, then return the alignFrame that's
- * (hopefully) been read.
+ * runs the 'run' method (in this thread), then return the alignFrame that's
+ * (hopefully) been read
*
* @return
*/
protected AlignFrame _LoadFileWaitTillLoaded()
{
- Thread loader = new Thread(this);
- loader.start();
-
- while (loader.isAlive())
- {
- try
- {
- Thread.sleep(500);
- } catch (Exception ex)
- {
- }
- }
+ this.run();
return alignFrame;
}
public void updateRecentlyOpened()
{
- Vector recent = new Vector();
- if (protocol.equals(FormatAdapter.PASTE))
+ Vector<String> recent = new Vector<>();
+ if (protocol == DataSourceType.PASTE)
{
// do nothing if the file was pasted in as text... there is no filename to
// refer to it as.
return;
}
- String type = protocol.equals(FormatAdapter.FILE) ? "RECENT_FILE"
+ if (file != null
+ && file.indexOf(System.getProperty("java.io.tmpdir")) > -1)
+ {
+ // ignore files loaded from the system's temporary directory
+ return;
+ }
+ String type = protocol == DataSourceType.FILE ? "RECENT_FILE"
: "RECENT_URL";
- String historyItems = jalview.bin.Cache.getProperty(type);
+ String historyItems = Cache.getProperty(type);
StringTokenizer st;
while (st.hasMoreTokens())
{
- recent.addElement(st.nextElement().toString().trim());
+ recent.addElement(st.nextToken().trim());
}
}
newHistory.append(recent.elementAt(i));
}
- jalview.bin.Cache.setProperty(type, newHistory.toString());
+ Cache.setProperty(type, newHistory.toString());
- if (protocol.equals(FormatAdapter.FILE))
+ if (protocol == DataSourceType.FILE)
{
- jalview.bin.Cache.setProperty("DEFAULT_FILE_FORMAT", format);
+ Cache.setProperty("DEFAULT_FILE_FORMAT", format.getName());
}
}
+ @Override
public void run()
{
- String title = protocol.equals(AppletFormatAdapter.PASTE) ? "Copied From Clipboard"
+ String title = protocol == DataSourceType.PASTE
+ ? "Copied From Clipboard"
: file;
Runtime rt = Runtime.getRuntime();
+
try
{
if (Desktop.instance != null)
// just in case the caller didn't identify the file for us
if (source != null)
{
- format = new IdentifyFile().Identify(source, false); // identify
- // stream and
- // rewind rather
- // than close
+ format = new IdentifyFile().identify(source, false);
+ // identify stream and rewind rather than close
+ }
+ else if (selectedFile != null)
+ {
+ format = new IdentifyFile().identify(selectedFile, protocol);
}
else
{
- format = new IdentifyFile().Identify(file, protocol);
+ format = new IdentifyFile().identify(file, protocol);
}
}
- if (format == null || format.equalsIgnoreCase("EMPTY DATA FILE"))
+ if (format == null)
{
Desktop.instance.stopLoading();
- System.err.println("The input file \"" + file
+ jalview.bin.Console.errPrintln("The input file \"" + file
+ "\" has null or unidentifiable data content!");
- if (!Jalview.isHeadlessMode())
+ if (!Jalview.isHeadlessMode() && !Jalview.isBatchMode())
{
- javax.swing.JOptionPane.showInternalMessageDialog(
- Desktop.desktop,
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop,
MessageManager.getString("label.couldnt_read_data")
+ " in " + file + "\n"
- + AppletFormatAdapter.SUPPORTED_FORMATS,
+ + AppletFormatAdapter.getSupportedFormats(),
MessageManager.getString("label.couldnt_read_data"),
- JOptionPane.WARNING_MESSAGE);
+ JvOptionPane.WARNING_MESSAGE);
}
+ // don't set shouldBeSaved if didn't load anything
+ // this.setShouldBeSaved();
return;
}
// TODO: cache any stream datasources as a temporary file (eg. PDBs
loadtime = -System.currentTimeMillis();
AlignmentI al = null;
- if (format.equalsIgnoreCase("Jalview"))
+ if (FileFormat.Jalview.equals(format))
{
if (source != null)
{
// Tell the user (developer?) that this is going to cause a problem
- System.err
- .println("IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
+ jalview.bin.Console.errPrintln(
+ "IMPLEMENTATION ERROR: Cannot read consecutive Jalview XML projects from a stream.");
// We read the data anyway - it might make sense.
}
- alignFrame = new Jalview2XML(raiseGUI).loadJalviewAlign(file);
+ // BH 2018 switch to File object here instead of filename
+ alignFrame = new Jalview2XML(raiseGUI && !Jalview.isBatchMode())
+ .loadJalviewAlign(
+ selectedFile == null ? file : selectedFile);
}
else
{
- String error = AppletFormatAdapter.SUPPORTED_FORMATS;
- if (FormatAdapter.isValidFormat(format))
+ String error = AppletFormatAdapter.getSupportedFormats();
+ try
{
- try
+ if (source != null)
+ {
+ // read from the provided source
+ al = new FormatAdapter().readFromFile(source, format);
+ }
+ else
{
- if (source != null)
+
+ // open a new source and read from it
+ FormatAdapter fa = new FormatAdapter();
+ boolean downloadStructureFile = format.isStructureFile()
+ && protocol.equals(DataSourceType.URL);
+ if (downloadStructureFile)
{
- // read from the provided source
- al = new FormatAdapter().readFromFile(source, format);
+ String structExt = format.getExtensions().split(",")[0];
+ String urlLeafName = file.substring(
+ file.lastIndexOf(
+ System.getProperty("file.separator")),
+ file.lastIndexOf("."));
+ String tempStructureFileStr = createNamedJvTempFile(
+ urlLeafName, structExt);
+
+ // BH - switching to File object here so as to hold
+ // ._bytes array directly
+ File tempFile = new File(tempStructureFileStr);
+ UrlDownloadClient.download(file, tempFile);
+
+ al = fa.readFile(tempFile, DataSourceType.FILE, format);
+ source = fa.getAlignFile();
}
else
{
+ if (selectedFile == null)
+ {
+ al = fa.readFile(null, file, protocol, format);
- // open a new source and read from it
- FormatAdapter fa = new FormatAdapter();
- al = fa.readFile(file, protocol, format);
+ }
+ else
+ {
+ al = fa.readFile(selectedFile, null, protocol, format);
+ }
source = fa.getAlignFile(); // keep reference for later if
- // necessary.
+
+ // necessary.
}
- } catch (java.io.IOException ex)
- {
- error = ex.getMessage();
}
- }
- else
+ } catch (java.io.IOException ex)
{
- if (format != null && format.length() > 7)
- {
- // ad hoc message in format.
- error = format + "\n" + error;
- }
+ error = ex.getMessage();
}
if ((al != null) && (al.getHeight() > 0) && al.hasValidSequence())
{
// register PDB entries with desktop's structure selection
// manager
- StructureSelectionManager.getStructureSelectionManager(
- Desktop.instance).registerPDBEntry(pdbe);
+ StructureSelectionManager
+ .getStructureSelectionManager(Desktop.instance)
+ .registerPDBEntry(pdbe);
}
}
}
+ FeatureSettingsModelI proxyColourScheme = source
+ .getFeatureColourScheme();
if (viewport != null)
{
// append to existing alignment
viewport.addAlignment(al, title);
+ viewport.applyFeaturesStyle(proxyColourScheme);
}
else
{
if (source instanceof ComplexAlignFile)
{
- ColumnSelection colSel = ((ComplexAlignFile) source)
- .getColumnSelection();
+ HiddenColumns colSel = ((ComplexAlignFile) source)
+ .getHiddenColumns();
SequenceI[] hiddenSeqs = ((ComplexAlignFile) source)
.getHiddenSequences();
- boolean showSeqFeatures = ((ComplexAlignFile) source)
- .isShowSeqFeatures();
String colourSchemeName = ((ComplexAlignFile) source)
.getGlobalColourScheme();
FeaturesDisplayedI fd = ((ComplexAlignFile) source)
.getDisplayedFeatures();
alignFrame = new AlignFrame(al, hiddenSeqs, colSel,
AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
-
- alignFrame.getViewport().setShowSequenceFeatures(
- showSeqFeatures);
alignFrame.getViewport().setFeaturesDisplayed(fd);
- ColourSchemeI cs = ColourSchemeMapper.getJalviewColourScheme(
- colourSchemeName, al);
+ alignFrame.getViewport().setShowSequenceFeatures(
+ ((ComplexAlignFile) source).isShowSeqFeatures());
+ ColourSchemeI cs = ColourSchemeMapper
+ .getJalviewColourScheme(colourSchemeName, al);
if (cs != null)
{
alignFrame.changeColour(cs);
{
alignFrame = new AlignFrame(al, AlignFrame.DEFAULT_WIDTH,
AlignFrame.DEFAULT_HEIGHT);
+ if (source instanceof FeaturesSourceI)
+ {
+ alignFrame.getViewport().setShowSequenceFeatures(true);
+ }
}
// add metadata and update ui
- if (!protocol.equals(AppletFormatAdapter.PASTE))
+ if (!(protocol == DataSourceType.PASTE))
{
alignFrame.setFileName(file, format);
+ alignFrame.setFileObject(selectedFile); // BH 2018 SwingJS
}
-
- alignFrame.statusBar.setText(MessageManager.formatMessage(
- "label.successfully_loaded_file",
- new String[] { title }));
+ if (proxyColourScheme != null)
+ {
+ alignFrame.getViewport()
+ .applyFeaturesStyle(proxyColourScheme);
+ }
+ alignFrame.setStatus(MessageManager.formatMessage(
+ "label.successfully_loaded_file", new String[]
+ { title }));
if (raiseGUI)
{
// that perform queries to find the 'current working alignment'
Desktop.addInternalFrame(alignFrame, title,
AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
+
+ /*
+ * for an Overview automatically opened with alignment,
+ * set its title now alignFrame title has been set
+ */
+ alignFrame.alignPanel.setOverviewTitle(alignFrame);
}
try
{
- alignFrame.setMaximum(jalview.bin.Cache.getDefault(
- "SHOW_FULLSCREEN", false));
+ alignFrame.setMaximum(
+ Cache.getDefault("SHOW_FULLSCREEN", false));
} catch (java.beans.PropertyVetoException ex)
{
}
Desktop.instance.stopLoading();
}
- final String errorMessage = MessageManager
- .getString("label.couldnt_load_file")
- + " "
- + title
- + "\n" + error;
+ final String errorMessage = MessageManager.getString(
+ "label.couldnt_load_file") + " " + title + "\n" + error;
// TODO: refactor FileLoader to be independent of Desktop / Applet GUI
// bits ?
- if (raiseGUI && Desktop.desktop != null)
+ if (raiseGUI && !Jalview.isBatchMode() && Desktop.desktop != null)
{
javax.swing.SwingUtilities.invokeLater(new Runnable()
{
+ @Override
public void run()
{
- JOptionPane.showInternalMessageDialog(Desktop.desktop,
- errorMessage, MessageManager
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+ errorMessage,
+ MessageManager
.getString("label.error_loading_file"),
- JOptionPane.WARNING_MESSAGE);
+ JvOptionPane.WARNING_MESSAGE);
}
});
}
else
{
- System.err.println(errorMessage);
+ jalview.bin.Console.errPrintln(errorMessage);
}
}
}
} catch (Exception er)
{
- System.err.println("Exception whilst opening file '" + file);
+ jalview.bin.Console
+ .errPrintln("Exception whilst opening file '" + file);
er.printStackTrace();
- if (raiseGUI)
+ if (raiseGUI && !Jalview.isBatchMode())
{
javax.swing.SwingUtilities.invokeLater(new Runnable()
{
+ @Override
public void run()
{
- javax.swing.JOptionPane.showInternalMessageDialog(
- Desktop.desktop, MessageManager.formatMessage(
- "label.problems_opening_file",
- new String[] { file }), MessageManager
- .getString("label.file_open_error"),
- javax.swing.JOptionPane.WARNING_MESSAGE);
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+ MessageManager.formatMessage(
+ "label.problems_opening_file", new String[]
+ { file }),
+ MessageManager.getString("label.file_open_error"),
+ JvOptionPane.WARNING_MESSAGE);
}
});
}
er.printStackTrace();
alignFrame = null;
- if (raiseGUI)
+ if (raiseGUI && !Jalview.isBatchMode())
{
javax.swing.SwingUtilities.invokeLater(new Runnable()
{
+ @Override
public void run()
{
- javax.swing.JOptionPane.showInternalMessageDialog(
- Desktop.desktop, MessageManager.formatMessage(
+ JvOptionPane.showInternalMessageDialog(Desktop.desktop,
+ MessageManager.formatMessage(
"warn.out_of_memory_loading_file", new String[]
- { file }), MessageManager
- .getString("label.out_of_memory"),
- javax.swing.JOptionPane.WARNING_MESSAGE);
+ { file }),
+ MessageManager.getString("label.out_of_memory"),
+ JvOptionPane.WARNING_MESSAGE);
}
});
}
- System.err.println("Out of memory loading file " + file + "!!");
+ jalview.bin.Console
+ .errPrintln("Out of memory loading file " + file + "!!");
}
loadtime += System.currentTimeMillis();
{
AlignmentI al = alignFrame.getViewport().getAlignment();
- System.out.println("Loaded '" + title + "' in "
+ jalview.bin.Console.outPrintln("Loaded '" + title + "' in "
+ (loadtime / 1000.0) + "s, took an additional "
+ (1.0 * memused / (1024.0 * 1024.0)) + " MB ("
+ al.getHeight() + " seqs by " + al.getWidth() + " cols)");
{
// report that we didn't load anything probably due to an out of memory
// error
- System.out.println("Failed to load '" + title + "' in "
+ jalview.bin.Console.outPrintln("Failed to load '" + title + "' in "
+ (loadtime / 1000.0) + "s, took an additional "
+ (1.0 * memused / (1024.0 * 1024.0))
+ " MB (alignment is null)");
Desktop.instance.stopLoading();
}
+ this.setShouldBeSaved();
+ // after first file loaded we revert to assuming a default file format
+ useDefaultFileFormat = true;
}
- /*
- * (non-Javadoc)
+ /**
+ * This method creates the file -
+ * {tmpdir}/jalview/{current_timestamp}/fileName.exetnsion using the supplied
+ * file name and extension
*
- * @see java.lang.Object#finalize()
+ * @param fileName
+ * the name of the temp file to be created
+ * @param extension
+ * the extension of the temp file to be created
+ * @return
+ */
+ private static String createNamedJvTempFile(String fileName,
+ String extension) throws IOException
+ {
+ String seprator = System.getProperty("file.separator");
+ String jvTempDir = System.getProperty("java.io.tmpdir") + "jalview"
+ + seprator + System.currentTimeMillis();
+ File tempStructFile = new File(
+ jvTempDir + seprator + fileName + "." + extension);
+ tempStructFile.mkdirs();
+ return tempStructFile.toString();
+ }
+
+ /*
+ * set whether quit should ask to save when just loaded this source
*/
- protected void finalize() throws Throwable
+ private void setShouldBeSaved()
+ {
+ if (protocol == null)
+ return;
+ AlignFrame af = this.alignFrame;
+ if (af == null)
+ return;
+ AlignViewport avp = af.getViewport();
+ if (avp == null)
+ return;
+ boolean upToDate = !protocol.isDynamic();
+ if (protocol.isUrl() && !Cache
+ .getDefault(PROMPT_SAVE_UNCHANGED_URL_ALIGNMENTS, true))
+ {
+ upToDate = true;
+ }
+ avp.setSavedUpToDate(upToDate,
+ upToDate ? null : QuitHandler.Message.UNSAVED_ALIGNMENTS);
+ }
+
+ public static final String PROMPT_SAVE_UNCHANGED_URL_ALIGNMENTS = "PROMPT_SAVE_UNCHANGED_URL_ALIGNMENTS";
+
+ public static boolean getUseDefaultFileFormat()
{
- source = null;
- alignFrame = null;
- viewport = null;
- super.finalize();
+ return useDefaultFileFormat;
}
}