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