javadoc typo
[jalview.git] / src / jalview / datamodel / SequenceGroup.java
index 051db30..e22042c 100755 (executable)
+/*\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2007 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.schemes.*;\r
+import java.util.*;\r
+\r
+import java.awt.*;\r
+\r
 import jalview.analysis.*;\r
-import jalview.datamodel.*;\r
-import java.util.Vector;\r
+import jalview.schemes.*;\r
 \r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
 public class SequenceGroup\r
 {\r
   String groupName;\r
-  boolean isSelected;\r
-  boolean displayBoxes;\r
-  boolean displayText;\r
-  boolean colourText;\r
-  boolean display;\r
+  String description;\r
   Conservation conserve;\r
   Vector aaFrequency;\r
-  boolean aaFrequencyValid = false;\r
-  public Vector sequences = new Vector();\r
+  boolean displayBoxes = true;\r
+  boolean displayText = true;\r
+  boolean colourText = true;\r
+  private Vector sequences = new Vector();\r
   int width = -1;\r
+\r
+  /** DOCUMENT ME!! */\r
   public ColourSchemeI cs;\r
-  int startRes = 20;\r
-  int endRes = 35;\r
+  int startRes = 0;\r
+  int endRes = 0;\r
+  Color outlineColour = Color.black;\r
+  public int thresholdTextColour = 0;\r
+  public Color textColour = Color.black;\r
+  public Color textColour2 = Color.white;\r
 \r
+  /**\r
+   * Creates a new SequenceGroup object.\r
+   */\r
   public SequenceGroup()\r
   {\r
-    groupName = "Group";\r
-    this.isSelected = false;\r
-    this.displayBoxes = true;\r
-    this.displayText = true;\r
-    this.colourText = false;\r
-    this.display = true;\r
-    cs = null;\r
+    groupName = "JGroup:" + this.hashCode();\r
   }\r
 \r
-  public SequenceGroup(String groupName, ColourSchemeI scheme,\r
-                       boolean isSelected,\r
-                       boolean displayBoxes, boolean displayText,\r
-                       boolean colourText,\r
-                       boolean display)\r
+  /**\r
+   * Creates a new SequenceGroup object.\r
+   *\r
+   * @param sequences DOCUMENT ME!\r
+   * @param groupName DOCUMENT ME!\r
+   * @param scheme DOCUMENT ME!\r
+   * @param displayBoxes DOCUMENT ME!\r
+   * @param displayText DOCUMENT ME!\r
+   * @param colourText DOCUMENT ME!\r
+   * @param start DOCUMENT ME!\r
+   * @param end DOCUMENT ME!\r
+   */\r
+  public SequenceGroup(Vector sequences, String groupName,\r
+                       ColourSchemeI scheme, boolean displayBoxes,\r
+                       boolean displayText,\r
+                       boolean colourText, int start, int end)\r
   {\r
-\r
+    this.sequences = sequences;\r
     this.groupName = groupName;\r
-    this.isSelected = isSelected;\r
     this.displayBoxes = displayBoxes;\r
     this.displayText = displayText;\r
     this.colourText = colourText;\r
-    this.display = display;\r
     this.cs = scheme;\r
+    startRes = start;\r
+    endRes = end;\r
+    recalcConservation();\r
   }\r
 \r
-  public String getName()\r
+  public SequenceI[] getSelectionAsNewSequences(AlignmentI align)\r
   {\r
-    return groupName;\r
+    int iSize = sequences.size();\r
+    SequenceI[] seqs = new SequenceI[iSize];\r
+    SequenceI[] inorder = getSequencesInOrder(align);\r
+\r
+    for (int i = 0; i < iSize; i++)\r
+    {\r
+      SequenceI seq = inorder[i];\r
+\r
+      seqs[i] = new Sequence(seq.getName(),\r
+                             seq.getSequence(startRes, endRes + 1),\r
+                             seq.findPosition(startRes),\r
+                             findEndRes(seq));\r
+\r
+      seqs[i].setDescription(seq.getDescription());\r
+      seqs[i].setDBRef(seq.getDBRef());\r
+      seqs[i].setSequenceFeatures(seq.getSequenceFeatures());\r
+      if (seq.getDatasetSequence() != null)\r
+      {\r
+        seqs[i].setDatasetSequence(seq.getDatasetSequence());\r
+      }\r
+\r
+      if (seq.getAnnotation() != null)\r
+      {\r
+        for (int a = 0; a < seq.getAnnotation().length; a++)\r
+        {\r
+          seqs[i].addAlignmentAnnotation(seq.getAnnotation()[a]);\r
+        }\r
+      }\r
+    }\r
+\r
+    return seqs;\r
+\r
   }\r
 \r
-  public void setName(String name)\r
+  /**\r
+   * If sequence ends in gaps, the end residue can\r
+   * be correctly calculated here\r
+   * @param seq SequenceI\r
+   * @return int\r
+   */\r
+  public int findEndRes(SequenceI seq)\r
   {\r
-    groupName = name;\r
+    int eres = 0;\r
+    char ch;\r
+\r
+    for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)\r
+    {\r
+      ch = seq.getCharAt(j);\r
+      if (!jalview.util.Comparison.isGap( (ch)))\r
+      {\r
+        eres++;\r
+      }\r
+    }\r
+\r
+    if (eres > 0)\r
+    {\r
+      eres += seq.getStart() - 1;\r
+    }\r
+\r
+    return eres;\r
   }\r
 \r
-  public Conservation getConservation()\r
+  public Vector getSequences(Hashtable hiddenReps)\r
   {\r
-    return conserve;\r
+    if (hiddenReps == null)\r
+    {\r
+      return sequences;\r
+    }\r
+    else\r
+    {\r
+      Vector allSequences = new Vector();\r
+      SequenceI seq, seq2;\r
+      for (int i = 0; i < sequences.size(); i++)\r
+      {\r
+        seq = (SequenceI) sequences.elementAt(i);\r
+        allSequences.addElement(seq);\r
+        if (hiddenReps.containsKey(seq))\r
+        {\r
+          SequenceGroup hsg = (SequenceGroup) hiddenReps.get(seq);\r
+          for (int h = 0; h < hsg.getSize(); h++)\r
+          {\r
+            seq2 = hsg.getSequenceAt(h);\r
+            if (seq2 != seq\r
+                && !allSequences.contains(seq2))\r
+            {\r
+              allSequences.addElement(seq2);\r
+            }\r
+          }\r
+        }\r
+      }\r
+\r
+      return allSequences;\r
+    }\r
   }\r
 \r
-  public void setConservation(Conservation c)\r
+  public SequenceI[] getSequencesAsArray(Hashtable hiddenReps)\r
   {\r
-    conserve = c;\r
+    Vector tmp = getSequences(hiddenReps);\r
+    if (tmp == null)\r
+    {\r
+      return null;\r
+    }\r
+    SequenceI[] result = new SequenceI[tmp.size()];\r
+    for (int i = 0; i < result.length; i++)\r
+    {\r
+      result[i] = (SequenceI) tmp.elementAt(i);\r
+    }\r
+\r
+    return result;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param col DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\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 void addSequence(SequenceI s)\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param col DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public boolean adjustForRemoveRight(int col)\r
   {\r
-    sequences.addElement(s);\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 void deleteSequence(SequenceI s)\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public String getName()\r
   {\r
-    sequences.removeElement(s);\r
+    return groupName;\r
   }\r
 \r
-  public void setColourText(boolean state)\r
+  public String getDescription()\r
   {\r
-    colourText = state;\r
+    return description;\r
   }\r
 \r
-  public boolean getColourText()\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param name DOCUMENT ME!\r
+   */\r
+  public void setName(String name)\r
   {\r
-    return colourText;\r
+    groupName = name;\r
   }\r
 \r
-  public void setDisplayText(boolean state)\r
+  public void setDescription(String desc)\r
   {\r
-    displayText = state;\r
+    description = desc;\r
   }\r
 \r
-  public boolean getDisplayText()\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public Conservation getConservation()\r
   {\r
-    return displayText;\r
+    return conserve;\r
   }\r
 \r
-  public void setDisplayBoxes(boolean state)\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param c DOCUMENT ME!\r
+   */\r
+  public void setConservation(Conservation c)\r
   {\r
-    displayBoxes = state;\r
+    conserve = c;\r
   }\r
 \r
-  public boolean getDisplayBoxes()\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param s DOCUMENT ME!\r
+   * @param recalc DOCUMENT ME!\r
+   */\r
+  public void addSequence(SequenceI s, boolean recalc)\r
   {\r
-    return displayBoxes;\r
+    if (s != null && !sequences.contains(s))\r
+    {\r
+      sequences.addElement(s);\r
+    }\r
+\r
+    if (recalc)\r
+    {\r
+      recalcConservation();\r
+    }\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   */\r
+  public void recalcConservation()\r
+  {\r
+    if (cs == null)\r
+    {\r
+      return;\r
+    }\r
+\r
+    try\r
+    {\r
+      cs.setConsensus(AAFrequency.calculate(sequences, startRes, endRes + 1));\r
+\r
+      if (cs instanceof ClustalxColourScheme)\r
+      {\r
+        ( (ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());\r
+      }\r
+\r
+      if (cs.conservationApplied())\r
+      {\r
+        Conservation c = new Conservation(groupName,\r
+                                          ResidueProperties.propHash, 3,\r
+                                          sequences,\r
+                                          startRes, endRes + 1);\r
+        c.calculate();\r
+        c.verdict(false, 25);\r
+\r
+        cs.setConservation(c);\r
+\r
+        if (cs instanceof ClustalxColourScheme)\r
+        {\r
+          ( (ClustalxColourScheme) cs).resetClustalX(sequences,\r
+              getWidth());\r
+        }\r
+      }\r
+    }\r
+    catch (java.lang.OutOfMemoryError err)\r
+    {\r
+      System.out.println("Out of memory loading groups: " + err);\r
+    }\r
+\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param s DOCUMENT ME!\r
+   * @param recalc DOCUMENT ME!\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
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param s DOCUMENT ME!\r
+   * @param recalc DOCUMENT ME!\r
+   */\r
+  public void deleteSequence(SequenceI s, boolean recalc)\r
+  {\r
+    sequences.removeElement(s);\r
+\r
+    if (recalc)\r
+    {\r
+      recalcConservation();\r
+    }\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public int getStartRes()\r
   {\r
     return startRes;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public int getEndRes()\r
   {\r
     return endRes;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param i DOCUMENT ME!\r
+   */\r
   public void setStartRes(int i)\r
   {\r
     startRes = i;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param i DOCUMENT ME!\r
+   */\r
   public void setEndRes(int i)\r
   {\r
     endRes = i;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public int getSize()\r
   {\r
     return sequences.size();\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param i DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public SequenceI getSequenceAt(int i)\r
   {\r
     return (SequenceI) sequences.elementAt(i);\r
   }\r
 \r
-  public Vector getAAFrequency()\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param state DOCUMENT ME!\r
+   */\r
+  public void setColourText(boolean state)\r
   {\r
-    if (aaFrequency == null || aaFrequencyValid == false)\r
-    {\r
-      aaFrequency = AAFrequency.calculate(sequences, 0, getWidth());\r
-      aaFrequencyValid = true;\r
-    }\r
-    return aaFrequency;\r
+    colourText = state;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public boolean getColourText()\r
+  {\r
+    return colourText;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param state DOCUMENT ME!\r
+   */\r
+  public void setDisplayText(boolean state)\r
+  {\r
+    displayText = state;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public boolean getDisplayText()\r
+  {\r
+    return displayText;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param state DOCUMENT ME!\r
+   */\r
+  public void setDisplayBoxes(boolean state)\r
+  {\r
+    displayBoxes = state;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
+  public boolean getDisplayBoxes()\r
+  {\r
+    return displayBoxes;\r
   }\r
 \r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\r
+   */\r
   public int getWidth()\r
   {\r
-    System.out.println("it is called");\r
     // MC This needs to get reset when characters are inserted and deleted\r
-    for (int i = 0; i < sequences.size(); i++)\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
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @param c DOCUMENT ME!\r
+   */\r
+  public void setOutlineColour(Color c)\r
+  {\r
+    outlineColour = c;\r
+  }\r
+\r
+  /**\r
+   * DOCUMENT ME!\r
+   *\r
+   * @return DOCUMENT ME!\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(AlignmentI al)\r
+  {\r
+    int sSize = sequences.size();\r
+    int alHeight = al.getHeight();\r
+\r
+    SequenceI[] seqs = new SequenceI[sSize];\r
+\r
+    int index = 0;\r
+    for (int i = 0; i < alHeight && index < sSize; i++)\r
+    {\r
+      if (sequences.contains(al.getSequenceAt(i)))\r
+      {\r
+        seqs[index++] = al.getSequenceAt(i);\r
+      }\r
+    }\r
+\r
+    return seqs;\r
+  }\r
 }\r