JAL-2089 Merge branch releases/Release_2_10_Branch to master
[jalview.git] / src / jalview / io / FormatAdapter.java
index 2735fb3..92e5810 100755 (executable)
@@ -1,24 +1,34 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Development Version 2.4.1)
- * Copyright (C) 2009 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9.0b2)
+ * Copyright (C) 2015 The Jalview Authors
  * 
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * This file is part of Jalview.
  * 
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
  * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.io;
 
-import jalview.datamodel.*;
+import jalview.api.AlignExportSettingI;
+import jalview.api.AlignmentViewPanel;
+import jalview.datamodel.Alignment;
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
 
 /**
  * Additional formatting methods used by the application in a number of places.
@@ -28,16 +38,54 @@ import jalview.datamodel.*;
  */
 public class FormatAdapter extends AppletFormatAdapter
 {
+  public FormatAdapter(AlignmentViewPanel viewpanel)
+  {
+    super(viewpanel);
+    init();
+  }
+
+  public FormatAdapter()
+  {
+    super();
+    init();
+  }
+
+  public FormatAdapter(AlignmentViewPanel alignPanel,
+          AlignExportSettingI settings)
+  {
+    super(alignPanel, settings);
+  }
+
+  private void init()
+  {
+    if (jalview.bin.Cache.getDefault("STRUCT_FROM_PDB", true))
+    {
+      annotFromStructure = jalview.bin.Cache.getDefault("ADD_TEMPFACT_ANN",
+              true);
+      localSecondaryStruct = jalview.bin.Cache.getDefault("ADD_SS_ANN",
+              true);
+      serviceSecondaryStruct = jalview.bin.Cache.getDefault("USE_RNAVIEW",
+              true);
+    }
+    else
+    {
+      // disable all PDB annotation options
+      annotFromStructure = false;
+      localSecondaryStruct = false;
+      serviceSecondaryStruct = false;
+    }
+  }
 
   public String formatSequences(String format, SequenceI[] seqs,
-          String[] omitHiddenColumns)
+          String[] omitHiddenColumns, int[] exportRange)
   {
 
-    return formatSequences(format, replaceStrings(seqs, omitHiddenColumns));
+    return formatSequences(format,
+            replaceStrings(seqs, omitHiddenColumns, exportRange));
   }
 
   /**
-   * create sequences with each seuqence string replaced with the one given in
+   * create sequences with each sequence string replaced with the one given in
    * omitHiddenCOlumns
    * 
    * @param seqs
@@ -45,15 +93,44 @@ public class FormatAdapter extends AppletFormatAdapter
    * @return new sequences
    */
   public SequenceI[] replaceStrings(SequenceI[] seqs,
-          String[] omitHiddenColumns)
+          String[] omitHiddenColumns, int[] startEnd)
   {
     if (omitHiddenColumns != null)
     {
       SequenceI[] tmp = new SequenceI[seqs.length];
+
+      int startRes;
+      int endRes;
+      int startIndex;
+      int endIndex;
       for (int i = 0; i < seqs.length; i++)
       {
+        startRes = seqs[i].getStart();
+        endRes = seqs[i].getEnd();
+        if (startEnd != null)
+        {
+          startIndex = startEnd[0];
+          endIndex = startEnd[1];
+          // get first non-gaped residue start position
+          while (jalview.util.Comparison.isGap(seqs[i]
+                  .getCharAt(startIndex)) && startIndex < endIndex)
+          {
+            startIndex++;
+          }
+
+          // get last non-gaped residue end position
+          while (jalview.util.Comparison.isGap(seqs[i].getCharAt(endIndex))
+                  && endIndex > startIndex)
+          {
+            endIndex--;
+          }
+
+          startRes = seqs[i].findPosition(startIndex);
+          endRes = seqs[i].findPosition(endIndex);
+        }
+
         tmp[i] = new Sequence(seqs[i].getName(), omitHiddenColumns[i],
-                seqs[i].getStart(), seqs[i].getEnd());
+                startRes, endRes);
         tmp[i].setDescription(seqs[i].getDescription());
       }
       seqs = tmp;
@@ -62,16 +139,15 @@ public class FormatAdapter extends AppletFormatAdapter
   }
 
   /**
-   * Format a vector of sequences as a flat alignment file.
-   * TODO: allow caller to detect errors and warnings encountered when generating output
-   *
+   * Format a vector of sequences as a flat alignment file. TODO: allow caller
+   * to detect errors and warnings encountered when generating output
+   * 
    * 
    * @param format
-   *                Format string as givien in the AppletFormatAdaptor list
-   *                (exact match to name of class implementing file io for that
-   *                format)
+   *          Format string as givien in the AppletFormatAdaptor list (exact
+   *          match to name of class implementing file io for that format)
    * @param seqs
-   *                vector of sequences to write
+   *          vector of sequences to write
    * 
    * @return String containing sequences in desired format
    */
@@ -126,8 +202,8 @@ public class FormatAdapter extends AppletFormatAdapter
       }
       /*
        * amsa is not supported by this function - it requires an alignment
-       * rather than a sequence vector else if (format.equalsIgnoreCase("AMSA")) {
-       * afile = new AMSAFile(); afile.addJVSuffix(
+       * rather than a sequence vector else if (format.equalsIgnoreCase("AMSA"))
+       * { afile = new AMSAFile(); afile.addJVSuffix(
        * jalview.bin.Cache.getDefault("AMSA_JVSUFFIX", true)); }
        */
 
@@ -135,7 +211,8 @@ public class FormatAdapter extends AppletFormatAdapter
       String afileresp = afile.print();
       if (afile.hasWarningMessage())
       {
-        System.err.println("Warning raised when writing as "+format+" : "+afile.getWarningMessage());
+        System.err.println("Warning raised when writing as " + format
+                + " : " + afile.getWarningMessage());
       }
       return afileresp;
     } catch (Exception e)
@@ -151,22 +228,25 @@ public class FormatAdapter extends AppletFormatAdapter
   public boolean getCacheSuffixDefault(String format)
   {
     if (isValidFormat(format))
+    {
       return jalview.bin.Cache.getDefault(format.toUpperCase()
               + "_JVSUFFIX", true);
+    }
     return false;
   }
 
   public String formatSequences(String format, AlignmentI alignment,
-          String[] omitHidden, ColumnSelection colSel)
+          String[] omitHidden, int[] exportRange, ColumnSelection colSel)
   {
-    return formatSequences(format, alignment, omitHidden,
+    return formatSequences(format, alignment, omitHidden, exportRange,
             getCacheSuffixDefault(format), colSel, null);
   }
 
   public String formatSequences(String format, AlignmentI alignment,
-          String[] omitHidden, ColumnSelection colSel, SequenceGroup sgp)
+          String[] omitHidden, int[] exportRange, ColumnSelection colSel,
+          SequenceGroup sgp)
   {
-    return formatSequences(format, alignment, omitHidden,
+    return formatSequences(format, alignment, omitHidden, exportRange,
             getCacheSuffixDefault(format), colSel, sgp);
   }
 
@@ -177,42 +257,48 @@ public class FormatAdapter extends AppletFormatAdapter
    * @param format
    * @param alignment
    * @param omitHidden
-   *                sequence strings to write out in order of sequences in
-   *                alignment
+   *          sequence strings to write out in order of sequences in alignment
    * @param colSel
-   *                defines hidden columns that are edited out of annotation
+   *          defines hidden columns that are edited out of annotation
    * @return string representation of the alignment formatted as format
    */
   public String formatSequences(String format, AlignmentI alignment,
-          String[] omitHidden, boolean suffix, ColumnSelection colSel)
+          String[] omitHidden, int[] exportRange, boolean suffix,
+          ColumnSelection colSel)
   {
-    return formatSequences(format, alignment, omitHidden, suffix, colSel,
-            null);
+    return formatSequences(format, alignment, omitHidden, exportRange,
+            suffix, colSel, null);
   }
 
   public String formatSequences(String format, AlignmentI alignment,
-          String[] omitHidden, boolean suffix, ColumnSelection colSel,
-          jalview.datamodel.SequenceGroup selgp)
+          String[] omitHidden, int[] exportRange, boolean suffix,
+          ColumnSelection colSel, jalview.datamodel.SequenceGroup selgp)
   {
     if (omitHidden != null)
     {
-      // 
-      Alignment alv = new Alignment(replaceStrings(alignment
-              .getSequencesArray(), omitHidden));
+      // TODO consider using AlignmentView to prune to visible region
+      // TODO prune sequence annotation and groups to visible region
+      // TODO: JAL-1486 - set start and end for output correctly. basically,
+      // AlignmentView.getVisibleContigs does this.
+      Alignment alv = new Alignment(replaceStrings(
+              alignment.getSequencesArray(), omitHidden, exportRange));
       AlignmentAnnotation[] ala = alignment.getAlignmentAnnotation();
-      for (int i = 0; i < ala.length; i++)
+      if (ala != null)
       {
-        AlignmentAnnotation na = new AlignmentAnnotation(ala[i]);
-        if (selgp != null)
-        {
-          colSel.makeVisibleAnnotation(selgp.getStartRes(), selgp
-                  .getEndRes(), na);
-        }
-        else
+        for (int i = 0; i < ala.length; i++)
         {
-          colSel.makeVisibleAnnotation(na);
+          AlignmentAnnotation na = new AlignmentAnnotation(ala[i]);
+          if (selgp != null)
+          {
+            colSel.makeVisibleAnnotation(selgp.getStartRes(),
+                    selgp.getEndRes(), na);
+          }
+          else
+          {
+            colSel.makeVisibleAnnotation(na);
+          }
+          alv.addAnnotation(na);
         }
-        alv.addAnnotation(na);
       }
       return this.formatSequences(format, alv, suffix);
     }
@@ -225,10 +311,10 @@ public class FormatAdapter extends AppletFormatAdapter
    * Application only formats like 'Jalview'.
    * 
    * @param format
-   *                a format string to be compared with list of readable or writable formats (READABLE_FORMATS
-   *                or WRITABLE_FORMATS)
+   *          a format string to be compared with list of readable or writable
+   *          formats (READABLE_FORMATS or WRITABLE_FORMATS)
    * @param forwriting
-   *                when true, format is checked against list of writable formats.
+   *          when true, format is checked against list of writable formats.
    * @return true if format is valid
    */
   public static final boolean isValidIOFormat(String format,
@@ -240,4 +326,21 @@ public class FormatAdapter extends AppletFormatAdapter
     }
     return AppletFormatAdapter.isValidFormat(format, forwriting);
   }
+
+  /**
+   * Create a flat file representation of a given view or selected region of a
+   * view
+   * 
+   * @param format
+   * @param ap
+   *          alignment panel originating the view
+   * @return String containing flat file
+   */
+  public String formatSequences(String format, AlignmentViewPanel ap,
+          boolean selectedOnly)
+  {
+    return formatSequences(format, getCacheSuffixDefault(format), ap,
+            selectedOnly);
+  }
+
 }