updated to jalview 2.1 and begun ArchiveClient/VamsasClient/VamsasStore updates.
[jalview.git] / src / jalview / datamodel / SequenceGroup.java
index 6f6850b..7bb8ce0 100755 (executable)
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer\r
- * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
- *\r
- * This program is free software; you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License\r
- * as published by the Free Software Foundation; either version 2\r
- * of the License, or (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with this program; if not, write to the Free Software\r
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
- */\r
-package jalview.datamodel;\r
-\r
-import jalview.analysis.*;\r
-\r
-import jalview.datamodel.*;\r
-\r
-import jalview.schemes.*;\r
-\r
-import java.awt.*;\r
-\r
-import java.util.Vector;\r
-\r
-public class SequenceGroup\r
-{\r
-  String groupName;\r
-  Conservation conserve;\r
-  Vector aaFrequency;\r
-  boolean displayBoxes;\r
-  boolean displayText;\r
-  boolean colourText;\r
-  public Vector sequences = new Vector();\r
-  int width = -1;\r
-  public ColourSchemeI cs;\r
-  int startRes = 0;\r
-  int endRes = 0;\r
-  Color outlineColour = Color.black;\r
-\r
-  public SequenceGroup()\r
-  {\r
-    groupName = "Group";\r
-    this.displayBoxes = true;\r
-    this.displayText = true;\r
-    this.colourText = false;\r
-    cs = null;\r
-  }\r
-\r
-  public SequenceGroup(Vector sequences, String groupName, ColourSchemeI scheme,\r
-                       boolean displayBoxes, boolean displayText,\r
-                       boolean colourText,\r
-                       int start, int end)\r
-  {\r
-    this.sequences = sequences;\r
-    this.groupName = groupName;\r
-    this.displayBoxes = displayBoxes;\r
-    this.displayText = displayText;\r
-    this.colourText = colourText;\r
-    this.cs = scheme;\r
-    startRes = start;\r
-    endRes = end;\r
-    recalcConservation();\r
-  }\r
-\r
-  public SequenceGroup(String groupName, ColourSchemeI scheme,\r
-                       boolean displayBoxes, boolean displayText,\r
-                       boolean colourText,\r
-                       int start, int end)\r
-  {\r
-    this.groupName = groupName;\r
-    this.displayBoxes = displayBoxes;\r
-    this.displayText = displayText;\r
-    this.colourText = colourText;\r
-    this.cs = scheme;\r
-    startRes = start;\r
-    endRes = end;\r
-  }\r
-\r
-  public boolean adjustForRemoveLeft(int col)\r
-  {\r
-    // return value is true if the group still exists\r
-    if (startRes >= col)\r
-    {\r
-      startRes = startRes - col;\r
-    }\r
-\r
-    if (endRes >= col)\r
-    {\r
-      endRes = endRes - col;\r
-\r
-      if (startRes > endRes)\r
-      {\r
-        startRes = 0;\r
-      }\r
-    }\r
-    else\r
-    {\r
-      // must delete this group!!\r
-      return false;\r
-    }\r
-\r
-    return true;\r
-  }\r
-\r
-  public boolean adjustForRemoveRight(int col)\r
-  {\r
-    if (startRes > col)\r
-    {\r
-      // delete this group\r
-      return false;\r
-    }\r
-\r
-    if (endRes >= col)\r
-    {\r
-      endRes = col;\r
-    }\r
-\r
-    return true;\r
-  }\r
-\r
-  public String getName()\r
-  {\r
-    return groupName;\r
-  }\r
-\r
-  public void setName(String name)\r
-  {\r
-    groupName = name;\r
-  }\r
-\r
-  public Conservation getConservation()\r
-  {\r
-    return conserve;\r
-  }\r
-\r
-  public void setConservation(Conservation c)\r
-  {\r
-    conserve = c;\r
-  }\r
-\r
-  public void addSequence(SequenceI s, boolean recalc)\r
-  {\r
-    if (!sequences.contains(s))\r
-      sequences.addElement(s);\r
-\r
-    if(recalc)\r
-      recalcConservation();\r
-  }\r
-\r
-\r
-  public void recalcConservation()\r
-  {\r
-    if (cs != null)\r
-    {\r
-      cs.setConsensus(AAFrequency.calculate(sequences, 0, getWidth()));\r
-    }\r
-\r
-    if (cs instanceof ClustalxColourScheme)\r
-    {\r
-      ( (ClustalxColourScheme) cs).resetClustalX(sequences,getWidth());\r
-    }\r
-\r
-\r
-    if ( cs  instanceof ConservationColourScheme)\r
-    {\r
-      Conservation c = new Conservation(groupName,\r
-                                        ResidueProperties.propHash, 3, sequences,\r
-                                        0, getWidth());\r
-      c.calculate();\r
-      c.verdict(false, 25);\r
-\r
-      ConservationColourScheme ccs = (ConservationColourScheme) cs;\r
-      ccs.conserve = c;\r
-      if (ccs.cs instanceof ClustalxColourScheme)\r
-      {\r
-        ( (ClustalxColourScheme) ccs.cs).resetClustalX(sequences, getWidth());\r
-      }\r
-\r
-    }\r
-  }\r
-\r
-  public void addOrRemove(SequenceI s, boolean recalc)\r
-  {\r
-    if (sequences.contains(s))\r
-    {\r
-      deleteSequence(s, recalc);\r
-    }\r
-    else\r
-    {\r
-      addSequence(s, recalc);\r
-    }\r
-  }\r
-\r
-  public void deleteSequence(SequenceI s, boolean recalc)\r
-  {\r
-    sequences.removeElement(s);\r
-    if(recalc)\r
-      recalcConservation();\r
-  }\r
-\r
-  public int getStartRes()\r
-  {\r
-    return startRes;\r
-  }\r
-\r
-  public int getEndRes()\r
-  {\r
-    return endRes;\r
-  }\r
-\r
-  public void setStartRes(int i)\r
-  {\r
-    startRes = i;\r
-  }\r
-\r
-  public void setEndRes(int i)\r
-  {\r
-    endRes = i;\r
-  }\r
-\r
-  public int getSize()\r
-  {\r
-    return sequences.size();\r
-  }\r
-\r
-  public SequenceI getSequenceAt(int i)\r
-  {\r
-    return (SequenceI) sequences.elementAt(i);\r
-  }\r
-\r
-  public void setColourText(boolean state)\r
-  {\r
-    colourText = state;\r
-  }\r
-\r
-  public boolean getColourText()\r
-  {\r
-    return colourText;\r
-  }\r
-\r
-  public void setDisplayText(boolean state)\r
-  {\r
-    displayText = state;\r
-  }\r
-\r
-  public boolean getDisplayText()\r
-  {\r
-    return displayText;\r
-  }\r
-\r
-  public void setDisplayBoxes(boolean state)\r
-  {\r
-    displayBoxes = state;\r
-  }\r
-\r
-  public boolean getDisplayBoxes()\r
-  {\r
-    return displayBoxes;\r
-  }\r
-\r
-  public int getWidth()\r
-  {\r
-    // MC This needs to get reset when characters are inserted and deleted\r
-    if (sequences.size() > 0)\r
-    {\r
-      width = ( (SequenceI) sequences.elementAt(0)).getLength();\r
-    }\r
-\r
-    for (int i = 1; i < sequences.size(); i++)\r
-    {\r
-      SequenceI seq = (SequenceI) sequences.elementAt(i);\r
-\r
-      if (seq.getLength() > width)\r
-      {\r
-        width = seq.getLength();\r
-      }\r
-    }\r
-\r
-    return width;\r
-  }\r
-\r
-  public void setOutlineColour(Color c)\r
-  {\r
-    outlineColour = c;\r
-  }\r
-\r
-  public Color getOutlineColour()\r
-  {\r
-    return outlineColour;\r
-  }\r
-\r
-  /**\r
-   *\r
-   * returns the sequences in the group ordered by the ordering given by al\r
-   *\r
-   * @param al Alignment\r
-   * @return SequenceI[]\r
-   */\r
-  public SequenceI[] getSequencesInOrder(Alignment al)\r
-  {\r
-    int sz;\r
-    java.util.Hashtable orderedSeqs = new java.util.Hashtable();\r
-    SequenceI[] seqs = new SequenceI[sz = sequences.size()];\r
-\r
-    for (int i = 0; i < sz; i++)\r
-    {\r
-      SequenceI seq = (SequenceI) sequences.elementAt(i);\r
-      int index = al.findIndex(seq);\r
-      orderedSeqs.put(index + "", seq);\r
-    }\r
-\r
-    int index = 0;\r
-\r
-    for (int i = 0; i < sz; i++)\r
-    {\r
-      SequenceI seq = null;\r
-\r
-      while (seq == null)\r
-      {\r
-        if (orderedSeqs.containsKey(index + ""))\r
-        {\r
-          seq = (SequenceI) orderedSeqs.get(index + "");\r
-          index++;\r
-\r
-          break;\r
-        }\r
-        else\r
-        {\r
-          index++;\r
-        }\r
-      }\r
-\r
-      seqs[index] = seq;\r
-    }\r
-\r
-    return seqs;\r
-  }\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * 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 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.
+ *
+ * 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
+ */
+package jalview.datamodel;
+
+import jalview.analysis.*;
+
+import jalview.schemes.*;
+
+import java.awt.*;
+
+import java.util.*;
+
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class SequenceGroup
+{
+    String groupName;
+    Conservation conserve;
+    Vector aaFrequency;
+    boolean displayBoxes;
+    boolean displayText;
+    boolean colourText;
+    private Vector sequences = new Vector();
+    int width = -1;
+
+    /** DOCUMENT ME!! */
+    public ColourSchemeI cs;
+    int startRes = 0;
+    int endRes = 0;
+    Color outlineColour = Color.black;
+
+    /**
+     * Creates a new SequenceGroup object.
+     */
+    public SequenceGroup()
+    {
+        groupName = "Group";
+        this.displayBoxes = true;
+        this.displayText = true;
+        this.colourText = false;
+        cs = null;
+    }
+
+    /**
+     * Creates a new SequenceGroup object.
+     *
+     * @param sequences DOCUMENT ME!
+     * @param groupName DOCUMENT ME!
+     * @param scheme DOCUMENT ME!
+     * @param displayBoxes DOCUMENT ME!
+     * @param displayText DOCUMENT ME!
+     * @param colourText DOCUMENT ME!
+     * @param start DOCUMENT ME!
+     * @param end DOCUMENT ME!
+     */
+    public SequenceGroup(Vector sequences, String groupName,
+        ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
+        boolean colourText, int start, int end)
+    {
+        this.sequences = sequences;
+        this.groupName = groupName;
+        this.displayBoxes = displayBoxes;
+        this.displayText = displayText;
+        this.colourText = colourText;
+        this.cs = scheme;
+        startRes = start;
+        endRes = end;
+        recalcConservation();
+    }
+
+    /**
+     * Creates a new SequenceGroup object.
+     *
+     * @param groupName DOCUMENT ME!
+     * @param scheme DOCUMENT ME!
+     * @param displayBoxes DOCUMENT ME!
+     * @param displayText DOCUMENT ME!
+     * @param colourText DOCUMENT ME!
+     * @param start DOCUMENT ME!
+     * @param end DOCUMENT ME!
+     */
+    public SequenceGroup(String groupName, ColourSchemeI scheme,
+        boolean displayBoxes, boolean displayText, boolean colourText,
+        int start, int end)
+    {
+        this.groupName = groupName;
+        this.displayBoxes = displayBoxes;
+        this.displayText = displayText;
+        this.colourText = colourText;
+        this.cs = scheme;
+        startRes = start;
+        endRes = end;
+    }
+
+    public SequenceI [] getSelectionAsNewSequences(AlignmentI align)
+    {
+      int iSize = sequences.size();
+      SequenceI [] seqs = new SequenceI[iSize];
+      SequenceI [] inorder = getSequencesInOrder(align);
+
+    char ch;
+    int sres, eres;
+
+    for (int i = 0; i < iSize; i++)
+    {
+      SequenceI seq = inorder[i];
+
+      //FIND START RES
+      //Returns residue following index if gap
+      sres = seq.findPosition(startRes);
+
+      //FIND END RES
+      //Need to find the residue preceeding index if gap
+      eres = 0;
+
+      for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)
+      {
+        ch = seq.getCharAt(j);
+        if (!jalview.util.Comparison.isGap( (ch)))
+        {
+          eres++;
+        }
+      }
+
+      if (eres > 0)
+      {
+        eres += seq.getStart() - 1;
+      }
+
+      seqs[i] = new Sequence(seq.getName(),
+                             seq.getSequence(startRes, endRes + 1),
+                             sres,
+                             eres);
+      seqs[i].setDescription(seq.getDescription());
+      seqs[i].setDBRef(seq.getDBRef());
+      seqs[i].setSequenceFeatures(seq.getSequenceFeatures());
+      if (seq.getDatasetSequence() != null)
+        seqs[i].setDatasetSequence(seq.getDatasetSequence());
+
+      if(seq.getAnnotation()!=null)
+      {
+        for(int a=0; a<seq.getAnnotation().length; a++)
+          seqs[i].addAlignmentAnnotation(seq.getAnnotation()[a]);
+      }
+    }
+
+    return seqs;
+
+    }
+
+    public Vector getSequences(boolean includeHidden)
+    {
+      if(!includeHidden)
+        return sequences;
+      else
+      {
+        Vector allSequences = new Vector();
+        SequenceI seq;
+        for (int i = 0; i < sequences.size(); i++)
+        {
+          seq = (SequenceI) sequences.elementAt(i);
+          allSequences.addElement(seq);
+          if (seq.getHiddenSequences() != null)
+          {
+            for (int h = 0; h < seq.getHiddenSequences().getSize(false); h++)
+            {
+              allSequences.addElement(
+                  seq.getHiddenSequences().getSequenceAt(h)
+                  );
+            }
+          }
+        }
+
+        return allSequences;
+      }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param col DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean adjustForRemoveLeft(int col)
+    {
+        // return value is true if the group still exists
+        if (startRes >= col)
+        {
+            startRes = startRes - col;
+        }
+
+        if (endRes >= col)
+        {
+            endRes = endRes - col;
+
+            if (startRes > endRes)
+            {
+                startRes = 0;
+            }
+        }
+        else
+        {
+            // must delete this group!!
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param col DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean adjustForRemoveRight(int col)
+    {
+        if (startRes > col)
+        {
+            // delete this group
+            return false;
+        }
+
+        if (endRes >= col)
+        {
+            endRes = col;
+        }
+
+        return true;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public String getName()
+    {
+        return groupName;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param name DOCUMENT ME!
+     */
+    public void setName(String name)
+    {
+        groupName = name;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Conservation getConservation()
+    {
+        return conserve;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param c DOCUMENT ME!
+     */
+    public void setConservation(Conservation c)
+    {
+        conserve = c;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param s DOCUMENT ME!
+     * @param recalc DOCUMENT ME!
+     */
+    public void addSequence(SequenceI s, boolean recalc)
+    {
+        if (!sequences.contains(s))
+        {
+            sequences.addElement(s);
+        }
+
+        if (recalc)
+        {
+            recalcConservation();
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     */
+    public void recalcConservation()
+    {
+        if(cs == null)
+          return;
+
+        try
+        {
+          cs.setConsensus(AAFrequency.calculate(sequences, 0, getWidth()));
+
+          if (cs instanceof ClustalxColourScheme)
+          {
+            ( (ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());
+          }
+
+          if (cs.conservationApplied())
+          {
+            Conservation c = new Conservation(groupName,
+                                              ResidueProperties.propHash, 3, sequences,
+                                              0, getWidth());
+            c.calculate();
+            c.verdict(false, 25);
+
+            cs.setConservation(c);
+
+            if (cs instanceof ClustalxColourScheme)
+            {
+              ( (ClustalxColourScheme) cs).resetClustalX(sequences,
+                                                         getWidth());
+            }
+          }
+        }
+        catch (java.lang.OutOfMemoryError err)
+        {
+          System.out.println("Out of memory loading groups: " + err);
+        }
+
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param s DOCUMENT ME!
+     * @param recalc DOCUMENT ME!
+     */
+    public void addOrRemove(SequenceI s, boolean recalc)
+    {
+        if (sequences.contains(s))
+        {
+            deleteSequence(s, recalc);
+        }
+        else
+        {
+            addSequence(s, recalc);
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param s DOCUMENT ME!
+     * @param recalc DOCUMENT ME!
+     */
+    public void deleteSequence(SequenceI s, boolean recalc)
+    {
+        sequences.removeElement(s);
+
+        if (recalc)
+        {
+            recalcConservation();
+        }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getStartRes()
+    {
+        return startRes;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getEndRes()
+    {
+        return endRes;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     */
+    public void setStartRes(int i)
+    {
+        startRes = i;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     */
+    public void setEndRes(int i)
+    {
+        endRes = i;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getSize(boolean includeHidden)
+    {
+      if(!includeHidden)
+        return sequences.size();
+      else
+      {
+        int total = sequences.size();
+        SequenceI seq;
+        for (int i = 0; i < sequences.size(); i++)
+        {
+          seq = (SequenceI) sequences.elementAt(i);
+          if (seq.getHiddenSequences() != null)
+          {
+            total += seq.getHiddenSequences().getSize(false);
+          }
+        }
+        return total;
+      }
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param i DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public SequenceI getSequenceAt(int i)
+    {
+        return (SequenceI) sequences.elementAt(i);
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param state DOCUMENT ME!
+     */
+    public void setColourText(boolean state)
+    {
+        colourText = state;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean getColourText()
+    {
+        return colourText;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param state DOCUMENT ME!
+     */
+    public void setDisplayText(boolean state)
+    {
+        displayText = state;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean getDisplayText()
+    {
+        return displayText;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param state DOCUMENT ME!
+     */
+    public void setDisplayBoxes(boolean state)
+    {
+        displayBoxes = state;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public boolean getDisplayBoxes()
+    {
+        return displayBoxes;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public int getWidth()
+    {
+        // MC This needs to get reset when characters are inserted and deleted
+        if (sequences.size() > 0)
+        {
+            width = ((SequenceI) sequences.elementAt(0)).getLength();
+        }
+
+        for (int i = 1; i < sequences.size(); i++)
+        {
+            SequenceI seq = (SequenceI) sequences.elementAt(i);
+
+            if (seq.getLength() > width)
+            {
+                width = seq.getLength();
+            }
+        }
+
+        return width;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @param c DOCUMENT ME!
+     */
+    public void setOutlineColour(Color c)
+    {
+        outlineColour = c;
+    }
+
+    /**
+     * DOCUMENT ME!
+     *
+     * @return DOCUMENT ME!
+     */
+    public Color getOutlineColour()
+    {
+        return outlineColour;
+    }
+
+    /**
+     *
+     * returns the sequences in the group ordered by the ordering given by al
+     *
+     * @param al Alignment
+     * @return SequenceI[]
+     */
+    public SequenceI[] getSequencesInOrder(AlignmentI al)
+    {
+        int sz = sequences.size();
+        java.util.Hashtable orderedSeqs = new java.util.Hashtable();
+        SequenceI[] seqs = new SequenceI[sz];
+
+        for (int i = 0; i < sz; i++)
+        {
+            SequenceI seq = (SequenceI) sequences.elementAt(i);
+            int index = al.findIndex(seq);
+            orderedSeqs.put(index + "", seq);
+        }
+
+        int index = 0;
+
+        for (int i = 0; i < al.getHeight(); i++)
+        {
+            if (orderedSeqs.containsKey(i + ""))
+            {
+                seqs[index++] = (SequenceI) orderedSeqs.get(i + "");
+            }
+        }
+
+        return seqs;
+    }
+}