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