X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FAppletFormatAdapter.java;h=6679a03a907e3e01224a66c4b7385aa0088761cb;hb=c932f0e85a8852824cdd8ce790af68682732c85c;hp=fbfaab131fba87b73e372fff2d5513f1b4676697;hpb=7cb5308c5ec411a566d131993e63abaaf7f7c7b9;p=jalview.git diff --git a/src/jalview/io/AppletFormatAdapter.java b/src/jalview/io/AppletFormatAdapter.java index fbfaab1..56e9fa1 100755 --- a/src/jalview/io/AppletFormatAdapter.java +++ b/src/jalview/io/AppletFormatAdapter.java @@ -1,197 +1,326 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer - * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$) + * Copyright (C) $$Year-Rel$$ The Jalview Authors * - * This program is free software; you can redistribute it and/or + * This file is part of Jalview. + * + * Jalview is free software: you can redistribute it and/or * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 + * as published by the Free Software Foundation, either version 3 * of the License, or (at your option) any later version. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * Jalview is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR + * PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + * along with Jalview. If not, see . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.io; -import jalview.datamodel.*; +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.util.List; +import java.util.Locale; + +import jalview.api.AlignExportSettingsI; +import jalview.api.AlignmentViewPanel; +import jalview.datamodel.Alignment; +import jalview.datamodel.AlignmentAnnotation; +import jalview.datamodel.AlignmentI; +import jalview.datamodel.AlignmentView; +import jalview.datamodel.PDBEntry.Type; +import jalview.datamodel.SequenceI; +import jalview.ext.jmol.JmolParser; +import jalview.structure.StructureImportSettings; +import jalview.util.Platform; /** - * DOCUMENT ME! + * A low level class for alignment and feature IO with alignment formatting + * methods used by both applet and application for generating flat alignment + * files. It also holds the lists of magic format names that the applet and + * application will allow the user to read or write files with. * * @author $author$ * @version $Revision$ */ public class AppletFormatAdapter { - /** DOCUMENT ME!! */ - public static final String[] READABLE_FORMATS = new String[] - { - "BLC", "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "STH", "PDB", "JnetFile" - }; + private AlignmentViewPanel viewpanel; - public static final String[] WRITEABLE_FORMATS = new String[] - { - "BLC", "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM" , "AMSA" - }; + /** + * add jalview-derived non-secondary structure annotation from PDB structure + */ + boolean annotFromStructure = false; - public static final String[] WRITABLE_EXTENSIONS = new String[] - { "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc","amsa","jar" }; + /** + * add secondary structure from PDB data with built-in algorithms + */ + boolean localSecondaryStruct = false; - public static final String[] WRITABLE_FNAMES = new String[] - { "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Jalview" }; + /** + * process PDB data with web services + */ + boolean serviceSecondaryStruct = false; + + private AlignmentFileReaderI alignFile = null; + + String inFile; + + /** + * character used to write newlines + */ + protected String newline = System.getProperty("line.separator"); + + private AlignExportSettingsI exportSettings; + + private File selectedFile; - public static final String[] READABLE_EXTENSIONS = new String[] - { - "fa, fasta, fastq", "aln", "pfam", "msf", "pir", "blc", - "amsa","jar" - }; - public static final String[] READABLE_FNAMES = new String[] - { - "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA","Jalview" - }; - public static String INVALID_CHARACTERS = "Contains invalid characters"; - // TODO: make these messages dynamic - public static String SUPPORTED_FORMATS = "Formats currently supported are\n" + - prettyPrint(READABLE_FORMATS); + /** + * Returns an error message with a list of supported readable file formats * - * @param els - * @return grammatically correct(ish) list consisting of els elements. + * @return */ - public static String prettyPrint(String[] els) { - StringBuffer list = new StringBuffer(); - for (int i=0,iSize=els.length-1; i things) { - boolean valid = false; - for (int i = 0; i < READABLE_FORMATS.length; i++) + StringBuffer list = new StringBuffer(); + for (int i = 0, iSize = things.size() - 1; i < iSize; i++) { - if (READABLE_FORMATS[i].equalsIgnoreCase(format)) - { - return true; - } + list.append(things.get(i).toString()); + list.append(", "); } + // could i18n 'and' here + list.append(" and " + things.get(things.size() - 1).toString() + "."); + return list.toString(); + } + + public void setNewlineString(String nl) + { + newline = nl; + } - return valid; + public String getNewlineString() + { + return newline; } /** * Constructs the correct filetype parser for a characterised datasource * - * @param inFile data/data location - * @param type type of datasource - * @param format File format of data provided by datasource + * @param inFile + * data/data location + * @param sourceType + * type of datasource + * @param fileFormat * - * @return DOCUMENT ME! + * @return */ - public Alignment readFile(String inFile, String type, String format) - throws java.io.IOException + public AlignmentI readFile(String file, DataSourceType sourceType, + FileFormatI fileFormat) throws IOException + { + return readFile(null, file, sourceType, fileFormat); + } + + public AlignmentI readFile(File selectedFile, String file, + DataSourceType sourceType, FileFormatI fileFormat) + throws IOException + { + return readFile(selectedFile, file, sourceType, fileFormat, null); + } + + public AlignmentI readFile(File selectedFile, String file, + DataSourceType sourceType, FileFormatI fileFormat, + StructureImportSettings.TFType tempfacType) throws IOException { - this.inFile = inFile; + + this.selectedFile = selectedFile; + this.inFile = selectedFile != null ? selectedFile.getPath() : file; try { - if (format.equals("FASTA")) - { - afile = new FastaFile(inFile, type); - } - else if (format.equals("MSF")) - { - afile = new MSFfile(inFile, type); - } - else if (format.equals("PileUp")) + if (fileFormat.isStructureFile()) { - afile = new PileUpfile(inFile, type); + String structureParser = StructureImportSettings + .getDefaultPDBFileParser(); + boolean isParseWithJMOL = structureParser.equalsIgnoreCase( + StructureImportSettings.StructureParser.JMOL_PARSER + .toString()); + StructureImportSettings.addSettings(annotFromStructure, + localSecondaryStruct, serviceSecondaryStruct); + if (tempfacType != null) + { + StructureImportSettings.setTemperatureFactorType(tempfacType); + } + if (isParseWithJMOL) + { + // needs a File option + alignFile = new JmolParser( + selectedFile == null ? inFile : selectedFile, sourceType, + StructureImportSettings.getTemperatureFactorType()); + } + else + { + // todo is mc_view parsing obsolete yet? JAL-2120 + StructureImportSettings.setShowSeqFeatures(true); + alignFile = new mc_view.PDBfile(annotFromStructure, + localSecondaryStruct, serviceSecondaryStruct, inFile, + sourceType); + } + ((StructureFile) alignFile).setDbRefType( + FileFormat.PDB.equals(fileFormat) ? Type.PDB : Type.MMCIF); } - else if (format.equals("CLUSTAL")) + else if (selectedFile != null) { - afile = new ClustalFile(inFile, type); + alignFile = fileFormat + .getReader(new FileParse(selectedFile, sourceType)); } - else if (format.equals("BLC")) + else { - afile = new BLCFile(inFile, type); + // alignFile = fileFormat.getAlignmentFile(inFile, sourceType); + alignFile = fileFormat.getReader(new FileParse(inFile, sourceType)); } - else if (format.equals("PIR")) + return buildAlignmentFromFile(); + } catch (Exception e) + { + e.printStackTrace(); + jalview.bin.Console.errPrintln("Failed to read alignment using the '" + fileFormat + + "' reader.\n" + e); + + if (e.getMessage() != null + && e.getMessage().startsWith(INVALID_CHARACTERS)) { - afile = new PIRFile(inFile, type); + throw new IOException(e.getMessage()); } - else if (format.equals("PFAM")) + + // Finally test if the user has pasted just the sequence, no id + if (sourceType == DataSourceType.PASTE) { - afile = new PfamFile(inFile, type); + try + { + // Possible sequence is just residues with no label + alignFile = new FastaFile(">UNKNOWN\n" + inFile, + DataSourceType.PASTE); + return buildAlignmentFromFile(); + + } catch (Exception ex) + { + if (ex.toString().startsWith(INVALID_CHARACTERS)) + { + throw new IOException(e.getMessage()); + } + + ex.printStackTrace(); + } } - else if (format.equals("JnetFile")) + if (FileFormat.Html.equals(fileFormat)) { - afile = new JPredFile(inFile, type); - ( (JPredFile) afile).removeNonSequences(); + throw new IOException(e.getMessage()); } - else if (format.equals("PDB")) + } + throw new FileFormatException(getSupportedFormats()); + } + + /** + * Constructs the correct filetype parser for an already open datasource + * + * @param source + * an existing datasource + * @param format + * File format of data that will be provided by datasource + * + * @return + */ + public AlignmentI readFromFile(FileParse source, FileFormatI format) + throws IOException + { + this.inFile = source.getInFile(); + DataSourceType type = source.dataSourceType; + try + { + if (FileFormat.PDB.equals(format) || FileFormat.MMCif.equals(format)) { - afile = new MCview.PDBfile(inFile, type); + // TODO obtain config value from preference settings + boolean isParseWithJMOL = false; + if (isParseWithJMOL) + { + StructureImportSettings.addSettings(annotFromStructure, + localSecondaryStruct, serviceSecondaryStruct); + alignFile = new JmolParser(source); + } + else + { + StructureImportSettings.setShowSeqFeatures(true); + alignFile = new mc_view.PDBfile(annotFromStructure, + localSecondaryStruct, serviceSecondaryStruct, source); + } + ((StructureFile) alignFile).setDbRefType(Type.PDB); } - else if (format.equals("STH")) + else { - afile = new StockholmFile(inFile, type); + alignFile = format.getReader(source); } - Alignment al = new Alignment(afile.getSeqsAsArray()); + return buildAlignmentFromFile(); - afile.addAnnotations(al); - - return al; - } - catch (Exception e) + } catch (Exception e) { e.printStackTrace(); - System.err.println("Failed to read alignment using the '" + format + - "' reader.\n" + e); + jalview.bin.Console.errPrintln("Failed to read alignment using the '" + format + + "' reader.\n" + e); - if (e.getMessage() != null && - e.getMessage().startsWith(INVALID_CHARACTERS)) + if (e.getMessage() != null + && e.getMessage().startsWith(INVALID_CHARACTERS)) { - throw new java.io.IOException(e.getMessage()); + throw new FileFormatException(e.getMessage()); } // Finally test if the user has pasted just the sequence, no id - if (type.equalsIgnoreCase("Paste")) + if (type == DataSourceType.PASTE) { try { // Possible sequence is just residues with no label - afile = new FastaFile(">UNKNOWN\n" + inFile, "Paste"); - Alignment al = new Alignment(afile.getSeqsAsArray()); - afile.addAnnotations(al); - return al; + alignFile = new FastaFile(">UNKNOWN\n" + inFile, + DataSourceType.PASTE); + return buildAlignmentFromFile(); - } - catch (Exception ex) + } catch (Exception ex) { if (ex.toString().startsWith(INVALID_CHARACTERS)) { - throw new java.io.IOException(e.getMessage()); + throw new IOException(e.getMessage()); } ex.printStackTrace(); @@ -199,79 +328,386 @@ public class AppletFormatAdapter } // If we get to this stage, the format was not supported - throw new java.io.IOException(SUPPORTED_FORMATS); + throw new FileFormatException(getSupportedFormats()); + } + } + + /** + * boilerplate method to handle data from an AlignFile and construct a new + * alignment or import to an existing alignment + * + * @return AlignmentI instance ready to pass to a UI constructor + */ + private AlignmentI buildAlignmentFromFile() + { + // Standard boilerplate for creating alignment from parser + // alignFile.configureForView(viewpanel); + + AlignmentI al = new Alignment(alignFile.getSeqsAsArray()); + + alignFile.addAnnotations(al); + + alignFile.addGroups(al); + + return al; + } + + /** + * create an alignment flatfile from a Jalview alignment view + * + * @param format + * @param jvsuffix + * @param av + * @param selectedOnly + * @return flatfile in a string + */ + public String formatSequences(FileFormatI format, boolean jvsuffix, + AlignmentViewPanel ap, boolean selectedOnly) + { + + AlignmentView selvew = ap.getAlignViewport() + .getAlignmentView(selectedOnly, false); + AlignmentI aselview = selvew + .getVisibleAlignment(ap.getAlignViewport().getGapCharacter()); + List ala = (ap.getAlignViewport() + .getVisibleAlignmentAnnotation(selectedOnly)); + if (ala != null) + { + for (AlignmentAnnotation aa : ala) + { + aselview.addAnnotation(aa); + } } + viewpanel = ap; + return formatSequences(format, aselview, jvsuffix); } /** - * Construct an output class for an alignment in a particular filetype + * Construct an output class for an alignment in a particular filetype TODO: + * allow caller to detect errors and warnings encountered when generating + * output * - * @param format DOCUMENT ME! - * @param seqs DOCUMENT ME! - * @param jvsuffix passed to AlnFile class + * @param format + * string name of alignment format + * @param alignment + * the alignment to be written out + * @param jvsuffix + * passed to AlnFile class controls whether /START-END is added to + * sequence names * * @return alignment flat file contents */ - public String formatSequences(String format, - AlignmentI alignment, - boolean jvsuffix) + public String formatSequences(FileFormatI format, AlignmentI alignment, + boolean jvsuffix) { try { - AlignFile afile = null; + AlignmentFileWriterI afile = format.getWriter(alignment); - if (format.equalsIgnoreCase("FASTA")) - { - afile = new FastaFile(); - } - else if (format.equalsIgnoreCase("MSF")) + afile.setNewlineString(newline); + afile.setExportSettings(exportSettings); + afile.configureForView(viewpanel); + + // check whether we were given a specific alignment to export, rather than + // the one in the viewpanel + SequenceI[] seqs = null; + if (viewpanel == null || viewpanel.getAlignment() == null + || viewpanel.getAlignment() != alignment) { - afile = new MSFfile(); + seqs = alignment.getSequencesArray(); } - else if (format.equalsIgnoreCase("PileUp")) + else { - afile = new PileUpfile(); + seqs = viewpanel.getAlignment().getSequencesArray(); } - else if (format.equalsIgnoreCase("CLUSTAL")) + + String afileresp = afile.print(seqs, jvsuffix); + if (afile.hasWarningMessage()) { - afile = new ClustalFile(); + jalview.bin.Console.errPrintln("Warning raised when writing as " + format + + " : " + afile.getWarningMessage()); } - else if (format.equalsIgnoreCase("BLC")) + return afileresp; + } catch (Exception e) + { + jalview.bin.Console.errPrintln("Failed to write alignment as a '" + + format.getName() + "' file\n"); + e.printStackTrace(); + } + + return null; + } + + /** + * Determines the protocol (i.e DataSourceType.{FILE|PASTE|URL}) for the input + * data + * + * BH 2018 allows File or String, and can return RELATIVE_URL + * + * @param dataObject + * File or String + * @return the protocol for the input data + */ + public static DataSourceType checkProtocol(Object dataObject) + { + if (dataObject instanceof File) + { + return DataSourceType.FILE; + } + + String data = dataObject.toString(); + DataSourceType protocol = DataSourceType.PASTE; + String ft = data.toLowerCase(Locale.ROOT).trim(); + if (ft.indexOf("http:") == 0 || ft.indexOf("https:") == 0 + || ft.indexOf("file:") == 0) + { + protocol = DataSourceType.URL; + } + else if (Platform.isJS()) + { + protocol = DataSourceType.RELATIVE_URL; + } + else if (new File(data).exists()) + { + protocol = DataSourceType.FILE; + } + return protocol; + } + + /** + * @param args + * @j2sIgnore + */ + public static void main(String[] args) + { + int i = 0; + while (i < args.length) + { + File f = new File(args[i]); + if (f.exists()) { - afile = new BLCFile(); + try + { + jalview.bin.Console.outPrintln("Reading file: " + f); + AppletFormatAdapter afa = new AppletFormatAdapter(); + Runtime r = Runtime.getRuntime(); + System.gc(); + long memf = -r.totalMemory() + r.freeMemory(); + long t1 = -System.currentTimeMillis(); + AlignmentI al = afa.readFile(args[i], DataSourceType.FILE, + new IdentifyFile().identify(args[i], + DataSourceType.FILE)); + t1 += System.currentTimeMillis(); + System.gc(); + memf += r.totalMemory() - r.freeMemory(); + if (al != null) + { + jalview.bin.Console.outPrintln("Alignment contains " + al.getHeight() + + " sequences and " + al.getWidth() + " columns."); + try + { + jalview.bin.Console.outPrintln(new AppletFormatAdapter() + .formatSequences(FileFormat.Fasta, al, true)); + } catch (Exception e) + { + jalview.bin.Console.errPrintln( + "Couln't format the alignment for output as a FASTA file."); + e.printStackTrace(System.err); + } + } + else + { + jalview.bin.Console.outPrintln("Couldn't read alignment"); + } + jalview.bin.Console.outPrintln("Read took " + (t1 / 1000.0) + " seconds."); + jalview.bin.Console.outPrintln( + "Difference between free memory now and before is " + + (memf / (1024.0 * 1024.0) * 1.0) + " MB"); + } catch (Exception e) + { + jalview.bin.Console.errPrintln("Exception when dealing with " + i + + "'th argument: " + args[i] + "\n" + e); + } } - else if (format.equalsIgnoreCase("PIR")) + else { - afile = new PIRFile(); + jalview.bin.Console.errPrintln("Ignoring argument '" + args[i] + "' (" + i + + "'th)- not a readable file."); } - else if (format.equalsIgnoreCase("PFAM")) + i++; + } + } + + /** + * try to discover how to access the given file as a valid datasource that + * will be identified as the given type. + * + * @param file + * @param format + * @return protocol that yields the data parsable as the given type + */ + public static DataSourceType resolveProtocol(String file, + FileFormatI format) + { + return resolveProtocol(file, format, false); + } + + public static DataSourceType resolveProtocol(String file, + FileFormatI format, boolean debug) + { + // TODO: test thoroughly! + DataSourceType protocol = null; + if (debug) + { + jalview.bin.Console.outPrintln("resolving datasource started with:\n>>file\n" + + file + ">>endfile"); + } + + // This might throw a security exception in certain browsers + // Netscape Communicator for instance. + try + { + boolean rtn = false; + InputStream is = System.getSecurityManager().getClass() + .getResourceAsStream("/" + file); + if (is != null) { - afile = new PfamFile(); + rtn = true; + is.close(); } - else if (format.equalsIgnoreCase("STH")) + if (debug) { - afile = new StockholmFile(); + jalview.bin.Console.errPrintln("Resource '" + file + "' was " + + (rtn ? "" : "not") + " located by classloader."); } - else if (format.equalsIgnoreCase("AMSA")) + if (rtn) { - afile = new AMSAFile(alignment); - } else { - throw new Exception("Implementation error: Unknown file format string"); + protocol = DataSourceType.CLASSLOADER; } - afile.addJVSuffix(jvsuffix); - - afile.setSeqs(alignment.getSequencesArray()); + } catch (Exception ex) + { + System.err + .println("Exception checking resources: " + file + " " + ex); + } - return afile.print(); + if (file.indexOf("://") > -1) + { + protocol = DataSourceType.URL; } - catch (Exception e) + else { - System.err.println("Failed to write alignment as a '" + format + - "' file\n"); - e.printStackTrace(); + // skipping codebase prepend check. + protocol = DataSourceType.FILE; + } + FileParse fp = null; + try + { + if (debug) + { + jalview.bin.Console.outPrintln( + "Trying to get contents of resource as " + protocol + ":"); + } + fp = new FileParse(file, protocol); + if (!fp.isValid()) + { + fp = null; + } + else + { + if (debug) + { + jalview.bin.Console.outPrintln("Successful."); + } + } + } catch (Exception e) + { + if (debug) + { + jalview.bin.Console.errPrintln("Exception when accessing content: " + e); + } + fp = null; + } + if (fp == null) + { + if (debug) + { + jalview.bin.Console.outPrintln("Accessing as paste."); + } + protocol = DataSourceType.PASTE; + fp = null; + try + { + fp = new FileParse(file, protocol); + if (!fp.isValid()) + { + fp = null; + } + } catch (Exception e) + { + jalview.bin.Console.errPrintln("Failed to access content as paste!"); + e.printStackTrace(); + fp = null; + } + } + if (fp == null) + { + return null; + } + if (format == null) + { + return protocol; + } + else + { + try + { + FileFormatI idformat = new IdentifyFile().identify(file, protocol); + if (idformat == null) + { + if (debug) + { + jalview.bin.Console.outPrintln("Format not identified. Inaccessible file."); + } + return null; + } + if (debug) + { + jalview.bin.Console.outPrintln("Format identified as " + idformat + + "and expected as " + format); + } + if (idformat.equals(format)) + { + if (debug) + { + jalview.bin.Console.outPrintln("Protocol identified as " + protocol); + } + return protocol; + } + else + { + if (debug) + { + System.out + .println("File deemed not accessible via " + protocol); + } + fp.close(); + return null; + } + } catch (Exception e) + { + if (debug) + { + jalview.bin.Console.errPrintln("File deemed not accessible via " + protocol); + e.printStackTrace(); + } + } } - return null; } + + public AlignmentFileReaderI getAlignFile() + { + return alignFile; + } }