X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceGroup.java;h=693291f114d5881668773bc25d595bb9d7da9d98;hb=b57a02c25e335d033c97f8a6bacd6b54f62bd2b6;hp=9d3e6db930ab5688972d73748b3e9e67e8ff9f08;hpb=d423f22792e47dbc800ae220a58677f988971d06;p=jalview.git

diff --git a/src/jalview/datamodel/SequenceGroup.java b/src/jalview/datamodel/SequenceGroup.java
index 9d3e6db..693291f 100755
--- a/src/jalview/datamodel/SequenceGroup.java
+++ b/src/jalview/datamodel/SequenceGroup.java
@@ -1,6 +1,6 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
  * 
  * This file is part of Jalview.
  * 
@@ -18,6 +18,7 @@
 package jalview.datamodel;
 
 import java.util.*;
+import java.util.List;
 
 import java.awt.*;
 
@@ -30,7 +31,7 @@ import jalview.schemes.*;
  * @author $author$
  * @version $Revision$
  */
-public class SequenceGroup
+public class SequenceGroup implements AnnotatedCollectionI
 {
   String groupName;
 
@@ -49,12 +50,12 @@ public class SequenceGroup
   /**
    * after Olivier's non-conserved only character display
    */
-  boolean showUnconserved = false;
+  boolean showNonconserved = false;
 
   /**
    * group members
    */
-  private Vector sequences = new Vector();
+  private Vector<SequenceI> sequences = new Vector<SequenceI>();
 
   /**
    * representative sequence for this group (if any)
@@ -93,6 +94,11 @@ public class SequenceGroup
   private boolean showSequenceLogo = false;
 
   /**
+   * flag indicating if logo should be rendered normalised
+   */
+  private boolean normaliseSequenceLogo;
+
+  /**
    * @return the includeAllConsSymbols
    */
   public boolean isShowSequenceLogo()
@@ -147,7 +153,7 @@ public class SequenceGroup
     if (seqsel != null)
     {
       sequences = new Vector();
-      Enumeration sq = seqsel.sequences.elements();
+      Enumeration<SequenceI> sq = seqsel.sequences.elements();
       while (sq.hasMoreElements())
       {
         sequences.addElement(sq.nextElement());
@@ -226,8 +232,8 @@ public class SequenceGroup
               if (!found)
                 continue;
             }
-            AlignmentAnnotation newannot = new AlignmentAnnotation(seq
-                    .getAnnotation()[a]);
+            AlignmentAnnotation newannot = new AlignmentAnnotation(
+                    seq.getAnnotation()[a]);
             newannot.restrict(startRes, endRes);
             newannot.setSequenceRef(seqs[ipos]);
             newannot.adjustForAlignment();
@@ -280,7 +286,13 @@ public class SequenceGroup
     return eres;
   }
 
-  public Vector getSequences(Hashtable hiddenReps)
+  public List<SequenceI> getSequences()
+  {
+    return sequences;
+  }
+
+  public List<SequenceI> getSequences(
+          Map<SequenceI, SequenceCollectionI> hiddenReps)
   {
     if (hiddenReps == null)
     {
@@ -289,17 +301,16 @@ public class SequenceGroup
     else
     {
       Vector allSequences = new Vector();
-      SequenceI seq, seq2;
+      SequenceI seq;
       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++)
+          SequenceCollectionI hsg = hiddenReps.get(seq);
+          for (SequenceI seq2 : hsg.getSequences())
           {
-            seq2 = hsg.getSequenceAt(h);
             if (seq2 != seq && !allSequences.contains(seq2))
             {
               allSequences.addElement(seq2);
@@ -312,20 +323,15 @@ public class SequenceGroup
     }
   }
 
-  public SequenceI[] getSequencesAsArray(Hashtable hiddenReps)
+  public SequenceI[] getSequencesAsArray(
+          Map<SequenceI, SequenceCollectionI> map)
   {
-    Vector tmp = getSequences(hiddenReps);
+    List<SequenceI> tmp = getSequences(map);
     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;
+    return tmp.toArray(new SequenceI[tmp.size()]);
   }
 
   /**
@@ -440,7 +446,9 @@ public class SequenceGroup
   }
 
   /**
-   * Add s to this sequence group
+   * Add s to this sequence group. If aligment sequence is already contained in
+   * group, it will not be added again, but recalculation may happen if the flag
+   * is set.
    * 
    * @param s
    *          alignment sequence to be added
@@ -475,7 +483,10 @@ public class SequenceGroup
     {
       return;
     }
-
+    if (cs != null)
+    {
+      cs.alignmentChanged(this, null);
+    }
     try
     {
       Hashtable cnsns[] = AAFrequency.calculate(sequences, startRes,
@@ -487,11 +498,7 @@ public class SequenceGroup
       if (cs != null)
       {
         cs.setConsensus(cnsns);
-
-        if (cs instanceof ClustalxColourScheme)
-        {
-          ((ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());
-        }
+        cs.alignmentChanged(this, null);
       }
 
       if ((conservation != null)
@@ -508,12 +515,10 @@ public class SequenceGroup
         }
         if (cs != null)
         {
-          cs.setConservation(c);
-
-          if (cs instanceof ClustalxColourScheme)
+          if (cs.conservationApplied())
           {
-            ((ClustalxColourScheme) cs)
-                    .resetClustalX(sequences, getWidth());
+            cs.setConservation(c);
+            cs.alignmentChanged(this, null);
           }
         }
       }
@@ -627,10 +632,9 @@ public class SequenceGroup
   }
 
   /**
-   * DOCUMENT ME!
+   * Set the first column selected by this group. Runs from 0<=i<N_cols
    * 
    * @param i
-   *          DOCUMENT ME!
    */
   public void setStartRes(int i)
   {
@@ -638,10 +642,9 @@ public class SequenceGroup
   }
 
   /**
-   * DOCUMENT ME!
+   * Set the groups last selected column. Runs from 0<=i<N_cols
    * 
    * @param i
-   *          DOCUMENT ME!
    */
   public void setEndRes(int i)
   {
@@ -794,23 +797,42 @@ public class SequenceGroup
    */
   public SequenceI[] getSequencesInOrder(AlignmentI al)
   {
+    return getSequencesInOrder(al, true);
+  }
+
+  /**
+   * return an array representing the intersection of the group with al,
+   * optionally returning an array the size of al.getHeight() where nulls mark
+   * the non-intersected sequences
+   * 
+   * @param al
+   * @param trim
+   * @return null or array
+   */
+  public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim)
+  {
     int sSize = sequences.size();
     int alHeight = al.getHeight();
 
-    SequenceI[] seqs = new SequenceI[sSize];
+    SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight];
 
     int index = 0;
     for (int i = 0; i < alHeight && index < sSize; i++)
     {
       if (sequences.contains(al.getSequenceAt(i)))
       {
-        seqs[index++] = al.getSequenceAt(i);
+        seqs[(trim) ? index : i] = al.getSequenceAt(i);
+        index++;
       }
     }
     if (index == 0)
     {
       return null;
     }
+    if (!trim)
+    {
+      return seqs;
+    }
     if (index < seqs.length)
     {
       SequenceI[] dummy = seqs;
@@ -926,18 +948,19 @@ public class SequenceGroup
    * 
    * @param alignment
    *          (may not be null)
-   * @param hashtable
+   * @param map
    *          (may be null)
    * @return new group containing sequences common to this group and alignment
    */
-  public SequenceGroup intersect(AlignmentI alignment, Hashtable hashtable)
+  public SequenceGroup intersect(AlignmentI alignment,
+          Map<SequenceI, SequenceCollectionI> map)
   {
     SequenceGroup sgroup = new SequenceGroup(this);
     SequenceI[] insect = getSequencesInOrder(alignment);
     sgroup.sequences = new Vector();
     for (int s = 0; insect != null && s < insect.length; s++)
     {
-      if (hashtable == null || hashtable.containsKey(insect[s]))
+      if (map == null || map.containsKey(insect[s]))
       {
         sgroup.sequences.addElement(insect[s]);
       }
@@ -957,18 +980,18 @@ public class SequenceGroup
   /**
    * @return the showUnconserved
    */
-  public boolean getShowunconserved()
+  public boolean getShowNonconserved()
   {
-    return showUnconserved;
+    return showNonconserved;
   }
 
   /**
-   * @param showUnconserved
+   * @param showNonconserved
    *          the showUnconserved to set
    */
-  public void setShowunconserved(boolean displayNonconserved)
+  public void setShowNonconserved(boolean displayNonconserved)
   {
-    this.showUnconserved = displayNonconserved;
+    this.showNonconserved = displayNonconserved;
   }
 
   AlignmentAnnotation consensus = null, conservation = null;
@@ -979,6 +1002,20 @@ public class SequenceGroup
   private boolean showConsensusHistogram;
 
   /**
+   * set this alignmentAnnotation object as the one used to render consensus
+   * annotation
+   * 
+   * @param aan
+   */
+  public void setConsensus(AlignmentAnnotation aan)
+  {
+    if (consensus == null)
+    {
+      consensus = aan;
+    }
+  }
+
+  /**
    * 
    * @return automatically calculated consensus row
    */
@@ -1007,6 +1044,20 @@ public class SequenceGroup
   }
 
   /**
+   * set this alignmentAnnotation object as the one used to render consensus
+   * annotation
+   * 
+   * @param aan
+   */
+  public void setConservationRow(AlignmentAnnotation aan)
+  {
+    if (conservation == null)
+    {
+      conservation = aan;
+    }
+  }
+
+  /**
    * get the conservation annotation row for this group
    * 
    * @return autoCalculated annotation row
@@ -1056,8 +1107,8 @@ public class SequenceGroup
       }
     }
 
-    SequenceI sq = new Sequence("Group" + getName() + " Consensus", seqs
-            .toString());
+    SequenceI sq = new Sequence("Group" + getName() + " Consensus",
+            seqs.toString());
     sq.setDescription("Percentage Identity Consensus "
             + ((ignoreGapsInConsensus) ? " without gaps" : ""));
     return sq;
@@ -1079,17 +1130,18 @@ public class SequenceGroup
   }
 
   /**
-   * @param includeAllConsSymbols
-   *          the includeAllConsSymbols to set
+   * @param showSequenceLogo
+   *          indicates if a sequence logo is shown for consensus annotation
    */
-  public void setIncludeAllConsSymbols(boolean includeAllConsSymbols)
+  public void setshowSequenceLogo(boolean showSequenceLogo)
   {
-    if (this.showSequenceLogo != includeAllConsSymbols && consensus != null)
+    // TODO: decouple calculation from settings update
+    if (this.showSequenceLogo != showSequenceLogo && consensus != null)
     {
-      this.showSequenceLogo = includeAllConsSymbols;
+      this.showSequenceLogo = showSequenceLogo;
       recalcConservation();
     }
-    this.showSequenceLogo = includeAllConsSymbols;
+    this.showSequenceLogo = showSequenceLogo;
   }
 
   /**
@@ -1116,4 +1168,68 @@ public class SequenceGroup
   {
     return showConsensusHistogram;
   }
+
+  /**
+   * set flag indicating if logo should be normalised when rendered
+   * 
+   * @param norm
+   */
+  public void setNormaliseSequenceLogo(boolean norm)
+  {
+    normaliseSequenceLogo = norm;
+  }
+
+  public boolean isNormaliseSequenceLogo()
+  {
+    return normaliseSequenceLogo;
+  }
+
+  @Override
+  /**
+   * returns a new array with all annotation involving this group
+   */
+  public AlignmentAnnotation[] getAlignmentAnnotation()
+  {
+    // TODO add in other methods like 'getAlignmentAnnotation(String label),
+    // etc'
+    ArrayList<AlignmentAnnotation> annot = new ArrayList<AlignmentAnnotation>();
+    for (SequenceI seq : (Vector<SequenceI>) sequences)
+    {
+      for (AlignmentAnnotation al : seq.getAnnotation())
+      {
+        if (al.groupRef == this)
+        {
+          annot.add(al);
+        }
+      }
+    }
+    if (consensus != null)
+    {
+      annot.add(consensus);
+    }
+    if (conservation != null)
+    {
+      annot.add(conservation);
+    }
+    return annot.toArray(new AlignmentAnnotation[0]);
+  }
+
+  @Override
+  public Iterable<AlignmentAnnotation> findAnnotation(String calcId)
+  {
+    ArrayList<AlignmentAnnotation> aa = new ArrayList<AlignmentAnnotation>();
+    for (AlignmentAnnotation a : getAlignmentAnnotation())
+    {
+      if (a.getCalcId() == calcId)
+      {
+        aa.add(a);
+      }
+    }
+    return aa;
+  }
+
+  public void clear()
+  {
+    sequences.clear();
+  }
 }