JAL-1919 set default structure file format to mmCIF, refactored some StructureImportS...
[jalview.git] / src / jalview / io / AppletFormatAdapter.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.io;
22
23 import jalview.api.AlignExportSettingI;
24 import jalview.api.AlignmentViewPanel;
25 import jalview.datamodel.Alignment;
26 import jalview.datamodel.AlignmentAnnotation;
27 import jalview.datamodel.AlignmentI;
28 import jalview.datamodel.AlignmentView;
29 import jalview.structure.StructureImportSettings;
30 import jalview.util.MessageManager;
31
32 import java.io.File;
33 import java.io.IOException;
34 import java.io.InputStream;
35 import java.util.List;
36
37 /**
38  * A low level class for alignment and feature IO with alignment formatting
39  * methods used by both applet and application for generating flat alignment
40  * files. It also holds the lists of magic format names that the applet and
41  * application will allow the user to read or write files with.
42  *
43  * @author $author$
44  * @version $Revision$
45  */
46 public class AppletFormatAdapter
47 {
48   private AlignmentViewPanel viewpanel;
49
50   public static String FILE = "File";
51
52   public static String URL = "URL";
53
54   public static String PASTE = "Paste";
55
56   public static String CLASSLOADER = "ClassLoader";
57
58   /**
59    * add jalview-derived non-secondary structure annotation from PDB structure
60    */
61   boolean annotFromStructure = false;
62
63   /**
64    * add secondary structure from PDB data with built-in algorithms
65    */
66   boolean localSecondaryStruct = false;
67
68   /**
69    * process PDB data with web services
70    */
71   boolean serviceSecondaryStruct = false;
72
73   private AlignFile alignFile = null;
74
75   String inFile;
76
77   /**
78    * character used to write newlines
79    */
80   protected String newline = System.getProperty("line.separator");
81
82   private AlignExportSettingI exportSettings;
83
84   /**
85    * List of valid format strings used in the isValidFormat method
86    */
87   public static final String[] READABLE_FORMATS = new String[] { "BLC",
88       "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "STH", "PDB",
89       "JnetFile", "RNAML", PhylipFile.FILE_DESC, JSONFile.FILE_DESC,
90       IdentifyFile.FeaturesFile, "HTML", "mmCIF" };
91
92   /**
93    * List of readable format file extensions by application in order
94    * corresponding to READABLE_FNAMES
95    */
96   public static final String[] READABLE_EXTENSIONS = new String[] {
97       "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
98       "sto,stk", "xml,rnaml", PhylipFile.FILE_EXT, JSONFile.FILE_EXT,
99       ".gff2,gff3", "jar,jvp", HtmlFile.FILE_EXT, "cif" };
100
101   /**
102    * List of readable formats by application in order corresponding to
103    * READABLE_EXTENSIONS
104    */
105   public static final String[] READABLE_FNAMES = new String[] { "Fasta",
106       "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Stockholm", "RNAML",
107       PhylipFile.FILE_DESC, JSONFile.FILE_DESC, IdentifyFile.FeaturesFile,
108       "Jalview", HtmlFile.FILE_DESC, "mmCIF" };
109
110   /**
111    * List of valid format strings for use by callers of the formatSequences
112    * method
113    */
114   public static final String[] WRITEABLE_FORMATS = new String[] { "BLC",
115       "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "AMSA", "STH",
116       PhylipFile.FILE_DESC, JSONFile.FILE_DESC };
117
118   /**
119    * List of extensions corresponding to file format types in WRITABLE_FNAMES
120    * that are writable by the application.
121    */
122   public static final String[] WRITABLE_EXTENSIONS = new String[] {
123       "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
124       "sto,stk", PhylipFile.FILE_EXT, JSONFile.FILE_EXT, "jvp" };
125
126   /**
127    * List of writable formats by the application. Order must correspond with the
128    * WRITABLE_EXTENSIONS list of formats.
129    */
130   public static final String[] WRITABLE_FNAMES = new String[] { "Fasta",
131       "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "STH",
132       PhylipFile.FILE_DESC, JSONFile.FILE_DESC, "Jalview" };
133
134   public static String INVALID_CHARACTERS = "Contains invalid characters";
135
136   // TODO: make these messages dynamic
137   public static String SUPPORTED_FORMATS = "Formats currently supported are\n"
138           + prettyPrint(READABLE_FORMATS);
139
140   public AppletFormatAdapter()
141   {
142   }
143
144   public AppletFormatAdapter(AlignmentViewPanel viewpanel)
145   {
146     this.viewpanel = viewpanel;
147   }
148
149   public AppletFormatAdapter(AlignmentViewPanel alignPanel,
150           AlignExportSettingI settings)
151   {
152     viewpanel = alignPanel;
153     exportSettings = settings;
154   }
155
156   /**
157    *
158    * @param els
159    * @return grammatically correct(ish) list consisting of els elements.
160    */
161   public static String prettyPrint(String[] els)
162   {
163     StringBuffer list = new StringBuffer();
164     for (int i = 0, iSize = els.length - 1; i < iSize; i++)
165     {
166       list.append(els[i]);
167       list.append(", ");
168     }
169     list.append(" and " + els[els.length - 1] + ".");
170     return list.toString();
171   }
172
173   public void setNewlineString(String nl)
174   {
175     newline = nl;
176   }
177
178   public String getNewlineString()
179   {
180     return newline;
181   }
182
183   /**
184    * check that this format is valid for reading
185    *
186    * @param format
187    *          a format string to be compared with READABLE_FORMATS
188    * @return true if format is readable
189    */
190   public static final boolean isValidFormat(String format)
191   {
192     return isValidFormat(format, false);
193   }
194
195   /**
196    * validate format is valid for IO
197    *
198    * @param format
199    *          a format string to be compared with either READABLE_FORMATS or
200    *          WRITEABLE_FORMATS
201    * @param forwriting
202    *          when true, format is checked for containment in WRITEABLE_FORMATS
203    * @return true if format is valid
204    */
205   public static final boolean isValidFormat(String format,
206           boolean forwriting)
207   {
208     if (format == null)
209     {
210       return false;
211     }
212     boolean valid = false;
213     String[] format_list = (forwriting) ? WRITEABLE_FORMATS
214             : READABLE_FORMATS;
215     for (String element : format_list)
216     {
217       if (element.equalsIgnoreCase(format))
218       {
219         return true;
220       }
221     }
222
223     return valid;
224   }
225
226   /**
227    * Constructs the correct filetype parser for a characterised datasource
228    *
229    * @param inFile
230    *          data/data location
231    * @param type
232    *          type of datasource
233    * @param format
234    *          File format of data provided by datasource
235    *
236    * @return DOCUMENT ME!
237    */
238   public AlignmentI readFile(String inFile, String type, String format)
239           throws java.io.IOException
240   {
241     // TODO: generalise mapping between format string and io. class instances
242     // using Constructor.invoke reflection
243     this.inFile = inFile;
244     try
245     {
246       if (format.equals("FASTA"))
247       {
248         alignFile = new FastaFile(inFile, type);
249       }
250       else if (format.equals("MSF"))
251       {
252         alignFile = new MSFfile(inFile, type);
253       }
254       else if (format.equals("PileUp"))
255       {
256         alignFile = new PileUpfile(inFile, type);
257       }
258       else if (format.equals("CLUSTAL"))
259       {
260         alignFile = new ClustalFile(inFile, type);
261       }
262       else if (format.equals("BLC"))
263       {
264         alignFile = new BLCFile(inFile, type);
265       }
266       else if (format.equals("PIR"))
267       {
268         alignFile = new PIRFile(inFile, type);
269       }
270       else if (format.equals("PFAM"))
271       {
272         alignFile = new PfamFile(inFile, type);
273       }
274       else if (format.equals("JnetFile"))
275       {
276         alignFile = new JPredFile(inFile, type);
277         ((JPredFile) alignFile).removeNonSequences();
278       }
279       else if (format.equals("PDB"))
280       {
281         // TODO obtain config value from preference settings.
282         // Set value to 'true' to test PDB processing with Jmol: JAL-1213
283         boolean isParseWithJMOL = StructureImportSettings
284                 .getDefaultPDBFileParser().equalsIgnoreCase(
285                         StructureImportSettings.JMOL_PARSER);
286         if (isParseWithJMOL)
287         {
288           StructureImportSettings.addSettings(annotFromStructure,
289                   localSecondaryStruct, serviceSecondaryStruct);
290           alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
291                   localSecondaryStruct, serviceSecondaryStruct, inFile,
292                   type);
293         }
294         else
295         {
296           StructureImportSettings.addSettings(annotFromStructure,
297                   localSecondaryStruct, serviceSecondaryStruct);
298           StructureImportSettings.setShowSeqFeatures(true);
299           alignFile = new MCview.PDBfile(annotFromStructure,
300                   localSecondaryStruct, serviceSecondaryStruct, inFile,
301                   type);
302         }
303         ((StructureFile) alignFile).setDbRefType(format);
304       }
305       else if (format.equals("mmCIF"))
306       {
307         StructureImportSettings.addSettings(annotFromStructure,
308                 localSecondaryStruct, serviceSecondaryStruct);
309         alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
310                 localSecondaryStruct, serviceSecondaryStruct, inFile, type);
311         ((StructureFile) alignFile).setDbRefType(format);
312       }
313       else if (format.equals("STH"))
314       {
315         alignFile = new StockholmFile(inFile, type);
316       }
317       else if (format.equals("SimpleBLAST"))
318       {
319         alignFile = new SimpleBlastFile(inFile, type);
320       }
321       else if (format.equals(PhylipFile.FILE_DESC))
322       {
323         alignFile = new PhylipFile(inFile, type);
324       }
325       else if (format.equals(JSONFile.FILE_DESC))
326       {
327         alignFile = new JSONFile(inFile, type);
328       }
329       else if (format.equals(HtmlFile.FILE_DESC))
330       {
331         alignFile = new HtmlFile(inFile, type);
332       }
333       else if (format.equals("RNAML"))
334       {
335         alignFile = new RnamlFile(inFile, type);
336       }
337       else if (format.equals(IdentifyFile.FeaturesFile))
338       {
339         alignFile = new FeaturesFile(true, inFile, type);
340       }
341       return buildAlignmentFrom(alignFile);
342     } catch (Exception e)
343     {
344       e.printStackTrace();
345       System.err.println("Failed to read alignment using the '" + format
346               + "' reader.\n" + e);
347
348       if (e.getMessage() != null
349               && e.getMessage().startsWith(INVALID_CHARACTERS))
350       {
351         throw new java.io.IOException(e.getMessage());
352       }
353
354       // Finally test if the user has pasted just the sequence, no id
355       if (type.equalsIgnoreCase("Paste"))
356       {
357         try
358         {
359           // Possible sequence is just residues with no label
360           alignFile = new FastaFile(">UNKNOWN\n" + inFile, "Paste");
361           return buildAlignmentFrom(alignFile);
362
363         } catch (Exception ex)
364         {
365           if (ex.toString().startsWith(INVALID_CHARACTERS))
366           {
367             throw new java.io.IOException(e.getMessage());
368           }
369
370           ex.printStackTrace();
371         }
372       }
373       if (format.equalsIgnoreCase("HTML"))
374       {
375         throw new IOException(e.getMessage());
376       }
377       // If we get to this stage, the format was not supported
378       throw new java.io.IOException(SUPPORTED_FORMATS);
379     }
380   }
381
382   /**
383    * Constructs the correct filetype parser for an already open datasource
384    *
385    * @param source
386    *          an existing datasource
387    * @param format
388    *          File format of data that will be provided by datasource
389    *
390    * @return DOCUMENT ME!
391    */
392   public AlignmentI readFromFile(FileParse source, String format)
393           throws java.io.IOException
394   {
395     // TODO: generalise mapping between format string and io. class instances
396     // using Constructor.invoke reflection
397     // This is exactly the same as the readFile method except we substitute
398     // 'inFile, type' with 'source'
399     this.inFile = source.getInFile();
400     String type = source.type;
401     try
402     {
403       if (format.equals("FASTA"))
404       {
405         alignFile = new FastaFile(source);
406       }
407       else if (format.equals("MSF"))
408       {
409         alignFile = new MSFfile(source);
410       }
411       else if (format.equals("PileUp"))
412       {
413         alignFile = new PileUpfile(source);
414       }
415       else if (format.equals("CLUSTAL"))
416       {
417         alignFile = new ClustalFile(source);
418       }
419       else if (format.equals("BLC"))
420       {
421         alignFile = new BLCFile(source);
422       }
423       else if (format.equals("PIR"))
424       {
425         alignFile = new PIRFile(source);
426       }
427       else if (format.equals("PFAM"))
428       {
429         alignFile = new PfamFile(source);
430       }
431       else if (format.equals("JnetFile"))
432       {
433         alignFile = new JPredFile(source);
434         ((JPredFile) alignFile).removeNonSequences();
435       }
436       else if (format.equals("PDB"))
437       {
438         // TODO obtain config value from preference settings
439         boolean isParseWithJMOL = false;
440         if (isParseWithJMOL)
441         {
442           StructureImportSettings.addSettings(annotFromStructure,
443                   localSecondaryStruct, serviceSecondaryStruct);
444           alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
445                   localSecondaryStruct, serviceSecondaryStruct, source);
446         }
447         else
448         {
449           StructureImportSettings.setShowSeqFeatures(true);
450           alignFile = new MCview.PDBfile(annotFromStructure,
451                   localSecondaryStruct, serviceSecondaryStruct, source);
452         }
453         ((StructureFile) alignFile)
454                 .setDbRefType(StructureImportSettings.PDB);
455       }
456       else if (format.equals("mmCIF"))
457       {
458         StructureImportSettings.addSettings(annotFromStructure,
459                 localSecondaryStruct, serviceSecondaryStruct);
460         alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
461                 localSecondaryStruct, serviceSecondaryStruct, source);
462         ((StructureFile) alignFile)
463                 .setDbRefType(StructureImportSettings.MMCIF);
464       }
465       else if (format.equals("STH"))
466       {
467         alignFile = new StockholmFile(source);
468       }
469       else if (format.equals("RNAML"))
470       {
471         alignFile = new RnamlFile(source);
472       }
473       else if (format.equals("SimpleBLAST"))
474       {
475         alignFile = new SimpleBlastFile(source);
476       }
477       else if (format.equals(PhylipFile.FILE_DESC))
478       {
479         alignFile = new PhylipFile(source);
480       }
481       else if (format.equals(IdentifyFile.FeaturesFile))
482       {
483         alignFile = new FeaturesFile(inFile, type);
484       }
485       else if (format.equals(JSONFile.FILE_DESC))
486       {
487         alignFile = new JSONFile(source);
488       }
489       else if (format.equals(HtmlFile.FILE_DESC))
490       {
491         alignFile = new HtmlFile(source);
492       }
493
494       return buildAlignmentFrom(alignFile);
495
496     } catch (Exception e)
497     {
498       e.printStackTrace();
499       System.err.println("Failed to read alignment using the '" + format
500               + "' reader.\n" + e);
501
502       if (e.getMessage() != null
503               && e.getMessage().startsWith(INVALID_CHARACTERS))
504       {
505         throw new java.io.IOException(e.getMessage());
506       }
507
508       // Finally test if the user has pasted just the sequence, no id
509       if (type.equalsIgnoreCase("Paste"))
510       {
511         try
512         {
513           // Possible sequence is just residues with no label
514           alignFile = new FastaFile(">UNKNOWN\n" + inFile, "Paste");
515           return buildAlignmentFrom(alignFile);
516
517         } catch (Exception ex)
518         {
519           if (ex.toString().startsWith(INVALID_CHARACTERS))
520           {
521             throw new java.io.IOException(e.getMessage());
522           }
523
524           ex.printStackTrace();
525         }
526       }
527
528       // If we get to this stage, the format was not supported
529       throw new java.io.IOException(SUPPORTED_FORMATS);
530     }
531   }
532
533   /**
534    * boilerplate method to handle data from an AlignFile and construct a new
535    * alignment or import to an existing alignment
536    * 
537    * @param alignFile2
538    * @return AlignmentI instance ready to pass to a UI constructor
539    */
540   private AlignmentI buildAlignmentFrom(AlignFile alignFile2)
541   {
542     // Standard boilerplate for creating alignment from parser
543     // alignFile.configureForView(viewpanel);
544
545     AlignmentI al = new Alignment(alignFile.getSeqsAsArray());
546
547     alignFile.addAnnotations(al);
548
549     alignFile.addGroups(al);
550
551     return al;
552   }
553
554   /**
555    * create an alignment flatfile from a Jalview alignment view
556    * 
557    * @param format
558    * @param jvsuffix
559    * @param av
560    * @param selectedOnly
561    * @return flatfile in a string
562    */
563   public String formatSequences(String format, boolean jvsuffix,
564           AlignmentViewPanel ap, boolean selectedOnly)
565   {
566
567     AlignmentView selvew = ap.getAlignViewport().getAlignmentView(
568             selectedOnly, false);
569     AlignmentI aselview = selvew.getVisibleAlignment(ap.getAlignViewport()
570             .getGapCharacter());
571     List<AlignmentAnnotation> ala = (ap.getAlignViewport()
572             .getVisibleAlignmentAnnotation(selectedOnly));
573     if (ala != null)
574     {
575       for (AlignmentAnnotation aa : ala)
576       {
577         aselview.addAnnotation(aa);
578       }
579     }
580     viewpanel = ap;
581     return formatSequences(format, aselview, jvsuffix);
582   }
583
584   /**
585    * Construct an output class for an alignment in a particular filetype TODO:
586    * allow caller to detect errors and warnings encountered when generating
587    * output
588    *
589    * @param format
590    *          string name of alignment format
591    * @param alignment
592    *          the alignment to be written out
593    * @param jvsuffix
594    *          passed to AlnFile class controls whether /START-END is added to
595    *          sequence names
596    *
597    * @return alignment flat file contents
598    */
599   public String formatSequences(String format, AlignmentI alignment,
600           boolean jvsuffix)
601   {
602     try
603     {
604       AlignFile afile = null;
605       if (format.equalsIgnoreCase("FASTA"))
606       {
607         afile = new FastaFile();
608       }
609       else if (format.equalsIgnoreCase("MSF"))
610       {
611         afile = new MSFfile();
612       }
613       else if (format.equalsIgnoreCase("PileUp"))
614       {
615         afile = new PileUpfile();
616       }
617       else if (format.equalsIgnoreCase("CLUSTAL"))
618       {
619         afile = new ClustalFile();
620       }
621       else if (format.equalsIgnoreCase("BLC"))
622       {
623         afile = new BLCFile();
624       }
625       else if (format.equalsIgnoreCase("PIR"))
626       {
627         afile = new PIRFile();
628       }
629       else if (format.equalsIgnoreCase("PFAM"))
630       {
631         afile = new PfamFile();
632       }
633       else if (format.equalsIgnoreCase("STH"))
634       {
635         afile = new StockholmFile(alignment);
636       }
637       else if (format.equalsIgnoreCase("AMSA"))
638       {
639         afile = new AMSAFile(alignment);
640       }
641       else if (format.equalsIgnoreCase(PhylipFile.FILE_DESC))
642       {
643         afile = new PhylipFile();
644       }
645       else if (format.equalsIgnoreCase(JSONFile.FILE_DESC))
646       {
647         afile = new JSONFile();
648       }
649       else if (format.equalsIgnoreCase("RNAML"))
650       {
651         afile = new RnamlFile();
652       }
653
654       else
655       {
656         throw new Exception(
657                 MessageManager
658                         .getString("error.implementation_error_unknown_file_format_string"));
659       }
660
661       afile.setNewlineString(newline);
662       afile.addJVSuffix(jvsuffix);
663       afile.setExportSettings(exportSettings);
664       afile.configureForView(viewpanel);
665
666       // check whether we were given a specific alignment to export, rather than
667       // the one in the viewpanel
668       if (viewpanel == null || viewpanel.getAlignment() == null
669               || viewpanel.getAlignment() != alignment)
670       {
671         afile.setSeqs(alignment.getSequencesArray());
672       }
673       else
674       {
675         afile.setSeqs(viewpanel.getAlignment().getSequencesArray());
676       }
677
678       String afileresp = afile.print();
679       if (afile.hasWarningMessage())
680       {
681         System.err.println("Warning raised when writing as " + format
682                 + " : " + afile.getWarningMessage());
683       }
684       return afileresp;
685     } catch (Exception e)
686     {
687       System.err.println("Failed to write alignment as a '" + format
688               + "' file\n");
689       e.printStackTrace();
690     }
691
692     return null;
693   }
694
695   public static String checkProtocol(String file)
696   {
697     String protocol = FILE;
698     String ft = file.toLowerCase().trim();
699     if (ft.indexOf("http:") == 0 || ft.indexOf("https:") == 0
700             || ft.indexOf("file:") == 0)
701     {
702       protocol = URL;
703     }
704     return protocol;
705   }
706
707   public static void main(String[] args)
708   {
709     int i = 0;
710     while (i < args.length)
711     {
712       File f = new File(args[i]);
713       if (f.exists())
714       {
715         try
716         {
717           System.out.println("Reading file: " + f);
718           AppletFormatAdapter afa = new AppletFormatAdapter();
719           Runtime r = Runtime.getRuntime();
720           System.gc();
721           long memf = -r.totalMemory() + r.freeMemory();
722           long t1 = -System.currentTimeMillis();
723           AlignmentI al = afa.readFile(args[i], FILE,
724                   new IdentifyFile().identify(args[i], FILE));
725           t1 += System.currentTimeMillis();
726           System.gc();
727           memf += r.totalMemory() - r.freeMemory();
728           if (al != null)
729           {
730             System.out.println("Alignment contains " + al.getHeight()
731                     + " sequences and " + al.getWidth() + " columns.");
732             try
733             {
734               System.out.println(new AppletFormatAdapter().formatSequences(
735                       "FASTA", al, true));
736             } catch (Exception e)
737             {
738               System.err
739                       .println("Couln't format the alignment for output as a FASTA file.");
740               e.printStackTrace(System.err);
741             }
742           }
743           else
744           {
745             System.out.println("Couldn't read alignment");
746           }
747           System.out.println("Read took " + (t1 / 1000.0) + " seconds.");
748           System.out
749                   .println("Difference between free memory now and before is "
750                           + (memf / (1024.0 * 1024.0) * 1.0) + " MB");
751         } catch (Exception e)
752         {
753           System.err.println("Exception when dealing with " + i
754                   + "'th argument: " + args[i] + "\n" + e);
755         }
756       }
757       else
758       {
759         System.err.println("Ignoring argument '" + args[i] + "' (" + i
760                 + "'th)- not a readable file.");
761       }
762       i++;
763     }
764   }
765
766   /**
767    * try to discover how to access the given file as a valid datasource that
768    * will be identified as the given type.
769    *
770    * @param file
771    * @param format
772    * @return protocol that yields the data parsable as the given type
773    */
774   public static String resolveProtocol(String file, String format)
775   {
776     return resolveProtocol(file, format, false);
777   }
778
779   public static String resolveProtocol(String file, String format,
780           boolean debug)
781   {
782     // TODO: test thoroughly!
783     String protocol = null;
784     if (debug)
785     {
786       System.out.println("resolving datasource started with:\n>>file\n"
787               + file + ">>endfile");
788     }
789
790     // This might throw a security exception in certain browsers
791     // Netscape Communicator for instance.
792     try
793     {
794       boolean rtn = false;
795       InputStream is = System.getSecurityManager().getClass()
796               .getResourceAsStream("/" + file);
797       if (is != null)
798       {
799         rtn = true;
800         is.close();
801       }
802       if (debug)
803       {
804         System.err.println("Resource '" + file + "' was "
805                 + (rtn ? "" : "not") + " located by classloader.");
806       }
807       ;
808       if (rtn)
809       {
810         protocol = AppletFormatAdapter.CLASSLOADER;
811       }
812
813     } catch (Exception ex)
814     {
815       System.err
816               .println("Exception checking resources: " + file + " " + ex);
817     }
818
819     if (file.indexOf("://") > -1)
820     {
821       protocol = AppletFormatAdapter.URL;
822     }
823     else
824     {
825       // skipping codebase prepend check.
826       protocol = AppletFormatAdapter.FILE;
827     }
828     FileParse fp = null;
829     try
830     {
831       if (debug)
832       {
833         System.out.println("Trying to get contents of resource as "
834                 + protocol + ":");
835       }
836       fp = new FileParse(file, protocol);
837       if (!fp.isValid())
838       {
839         fp = null;
840       }
841       else
842       {
843         if (debug)
844         {
845           System.out.println("Successful.");
846         }
847       }
848     } catch (Exception e)
849     {
850       if (debug)
851       {
852         System.err.println("Exception when accessing content: " + e);
853       }
854       fp = null;
855     }
856     if (fp == null)
857     {
858       if (debug)
859       {
860         System.out.println("Accessing as paste.");
861       }
862       protocol = AppletFormatAdapter.PASTE;
863       fp = null;
864       try
865       {
866         fp = new FileParse(file, protocol);
867         if (!fp.isValid())
868         {
869           fp = null;
870         }
871       } catch (Exception e)
872       {
873         System.err.println("Failed to access content as paste!");
874         e.printStackTrace();
875         fp = null;
876       }
877     }
878     if (fp == null)
879     {
880       return null;
881     }
882     if (format == null || format.length() == 0)
883     {
884       return protocol;
885     }
886     else
887     {
888       try
889       {
890         String idformat = new jalview.io.IdentifyFile().identify(file,
891                 protocol);
892         if (idformat == null)
893         {
894           if (debug)
895           {
896             System.out.println("Format not identified. Inaccessible file.");
897           }
898           return null;
899         }
900         if (debug)
901         {
902           System.out.println("Format identified as " + idformat
903                   + "and expected as " + format);
904         }
905         if (idformat.equals(format))
906         {
907           if (debug)
908           {
909             System.out.println("Protocol identified as " + protocol);
910           }
911           return protocol;
912         }
913         else
914         {
915           if (debug)
916           {
917             System.out
918                     .println("File deemed not accessible via " + protocol);
919           }
920           fp.close();
921           return null;
922         }
923       } catch (Exception e)
924       {
925         if (debug)
926         {
927           System.err.println("File deemed not accessible via " + protocol);
928           e.printStackTrace();
929         }
930         ;
931
932       }
933     }
934     return null;
935   }
936
937   public AlignFile getAlignFile()
938   {
939     return alignFile;
940   }
941
942   public void setAlignFile(AlignFile alignFile)
943   {
944     this.alignFile = alignFile;
945   }
946 }