X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fio%2FAppletFormatAdapter.java;h=1a639f12e84c380c6420a09dd639ad6735a2ef17;hb=78c9bc9392dc9075972e693a1d8085676216f8d0;hp=649aad377b3db6361a279762d21b248e061c7a97;hpb=a40bbc57a85658544e2e5d7cc2a7596b762566dc;p=jalview.git

diff --git a/src/jalview/io/AppletFormatAdapter.java b/src/jalview/io/AppletFormatAdapter.java
index 649aad3..1a639f1 100755
--- a/src/jalview/io/AppletFormatAdapter.java
+++ b/src/jalview/io/AppletFormatAdapter.java
@@ -20,14 +20,17 @@
  */
 package jalview.io;
 
-import jalview.api.AlignViewportI;
+import jalview.api.AlignExportSettingI;
+import jalview.api.AlignmentViewPanel;
 import jalview.datamodel.Alignment;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.AlignmentView;
+import jalview.structure.StructureViewSettings;
 import jalview.util.MessageManager;
 
 import java.io.File;
+import java.io.IOException;
 import java.io.InputStream;
 import java.util.List;
 
@@ -42,53 +45,90 @@ import java.util.List;
  */
 public class AppletFormatAdapter
 {
+  private AlignmentViewPanel viewpanel;
+
+  public static String FILE = "File";
+
+  public static String URL = "URL";
+
+  public static String PASTE = "Paste";
+
+  public static String CLASSLOADER = "ClassLoader";
+
+  /**
+   * add jalview-derived non-secondary structure annotation from PDB structure
+   */
+  boolean annotFromStructure = false;
+
+  /**
+   * add secondary structure from PDB data with built-in algorithms
+   */
+  boolean localSecondaryStruct = false;
+
+  /**
+   * process PDB data with web services
+   */
+  boolean serviceSecondaryStruct = false;
+
+  private AlignFile alignFile = null;
+
+  String inFile;
+
+  /**
+   * character used to write newlines
+   */
+  protected String newline = System.getProperty("line.separator");
+
+  private AlignExportSettingI exportSettings;
+
   /**
    * List of valid format strings used in the isValidFormat method
    */
-  public static final String[] READABLE_FORMATS = new String[]
-  { "BLC", "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "STH",
-      "PDB", "JnetFile", "RNAML", PhylipFile.FILE_DESC, JSONFile.FILE_DESC,
-      "HTML" };
+  public static final String[] READABLE_FORMATS = new String[] { "BLC",
+      "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "STH", "PDB",
+      "JnetFile", "RNAML", PhylipFile.FILE_DESC, JSONFile.FILE_DESC,
+      IdentifyFile.FeaturesFile, "HTML", "mmCIF" };
 
   /**
    * List of readable format file extensions by application in order
    * corresponding to READABLE_FNAMES
    */
-  public static final String[] READABLE_EXTENSIONS = new String[]
-  { "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
+  public static final String[] READABLE_EXTENSIONS = new String[] {
+      "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
       "sto,stk", "xml,rnaml", PhylipFile.FILE_EXT, JSONFile.FILE_EXT,
-      "jar,jvp", "html" };
+      ".gff2,gff3", "jar,jvp", HtmlFile.FILE_EXT, "cif" };
 
   /**
    * List of readable formats by application in order corresponding to
    * READABLE_EXTENSIONS
    */
-  public static final String[] READABLE_FNAMES = new String[]
-  { "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Stockholm",
-      "RNAML", PhylipFile.FILE_DESC, JSONFile.FILE_DESC, "Jalview", "HTML" };
+  public static final String[] READABLE_FNAMES = new String[] { "Fasta",
+      "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "Stockholm", "RNAML",
+      PhylipFile.FILE_DESC, JSONFile.FILE_DESC, IdentifyFile.FeaturesFile,
+      "Jalview", HtmlFile.FILE_DESC, "mmCIF" };
 
   /**
    * List of valid format strings for use by callers of the formatSequences
    * method
    */
-  public static final String[] WRITEABLE_FORMATS = new String[]
-          { "BLC", "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "AMSA",
-    "STH", PhylipFile.FILE_DESC, JSONFile.FILE_DESC };
+  public static final String[] WRITEABLE_FORMATS = new String[] { "BLC",
+      "CLUSTAL", "FASTA", "MSF", "PileUp", "PIR", "PFAM", "AMSA", "STH",
+      PhylipFile.FILE_DESC, JSONFile.FILE_DESC };
 
   /**
    * List of extensions corresponding to file format types in WRITABLE_FNAMES
    * that are writable by the application.
    */
-  public static final String[] WRITABLE_EXTENSIONS = new String[]
-  { "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
+  public static final String[] WRITABLE_EXTENSIONS = new String[] {
+      "fa, fasta, mfa, fastq", "aln", "pfam", "msf", "pir", "blc", "amsa",
       "sto,stk", PhylipFile.FILE_EXT, JSONFile.FILE_EXT, "jvp" };
 
   /**
    * List of writable formats by the application. Order must correspond with the
    * WRITABLE_EXTENSIONS list of formats.
    */
-  public static final String[] WRITABLE_FNAMES = new String[]
-  { "Fasta", "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "STH",
+  public static final String[] WRITABLE_FNAMES = new String[] { "Fasta",
+      "Clustal", "PFAM", "MSF", "PIR", "BLC", "AMSA", "STH",
       PhylipFile.FILE_DESC, JSONFile.FILE_DESC, "Jalview" };
 
   public static String INVALID_CHARACTERS = "Contains invalid characters";
@@ -97,6 +137,22 @@ public class AppletFormatAdapter
   public static String SUPPORTED_FORMATS = "Formats currently supported are\n"
           + prettyPrint(READABLE_FORMATS);
 
+  public AppletFormatAdapter()
+  {
+  }
+
+  public AppletFormatAdapter(AlignmentViewPanel viewpanel)
+  {
+    this.viewpanel = viewpanel;
+  }
+
+  public AppletFormatAdapter(AlignmentViewPanel alignPanel,
+          AlignExportSettingI settings)
+  {
+    viewpanel = alignPanel;
+    exportSettings = settings;
+  }
+
   /**
    *
    * @param els
@@ -114,38 +170,6 @@ public class AppletFormatAdapter
     return list.toString();
   }
 
-  public static String FILE = "File";
-
-  public static String URL = "URL";
-
-  public static String PASTE = "Paste";
-
-  public static String CLASSLOADER = "ClassLoader";
-
-  /**
-   * add jalview-derived non-secondary structure annotation from PDB structure
-   */
-  boolean annotFromStructure = false;
-
-  /**
-   * add secondary structure from PDB data with built-in algorithms
-   */
-  boolean localSecondaryStruct = false;
-
-  /**
-   * process PDB data with web services
-   */
-  boolean serviceSecondaryStruct = false;
-
-  AlignFile afile = null;
-
-  String inFile;
-
-  /**
-   * character used to write newlines
-   */
-  protected String newline = System.getProperty("line.separator");
-
   public void setNewlineString(String nl)
   {
     newline = nl;
@@ -181,6 +205,10 @@ public class AppletFormatAdapter
   public static final boolean isValidFormat(String format,
           boolean forwriting)
   {
+    if (format == null)
+    {
+      return false;
+    }
     boolean valid = false;
     String[] format_list = (forwriting) ? WRITEABLE_FORMATS
             : READABLE_FORMATS;
@@ -207,7 +235,7 @@ public class AppletFormatAdapter
    *
    * @return DOCUMENT ME!
    */
-  public Alignment readFile(String inFile, String type, String format)
+  public AlignmentI readFile(String inFile, String type, String format)
           throws java.io.IOException
   {
     // TODO: generalise mapping between format string and io. class instances
@@ -217,71 +245,94 @@ public class AppletFormatAdapter
     {
       if (format.equals("FASTA"))
       {
-        afile = new FastaFile(inFile, type);
+        alignFile = new FastaFile(inFile, type);
       }
       else if (format.equals("MSF"))
       {
-        afile = new MSFfile(inFile, type);
+        alignFile = new MSFfile(inFile, type);
       }
       else if (format.equals("PileUp"))
       {
-        afile = new PileUpfile(inFile, type);
+        alignFile = new PileUpfile(inFile, type);
       }
       else if (format.equals("CLUSTAL"))
       {
-        afile = new ClustalFile(inFile, type);
+        alignFile = new ClustalFile(inFile, type);
       }
       else if (format.equals("BLC"))
       {
-        afile = new BLCFile(inFile, type);
+        alignFile = new BLCFile(inFile, type);
       }
       else if (format.equals("PIR"))
       {
-        afile = new PIRFile(inFile, type);
+        alignFile = new PIRFile(inFile, type);
       }
       else if (format.equals("PFAM"))
       {
-        afile = new PfamFile(inFile, type);
+        alignFile = new PfamFile(inFile, type);
       }
       else if (format.equals("JnetFile"))
       {
-        afile = new JPredFile(inFile, type);
-        ((JPredFile) afile).removeNonSequences();
+        alignFile = new JPredFile(inFile, type);
+        ((JPredFile) alignFile).removeNonSequences();
       }
       else if (format.equals("PDB"))
       {
-        afile = new MCview.PDBfile(annotFromStructure,
+        // TODO obtain config value from preference settings.
+        // Set value to 'true' to test PDB processing with Jmol: JAL-1213
+        boolean isParseWithJMOL = false;
+        if (isParseWithJMOL)
+        {
+          StructureViewSettings.addSettings(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct);
+          alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct, inFile,
+                  type);
+        }
+        else
+        {
+          StructureViewSettings.setShowSeqFeatures(true);
+          alignFile = new MCview.PDBfile(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct, inFile,
+                  type);
+        }
+      }
+      else if (format.equals("mmCIF"))
+      {
+        StructureViewSettings.addSettings(annotFromStructure,
+                localSecondaryStruct, serviceSecondaryStruct);
+        alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
                 localSecondaryStruct, serviceSecondaryStruct, inFile, type);
-        // Uncomment to test Jmol data based PDB processing: JAL-1213
-        // afile = new jalview.ext.jmol.PDBFileWithJmol(inFile, type);
       }
       else if (format.equals("STH"))
       {
-        afile = new StockholmFile(inFile, type);
+        alignFile = new StockholmFile(inFile, type);
       }
       else if (format.equals("SimpleBLAST"))
       {
-        afile = new SimpleBlastFile(inFile, type);
+        alignFile = new SimpleBlastFile(inFile, type);
       }
       else if (format.equals(PhylipFile.FILE_DESC))
       {
-        afile = new PhylipFile(inFile, type);
+        alignFile = new PhylipFile(inFile, type);
+      }
+      else if (format.equals(JSONFile.FILE_DESC))
+      {
+        alignFile = new JSONFile(inFile, type);
+      }
+      else if (format.equals(HtmlFile.FILE_DESC))
+      {
+        alignFile = new HtmlFile(inFile, type);
       }
-       else if (format.equals(JSONFile.FILE_DESC))
-       {
-       afile = new JSONFile(inFile, type);
-       }
       else if (format.equals("RNAML"))
       {
-        afile = new RnamlFile(inFile, type);
+        alignFile = new RnamlFile(inFile, type);
       }
-
-      Alignment al = new Alignment(afile.getSeqsAsArray());
-
-      afile.addAnnotations(al);
-      afile.addSeqGroups(al);
-
-      return al;
+      else if (format.equals(IdentifyFile.FeaturesFile))
+      {
+        alignFile = new FeaturesFile(true, inFile, type);
+      }
+      return buildAlignmentFrom(alignFile);
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -300,12 +351,8 @@ public class AppletFormatAdapter
         try
         {
           // Possible sequence is just residues with no label
-          afile = new FastaFile(">UNKNOWN\n" + inFile, "Paste");
-          Alignment al = new Alignment(afile.getSeqsAsArray());
-
-          afile.addSeqGroups(al);
-          afile.addAnnotations(al);
-          return al;
+          alignFile = new FastaFile(">UNKNOWN\n" + inFile, "Paste");
+          return buildAlignmentFrom(alignFile);
 
         } catch (Exception ex)
         {
@@ -317,7 +364,10 @@ public class AppletFormatAdapter
           ex.printStackTrace();
         }
       }
-
+      if (format.equalsIgnoreCase("HTML"))
+      {
+        throw new IOException(e.getMessage());
+      }
       // If we get to this stage, the format was not supported
       throw new java.io.IOException(SUPPORTED_FORMATS);
     }
@@ -346,68 +396,93 @@ public class AppletFormatAdapter
     {
       if (format.equals("FASTA"))
       {
-        afile = new FastaFile(source);
+        alignFile = new FastaFile(source);
       }
       else if (format.equals("MSF"))
       {
-        afile = new MSFfile(source);
+        alignFile = new MSFfile(source);
       }
       else if (format.equals("PileUp"))
       {
-        afile = new PileUpfile(source);
+        alignFile = new PileUpfile(source);
       }
       else if (format.equals("CLUSTAL"))
       {
-        afile = new ClustalFile(source);
+        alignFile = new ClustalFile(source);
       }
       else if (format.equals("BLC"))
       {
-        afile = new BLCFile(source);
+        alignFile = new BLCFile(source);
       }
       else if (format.equals("PIR"))
       {
-        afile = new PIRFile(source);
+        alignFile = new PIRFile(source);
       }
       else if (format.equals("PFAM"))
       {
-        afile = new PfamFile(source);
+        alignFile = new PfamFile(source);
       }
       else if (format.equals("JnetFile"))
       {
-        afile = new JPredFile(source);
-        ((JPredFile) afile).removeNonSequences();
+        alignFile = new JPredFile(source);
+        ((JPredFile) alignFile).removeNonSequences();
       }
       else if (format.equals("PDB"))
       {
-        afile = new MCview.PDBfile(annotFromStructure,
+        // TODO obtain config value from preference settings
+        boolean isParseWithJMOL = false;
+        if (isParseWithJMOL)
+        {
+          StructureViewSettings.addSettings(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct);
+          alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct, source);
+        }
+        else
+        {
+          StructureViewSettings.setShowSeqFeatures(true);
+          alignFile = new MCview.PDBfile(annotFromStructure,
+                  localSecondaryStruct, serviceSecondaryStruct, source);
+        }
+      }
+      else if (format.equals("mmCIF"))
+      {
+        StructureViewSettings.addSettings(annotFromStructure,
+                localSecondaryStruct, serviceSecondaryStruct);
+        alignFile = new jalview.ext.jmol.JmolParser(annotFromStructure,
                 localSecondaryStruct, serviceSecondaryStruct, source);
       }
       else if (format.equals("STH"))
       {
-        afile = new StockholmFile(source);
+        alignFile = new StockholmFile(source);
       }
       else if (format.equals("RNAML"))
       {
-        afile = new RnamlFile(source);
+        alignFile = new RnamlFile(source);
       }
       else if (format.equals("SimpleBLAST"))
       {
-        afile = new SimpleBlastFile(source);
+        alignFile = new SimpleBlastFile(source);
       }
       else if (format.equals(PhylipFile.FILE_DESC))
       {
-        afile = new PhylipFile(source);
+        alignFile = new PhylipFile(source);
+      }
+      else if (format.equals(IdentifyFile.FeaturesFile))
+      {
+        alignFile = new FeaturesFile(inFile, type);
+      }
+      else if (format.equals(JSONFile.FILE_DESC))
+      {
+        alignFile = new JSONFile(source);
+      }
+      else if (format.equals(HtmlFile.FILE_DESC))
+      {
+        alignFile = new HtmlFile(source);
       }
-       else if (format.equals(JSONFile.FILE_DESC))
-       {
-       afile = new JSONFile(source);
-       }
-      Alignment al = new Alignment(afile.getSeqsAsArray());
 
-      afile.addAnnotations(al);
-      afile.addSeqGroups(al);
+      return buildAlignmentFrom(alignFile);
 
-      return al;
     } catch (Exception e)
     {
       e.printStackTrace();
@@ -426,11 +501,8 @@ public class AppletFormatAdapter
         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);
-          afile.addSeqGroups(al);
-          return al;
+          alignFile = new FastaFile(">UNKNOWN\n" + inFile, "Paste");
+          return buildAlignmentFrom(alignFile);
 
         } catch (Exception ex)
         {
@@ -448,9 +520,30 @@ public class AppletFormatAdapter
     }
   }
 
+  /**
+   * boilerplate method to handle data from an AlignFile and construct a new
+   * alignment or import to an existing alignment
+   * 
+   * @param alignFile2
+   * @return AlignmentI instance ready to pass to a UI constructor
+   */
+  private AlignmentI buildAlignmentFrom(AlignFile alignFile2)
+  {
+    // 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
@@ -458,13 +551,14 @@ public class AppletFormatAdapter
    * @return flatfile in a string
    */
   public String formatSequences(String format, boolean jvsuffix,
-          AlignViewportI av, boolean selectedOnly)
+          AlignmentViewPanel ap, boolean selectedOnly)
   {
 
-    AlignmentView selvew = av.getAlignmentView(selectedOnly, false);
-    AlignmentI aselview = selvew.getVisibleAlignment(av
+    AlignmentView selvew = ap.getAlignViewport().getAlignmentView(
+            selectedOnly, false);
+    AlignmentI aselview = selvew.getVisibleAlignment(ap.getAlignViewport()
             .getGapCharacter());
-    List<AlignmentAnnotation> ala = (av
+    List<AlignmentAnnotation> ala = (ap.getAlignViewport()
             .getVisibleAlignmentAnnotation(selectedOnly));
     if (ala != null)
     {
@@ -473,7 +567,7 @@ public class AppletFormatAdapter
         aselview.addAnnotation(aa);
       }
     }
-
+    viewpanel = ap;
     return formatSequences(format, aselview, jvsuffix);
   }
 
@@ -538,25 +632,10 @@ public class AppletFormatAdapter
       {
         afile = new PhylipFile();
       }
-       else if (format.equalsIgnoreCase(JSONFile.FILE_DESC))
-       {
+      else if (format.equalsIgnoreCase(JSONFile.FILE_DESC))
+      {
         afile = new JSONFile();
-        // Add groups to AlignFile
-        afile.seqGroups = alignment.getGroups();
-
-        // Add non auto calculated annotation to AlignFile
-        for (AlignmentAnnotation annot : alignment.getAlignmentAnnotation())
-        {
-          if (annot != null && !annot.autoCalculated)
-          {
-            if (annot.label.equals("PDB.CATempFactor"))
-            {
-              continue;
-            }
-            afile.annotations.add(annot);
-          }
-        }
-       }
+      }
       else if (format.equalsIgnoreCase("RNAML"))
       {
         afile = new RnamlFile();
@@ -564,13 +643,27 @@ public class AppletFormatAdapter
 
       else
       {
-        throw new Exception(MessageManager.getString("error.implementation_error_unknown_file_format_string"));
+        throw new Exception(
+                MessageManager
+                        .getString("error.implementation_error_unknown_file_format_string"));
       }
+
       afile.setNewlineString(newline);
       afile.addJVSuffix(jvsuffix);
+      afile.setExportSettings(exportSettings);
+      afile.configureForView(viewpanel);
 
-      afile.setSeqs(alignment.getSequencesArray());
-
+      // check whether we were given a specific alignment to export, rather than
+      // the one in the viewpanel
+      if (viewpanel == null || viewpanel.getAlignment() == null
+              || viewpanel.getAlignment() != alignment)
+      {
+        afile.setSeqs(alignment.getSequencesArray());
+      }
+      else
+      {
+        afile.setSeqs(viewpanel.getAlignment().getSequencesArray());
+      }
 
       String afileresp = afile.print();
       if (afile.hasWarningMessage())
@@ -617,8 +710,8 @@ public class AppletFormatAdapter
           System.gc();
           long memf = -r.totalMemory() + r.freeMemory();
           long t1 = -System.currentTimeMillis();
-          Alignment al = afa.readFile(args[i], FILE,
-                  new IdentifyFile().Identify(args[i], FILE));
+          AlignmentI al = afa.readFile(args[i], FILE,
+                  new IdentifyFile().identify(args[i], FILE));
           t1 += System.currentTimeMillis();
           System.gc();
           memf += r.totalMemory() - r.freeMemory();
@@ -633,7 +726,7 @@ public class AppletFormatAdapter
             } catch (Exception e)
             {
               System.err
-              .println("Couln't format the alignment for output as a FASTA file.");
+                      .println("Couln't format the alignment for output as a FASTA file.");
               e.printStackTrace(System.err);
             }
           }
@@ -643,8 +736,8 @@ public class AppletFormatAdapter
           }
           System.out.println("Read took " + (t1 / 1000.0) + " seconds.");
           System.out
-          .println("Difference between free memory now and before is "
-                  + (memf / (1024.0 * 1024.0) * 1.0) + " MB");
+                  .println("Difference between free memory now and before is "
+                          + (memf / (1024.0 * 1024.0) * 1.0) + " MB");
         } catch (Exception e)
         {
           System.err.println("Exception when dealing with " + i
@@ -710,7 +803,7 @@ public class AppletFormatAdapter
     } catch (Exception ex)
     {
       System.err
-      .println("Exception checking resources: " + file + " " + ex);
+              .println("Exception checking resources: " + file + " " + ex);
     }
 
     if (file.indexOf("://") > -1)
@@ -784,7 +877,7 @@ public class AppletFormatAdapter
     {
       try
       {
-        String idformat = new jalview.io.IdentifyFile().Identify(file,
+        String idformat = new jalview.io.IdentifyFile().identify(file,
                 protocol);
         if (idformat == null)
         {
@@ -812,7 +905,7 @@ public class AppletFormatAdapter
           if (debug)
           {
             System.out
-            .println("File deemed not accessible via " + protocol);
+                    .println("File deemed not accessible via " + protocol);
           }
           fp.close();
           return null;
@@ -830,4 +923,14 @@ public class AppletFormatAdapter
     }
     return null;
   }
+
+  public AlignFile getAlignFile()
+  {
+    return alignFile;
+  }
+
+  public void setAlignFile(AlignFile alignFile)
+  {
+    this.alignFile = alignFile;
+  }
 }