X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceGroup.java;h=e22042c355e8b27ae7b51d0d48b4a9461ecf2a99;hb=ef3acde250d7d83304fb328a428b4d834fe3ac05;hp=de746ba38a999c133c28352bb86a7635a85335bf;hpb=1ecf6419aba86993b3c223bf5ec0fa79427baf85;p=jalview.git

diff --git a/src/jalview/datamodel/SequenceGroup.java b/src/jalview/datamodel/SequenceGroup.java
index de746ba..e22042c 100755
--- a/src/jalview/datamodel/SequenceGroup.java
+++ b/src/jalview/datamodel/SequenceGroup.java
@@ -1,107 +1,600 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 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.jbgui.*;
-import jalview.schemes.*;
-import jalview.analysis.*;
-import jalview.datamodel.*;
+import java.util.*;
 
-import java.util.Vector;
 import java.awt.*;
 
-public class SequenceGroup {
-    boolean isSelected;
-    boolean displayBoxes;
-    boolean displayText;
-    boolean colourText;
-    boolean display;
-    Conservation conserve;
-    Vector   aaFrequency;
-    boolean     aaFrequencyValid = false;
-    Vector sequences = new Vector();
-    int         width = -1;
-
-
-  public SequenceGroup() {
-    this.isSelected = false;
-    this.displayBoxes = true;
-    this.displayText = true;
-    this.colourText = false;
-    this.display = true;
-  }
-
-  public SequenceGroup( ColourSchemeI scheme, boolean isSelected,
-                        boolean displayBoxes, boolean displayText,
-                        boolean colourText,
-                        boolean display) {
-
-    this.isSelected = isSelected;
+import jalview.analysis.*;
+import jalview.schemes.*;
+
+/**
+ * DOCUMENT ME!
+ *
+ * @author $author$
+ * @version $Revision$
+ */
+public class SequenceGroup
+{
+  String groupName;
+  String description;
+  Conservation conserve;
+  Vector aaFrequency;
+  boolean displayBoxes = true;
+  boolean displayText = true;
+  boolean colourText = true;
+  private Vector sequences = new Vector();
+  int width = -1;
+
+  /** DOCUMENT ME!! */
+  public ColourSchemeI cs;
+  int startRes = 0;
+  int endRes = 0;
+  Color outlineColour = Color.black;
+  public int thresholdTextColour = 0;
+  public Color textColour = Color.black;
+  public Color textColour2 = Color.white;
+
+  /**
+   * Creates a new SequenceGroup object.
+   */
+  public SequenceGroup()
+  {
+    groupName = "JGroup:" + this.hashCode();
+  }
+
+  /**
+   * 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.display = display;
+    this.cs = scheme;
+    startRes = start;
+    endRes = end;
+    recalcConservation();
+  }
+
+  public SequenceI[] getSelectionAsNewSequences(AlignmentI align)
+  {
+    int iSize = sequences.size();
+    SequenceI[] seqs = new SequenceI[iSize];
+    SequenceI[] inorder = getSequencesInOrder(align);
+
+    for (int i = 0; i < iSize; i++)
+    {
+      SequenceI seq = inorder[i];
+
+      seqs[i] = new Sequence(seq.getName(),
+                             seq.getSequence(startRes, endRes + 1),
+                             seq.findPosition(startRes),
+                             findEndRes(seq));
+
+      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;
+
+  }
+
+  /**
+   * If sequence ends in gaps, the end residue can
+   * be correctly calculated here
+   * @param seq SequenceI
+   * @return int
+   */
+  public int findEndRes(SequenceI seq)
+  {
+    int eres = 0;
+    char ch;
+
+    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;
+    }
+
+    return eres;
+  }
+
+  public Vector getSequences(Hashtable hiddenReps)
+  {
+    if (hiddenReps == null)
+    {
+      return sequences;
+    }
+    else
+    {
+      Vector allSequences = new Vector();
+      SequenceI seq, seq2;
+      for (int i = 0; i < sequences.size(); i++)
+      {
+        seq = (SequenceI) sequences.elementAt(i);
+        allSequences.addElement(seq);
+        if (hiddenReps.containsKey(seq))
+        {
+          SequenceGroup hsg = (SequenceGroup) hiddenReps.get(seq);
+          for (int h = 0; h < hsg.getSize(); h++)
+          {
+            seq2 = hsg.getSequenceAt(h);
+            if (seq2 != seq
+                && !allSequences.contains(seq2))
+            {
+              allSequences.addElement(seq2);
+            }
+          }
+        }
+      }
+
+      return allSequences;
+    }
+  }
+
+  public SequenceI[] getSequencesAsArray(Hashtable hiddenReps)
+  {
+    Vector tmp = getSequences(hiddenReps);
+    if (tmp == null)
+    {
+      return null;
+    }
+    SequenceI[] result = new SequenceI[tmp.size()];
+    for (int i = 0; i < result.length; i++)
+    {
+      result[i] = (SequenceI) tmp.elementAt(i);
+    }
+
+    return result;
   }
 
-  public Conservation getConservation() {
-     return conserve;
+  /**
+   * 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;
   }
-  public void addSequence(SequenceI s) {
-    sequences.addElement(s);
+
+  /**
+   * 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;
+  }
+
+  public String getDescription()
+  {
+    return description;
+  }
+
+  /**
+   * DOCUMENT ME!
+   *
+   * @param name DOCUMENT ME!
+   */
+  public void setName(String name)
+  {
+    groupName = name;
+  }
+
+  public void setDescription(String desc)
+  {
+    description = desc;
   }
 
-  public void deleteSequence(SequenceI s) {
+  /**
+   * 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 (s != null && !sequences.contains(s))
+    {
+      sequences.addElement(s);
+    }
+
+    if (recalc)
+    {
+      recalcConservation();
+    }
+  }
+
+  /**
+   * DOCUMENT ME!
+   */
+  public void recalcConservation()
+  {
+    if (cs == null)
+    {
+      return;
+    }
+
+    try
+    {
+      cs.setConsensus(AAFrequency.calculate(sequences, startRes, endRes + 1));
+
+      if (cs instanceof ClustalxColourScheme)
+      {
+        ( (ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());
+      }
+
+      if (cs.conservationApplied())
+      {
+        Conservation c = new Conservation(groupName,
+                                          ResidueProperties.propHash, 3,
+                                          sequences,
+                                          startRes, endRes + 1);
+        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();
+    }
   }
 
-  public void setColourText(boolean state) {
+  /**
+   * 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()
+  {
+    return sequences.size();
+  }
+
+  /**
+   * 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;
   }
-  public boolean getColourText() {
+
+  /**
+   * DOCUMENT ME!
+   *
+   * @return DOCUMENT ME!
+   */
+  public boolean getColourText()
+  {
     return colourText;
   }
 
-  public void setDisplayText(boolean state) {
+  /**
+   * DOCUMENT ME!
+   *
+   * @param state DOCUMENT ME!
+   */
+  public void setDisplayText(boolean state)
+  {
     displayText = state;
   }
 
-  public boolean getDisplayText() {
+  /**
+   * DOCUMENT ME!
+   *
+   * @return DOCUMENT ME!
+   */
+  public boolean getDisplayText()
+  {
     return displayText;
   }
 
-  public void setDisplayBoxes(boolean state) {
+  /**
+   * DOCUMENT ME!
+   *
+   * @param state DOCUMENT ME!
+   */
+  public void setDisplayBoxes(boolean state)
+  {
     displayBoxes = state;
   }
 
-  public boolean getDisplayBoxes() {
+  /**
+   * DOCUMENT ME!
+   *
+   * @return DOCUMENT ME!
+   */
+  public boolean getDisplayBoxes()
+  {
     return displayBoxes;
   }
 
-    public int getSize() {
-	return sequences.size();
-    }
-    public SequenceI  getSequenceAt(int i) {
-	return (SequenceI)sequences.elementAt(i);
+  /**
+   * 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();
     }
 
-    public Vector getAAFrequency() {
-	if (aaFrequency == null || aaFrequencyValid == false) {
-	    aaFrequency = AAFrequency.calculate(sequences,1,getWidth());
-	    aaFrequencyValid = true;
-	}
-	return aaFrequency;
-    }
-    public int getWidth() {
-	// MC This needs to get reset when characters are inserted and deleted
-	if (width == -1) {
-	    for (int i = 0; i < sequences.size(); i++) {
-		SequenceI seq = (SequenceI)sequences.elementAt(i);
-		if (seq.getLength() > width) {
-		    width = seq.getLength();
-		}
-	    }
-	}
+    for (int i = 1; i < sequences.size(); i++)
+    {
+      SequenceI seq = (SequenceI) sequences.elementAt(i);
 
-	return width;
+      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 sSize = sequences.size();
+    int alHeight = al.getHeight();
+
+    SequenceI[] seqs = new SequenceI[sSize];
+
+    int index = 0;
+    for (int i = 0; i < alHeight && index < sSize; i++)
+    {
+      if (sequences.contains(al.getSequenceAt(i)))
+      {
+        seqs[index++] = al.getSequenceAt(i);
+      }
+    }
+
+    return seqs;
+  }
+}