X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FSequenceGroup.java;h=9a408e31dda4dfdce5d63638009bb6884a8cc3ab;hb=37de9310bec3501cbc6381e0c3dcb282fcaad812;hp=0bd7266e69abff83cbdca3e0873bb56837ec83f7;hpb=cfd4c0f73bdba694e2d854684a8a3f679ccdba27;p=jalview.git

diff --git a/src/jalview/datamodel/SequenceGroup.java b/src/jalview/datamodel/SequenceGroup.java
index 0bd7266..9a408e3 100755
--- a/src/jalview/datamodel/SequenceGroup.java
+++ b/src/jalview/datamodel/SequenceGroup.java
@@ -1,29 +1,35 @@
 /*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
  * 
  * This file is part of Jalview.
  * 
  * 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.
+ * 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
  */
 package jalview.datamodel;
 
-import java.util.*;
-import java.util.List;
-
-import java.awt.*;
+import jalview.analysis.AAFrequency;
+import jalview.analysis.Conservation;
+import jalview.schemes.ColourSchemeI;
 
-import jalview.analysis.*;
-import jalview.schemes.*;
+import java.awt.Color;
+import java.util.ArrayList;
+import java.util.Hashtable;
+import java.util.List;
+import java.util.Map;
+import java.util.Vector;
 
 /**
  * Collects a set contiguous ranges on a set of sequences
@@ -55,7 +61,7 @@ public class SequenceGroup implements AnnotatedCollectionI
   /**
    * group members
    */
-  private Vector<SequenceI> sequences = new Vector<SequenceI>();
+  private List<SequenceI> sequences = new ArrayList<SequenceI>();
 
   /**
    * representative sequence for this group (if any)
@@ -69,8 +75,10 @@ public class SequenceGroup implements AnnotatedCollectionI
    */
   public ColourSchemeI cs;
 
+  // start column (base 0)
   int startRes = 0;
 
+  // end column (base 0)
   int endRes = 0;
 
   public Color outlineColour = Color.black;
@@ -128,7 +136,7 @@ public class SequenceGroup implements AnnotatedCollectionI
    * @param end
    *          last column of group
    */
-  public SequenceGroup(Vector sequences, String groupName,
+  public SequenceGroup(List<SequenceI> sequences, String groupName,
           ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
           boolean colourText, int start, int end)
   {
@@ -152,13 +160,8 @@ public class SequenceGroup implements AnnotatedCollectionI
   {
     if (seqsel != null)
     {
-      sequences = new Vector();
-      Enumeration<SequenceI> sq = seqsel.sequences.elements();
-      while (sq.hasMoreElements())
-      {
-        sequences.addElement(sq.nextElement());
-      }
-      ;
+      sequences = new ArrayList<SequenceI>();
+      sequences.addAll(seqsel.sequences);
       if (seqsel.groupName != null)
       {
         groupName = new String(seqsel.groupName);
@@ -170,7 +173,9 @@ public class SequenceGroup implements AnnotatedCollectionI
       endRes = seqsel.endRes;
       cs = seqsel.cs;
       if (seqsel.description != null)
+      {
         description = new String(seqsel.description);
+      }
       hidecols = seqsel.hidecols;
       hidereps = seqsel.hidereps;
       idColour = seqsel.idColour;
@@ -203,7 +208,7 @@ public class SequenceGroup implements AnnotatedCollectionI
       if (seqs[ipos] != null)
       {
         seqs[ipos].setDescription(seq.getDescription());
-        seqs[ipos].setDBRef(seq.getDBRef());
+        seqs[ipos].setDBRefs(seq.getDBRefs());
         seqs[ipos].setSequenceFeatures(seq.getSequenceFeatures());
         if (seq.getDatasetSequence() != null)
         {
@@ -230,7 +235,9 @@ public class SequenceGroup implements AnnotatedCollectionI
                 }
               }
               if (!found)
+              {
                 continue;
+              }
             }
             AlignmentAnnotation newannot = new AlignmentAnnotation(
                     seq.getAnnotation()[a]);
@@ -286,26 +293,27 @@ public class SequenceGroup implements AnnotatedCollectionI
     return eres;
   }
 
+  @Override
   public List<SequenceI> getSequences()
   {
     return sequences;
   }
 
+  @Override
   public List<SequenceI> getSequences(
           Map<SequenceI, SequenceCollectionI> hiddenReps)
   {
     if (hiddenReps == null)
     {
+      // TODO: need a synchronizedCollection here ?
       return sequences;
     }
     else
     {
-      Vector allSequences = new Vector();
-      SequenceI seq;
-      for (int i = 0; i < sequences.size(); i++)
+      List<SequenceI> allSequences = new ArrayList<SequenceI>();
+      for (SequenceI seq : sequences)
       {
-        seq = (SequenceI) sequences.elementAt(i);
-        allSequences.addElement(seq);
+        allSequences.add(seq);
         if (hiddenReps.containsKey(seq))
         {
           SequenceCollectionI hsg = hiddenReps.get(seq);
@@ -313,7 +321,7 @@ public class SequenceGroup implements AnnotatedCollectionI
           {
             if (seq2 != seq && !allSequences.contains(seq2))
             {
-              allSequences.addElement(seq2);
+              allSequences.add(seq2);
             }
           }
         }
@@ -457,56 +465,90 @@ public class SequenceGroup implements AnnotatedCollectionI
    */
   public void addSequence(SequenceI s, boolean recalc)
   {
-    if (s != null && !sequences.contains(s))
+    synchronized (sequences)
     {
-      sequences.addElement(s);
-    }
+      if (s != null && !sequences.contains(s))
+      {
+        sequences.add(s);
+      }
 
-    if (recalc)
-    {
-      recalcConservation();
+      if (recalc)
+      {
+        recalcConservation();
+      }
     }
   }
 
   /**
-   * Max Gaps Threshold for performing a conservation calculation TODO: make
-   * this a configurable property - or global to an alignment view
+   * Max Gaps Threshold (percent) for performing a conservation calculation
    */
   private int consPercGaps = 25;
 
   /**
-   * calculate residue conservation for group - but only if necessary.
+   * @return Max Gaps Threshold for performing a conservation calculation
+   */
+  public int getConsPercGaps()
+  {
+    return consPercGaps;
+  }
+
+  /**
+   * set Max Gaps Threshold (percent) for performing a conservation calculation
+   * 
+   * @param consPercGaps
+   */
+  public void setConsPercGaps(int consPercGaps)
+  {
+    this.consPercGaps = consPercGaps;
+  }
+
+  /**
+   * calculate residue conservation and colourschemes for group - but only if
+   * necessary. returns true if the calculation resulted in a visible change to
+   * group
+   */
+  public boolean recalcConservation()
+  {
+    return recalcConservation(false);
+  }
+
+  /**
+   * calculate residue conservation for group - but only if necessary. returns
+   * true if the calculation resulted in a visible change to group
+   * 
+   * @param defer
+   *          when set, colourschemes for this group are not refreshed after
+   *          recalculation
    */
-  public void recalcConservation()
+  public boolean recalcConservation(boolean defer)
   {
     if (cs == null && consensus == null && conservation == null)
     {
-      return;
-    }
-    if (cs != null)
-    {
-      cs.alignmentChanged(this, null);
+      return false;
     }
+    // TODO: try harder to detect changes in state in order to minimise
+    // recalculation effort
+    boolean upd = false;
     try
     {
       Hashtable cnsns[] = AAFrequency.calculate(sequences, startRes,
               endRes + 1, showSequenceLogo);
       if (consensus != null)
       {
-        _updateConsensusRow(cnsns);
+        _updateConsensusRow(cnsns, sequences.size());
+        upd = true;
       }
       if (cs != null)
       {
         cs.setConsensus(cnsns);
-        cs.alignmentChanged(this, null);
+        upd = true;
       }
 
       if ((conservation != null)
               || (cs != null && cs.conservationApplied()))
       {
-        Conservation c = new Conservation(groupName,
-                ResidueProperties.propHash, 3, sequences, startRes,
-                endRes + 1);
+        Conservation c = new Conservation(groupName, 3, sequences,
+                startRes, endRes + 1);
         c.calculate();
         c.verdict(false, consPercGaps);
         if (conservation != null)
@@ -518,16 +560,27 @@ public class SequenceGroup implements AnnotatedCollectionI
           if (cs.conservationApplied())
           {
             cs.setConservation(c);
-            cs.alignmentChanged(this, null);
           }
         }
+        // eager update - will cause a refresh of overview regardless
+        upd = true;
+      }
+      if (cs != null && !defer)
+      {
+        // TODO: JAL-2034 should cs.alignmentChanged modify return state
+        cs.alignmentChanged(context != null ? context : this, null);
+        return true;
+      }
+      else
+      {
+        return upd;
       }
     } catch (java.lang.OutOfMemoryError err)
     {
       // TODO: catch OOM
       System.out.println("Out of memory loading groups: " + err);
     }
-
+    return upd;
   }
 
   private void _updateConservationRow(Conservation c)
@@ -552,7 +605,7 @@ public class SequenceGroup implements AnnotatedCollectionI
 
   public Hashtable[] consensusData = null;
 
-  private void _updateConsensusRow(Hashtable[] cnsns)
+  private void _updateConsensusRow(Hashtable[] cnsns, long nseq)
   {
     if (consensus == null)
     {
@@ -569,9 +622,10 @@ public class SequenceGroup implements AnnotatedCollectionI
     consensus.annotations = new Annotation[aWidth]; // should be alignment width
 
     AAFrequency.completeConsensus(consensus, cnsns, startRes, endRes + 1,
-            ignoreGapsInConsensus, showSequenceLogo); // TODO: setting container
-                                                      // for
-                                                      // ignoreGapsInConsensusCalculation);
+            ignoreGapsInConsensus, showSequenceLogo, nseq); // TODO: setting
+                                                            // container
+    // for
+    // ignoreGapsInConsensusCalculation);
   }
 
   /**
@@ -583,31 +637,37 @@ public class SequenceGroup implements AnnotatedCollectionI
    */
   public void addOrRemove(SequenceI s, boolean recalc)
   {
-    if (sequences.contains(s))
-    {
-      deleteSequence(s, recalc);
-    }
-    else
+    synchronized (sequences)
     {
-      addSequence(s, recalc);
+      if (sequences.contains(s))
+      {
+        deleteSequence(s, recalc);
+      }
+      else
+      {
+        addSequence(s, recalc);
+      }
     }
   }
 
   /**
-   * DOCUMENT ME!
+   * remove
    * 
    * @param s
-   *          DOCUMENT ME!
+   *          to be removed
    * @param recalc
-   *          DOCUMENT ME!
+   *          true means recalculate conservation
    */
   public void deleteSequence(SequenceI s, boolean recalc)
   {
-    sequences.removeElement(s);
-
-    if (recalc)
+    synchronized (sequences)
     {
-      recalcConservation();
+      sequences.remove(s);
+
+      if (recalc)
+      {
+        recalcConservation();
+      }
     }
   }
 
@@ -616,6 +676,7 @@ public class SequenceGroup implements AnnotatedCollectionI
    * 
    * @return the first column selected by this group. Runs from 0<=i<N_cols
    */
+  @Override
   public int getStartRes()
   {
     return startRes;
@@ -625,6 +686,7 @@ public class SequenceGroup implements AnnotatedCollectionI
    * 
    * @return the groups last selected column. Runs from 0<=i<N_cols
    */
+  @Override
   public int getEndRes()
   {
     return endRes;
@@ -651,9 +713,7 @@ public class SequenceGroup implements AnnotatedCollectionI
   }
 
   /**
-   * DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
+   * @return number of sequences in group
    */
   public int getSize()
   {
@@ -661,23 +721,17 @@ public class SequenceGroup implements AnnotatedCollectionI
   }
 
   /**
-   * DOCUMENT ME!
-   * 
    * @param i
-   *          DOCUMENT ME!
-   * 
-   * @return DOCUMENT ME!
+   * @return the ith sequence
    */
   public SequenceI getSequenceAt(int i)
   {
-    return (SequenceI) sequences.elementAt(i);
+    return sequences.get(i);
   }
 
   /**
-   * DOCUMENT ME!
-   * 
    * @param state
-   *          DOCUMENT ME!
+   *          colourText
    */
   public void setColourText(boolean state)
   {
@@ -737,29 +791,27 @@ public class SequenceGroup implements AnnotatedCollectionI
   }
 
   /**
-   * DOCUMENT ME!
+   * computes the width of current set of sequences and returns it
    * 
    * @return DOCUMENT ME!
    */
+  @Override
   public int getWidth()
   {
-    // MC This needs to get reset when characters are inserted and deleted
-    if (sequences.size() > 0)
+    synchronized (sequences)
     {
-      width = ((SequenceI) sequences.elementAt(0)).getLength();
-    }
-
-    for (int i = 1; i < sequences.size(); i++)
-    {
-      SequenceI seq = (SequenceI) sequences.elementAt(i);
-
-      if (seq.getLength() > width)
+      // MC This needs to get reset when characters are inserted and deleted
+      boolean first = true;
+      for (SequenceI seq : sequences)
       {
-        width = seq.getLength();
+        if (first || seq.getLength() > width)
+        {
+          width = seq.getLength();
+          first = false;
+        }
       }
+      return width;
     }
-
-    return width;
   }
 
   /**
@@ -810,39 +862,42 @@ public class SequenceGroup implements AnnotatedCollectionI
    */
   public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim)
   {
-    int sSize = sequences.size();
-    int alHeight = al.getHeight();
+    synchronized (sequences)
+    {
+      int sSize = sequences.size();
+      int alHeight = al.getHeight();
 
-    SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight];
+      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)))
+      int index = 0;
+      for (int i = 0; i < alHeight && index < sSize; i++)
       {
-        seqs[(trim) ? index : i] = al.getSequenceAt(i);
-        index++;
+        if (sequences.contains(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;
-      seqs = new SequenceI[index];
-      while (--index >= 0)
+      if (index == 0)
+      {
+        return null;
+      }
+      if (!trim)
+      {
+        return seqs;
+      }
+      if (index < seqs.length)
       {
-        seqs[index] = dummy[index];
-        dummy[index] = null;
+        SequenceI[] dummy = seqs;
+        seqs = new SequenceI[index];
+        while (--index >= 0)
+        {
+          seqs[index] = dummy[index];
+          dummy[index] = null;
+        }
       }
+      return seqs;
     }
-    return seqs;
   }
 
   /**
@@ -865,6 +920,7 @@ public class SequenceGroup implements AnnotatedCollectionI
   /**
    * @return the representative sequence for this group
    */
+  @Override
   public SequenceI getSeqrep()
   {
     return seqrep;
@@ -877,6 +933,7 @@ public class SequenceGroup implements AnnotatedCollectionI
    * @param seqrep
    *          the seqrep to set (null means no sequence representative)
    */
+  @Override
   public void setSeqrep(SequenceI seqrep)
   {
     this.seqrep = seqrep;
@@ -886,6 +943,7 @@ public class SequenceGroup implements AnnotatedCollectionI
    * 
    * @return true if group has a sequence representative
    */
+  @Override
   public boolean hasSeqrep()
   {
     return seqrep != null;
@@ -956,23 +1014,14 @@ public class SequenceGroup implements AnnotatedCollectionI
   {
     SequenceGroup sgroup = new SequenceGroup(this);
     SequenceI[] insect = getSequencesInOrder(alignment);
-    sgroup.sequences = new Vector();
+    sgroup.sequences = new ArrayList<SequenceI>();
     for (int s = 0; insect != null && s < insect.length; s++)
     {
       if (map == null || map.containsKey(insect[s]))
       {
-        sgroup.sequences.addElement(insect[s]);
+        sgroup.sequences.add(insect[s]);
       }
     }
-    // Enumeration en =getSequences(hashtable).elements();
-    // while (en.hasMoreElements())
-    // {
-    // SequenceI elem = (SequenceI) en.nextElement();
-    // if (alignment.getSequences().contains(elem))
-    // {
-    // sgroup.addSequence(elem, false);
-    // }
-    // }
     return sgroup;
   }
 
@@ -1016,7 +1065,8 @@ public class SequenceGroup implements AnnotatedCollectionI
 
   /**
    * 
-   * @return automatically calculated consensus row
+   * @return automatically calculated consensus row note: the row is a stub if a
+   *         consensus calculation has not yet been performed on the group
    */
   public AlignmentAnnotation getConsensus()
   {
@@ -1192,23 +1242,30 @@ public class SequenceGroup implements AnnotatedCollectionI
     // TODO add in other methods like 'getAlignmentAnnotation(String label),
     // etc'
     ArrayList<AlignmentAnnotation> annot = new ArrayList<AlignmentAnnotation>();
-    for (SequenceI seq : (Vector<SequenceI>) sequences)
+    synchronized (sequences)
     {
-      for (AlignmentAnnotation al : seq.getAnnotation())
+      for (SequenceI seq : sequences)
       {
-        if (al.groupRef == this)
+        AlignmentAnnotation[] aa = seq.getAnnotation();
+        if (aa != null)
         {
-          annot.add(al);
+          for (AlignmentAnnotation al : aa)
+          {
+            if (al.groupRef == this)
+            {
+              annot.add(al);
+            }
+          }
         }
       }
-    }
-    if (consensus != null)
-    {
-      annot.add(consensus);
-    }
-    if (conservation != null)
-    {
-      annot.add(conservation);
+      if (consensus != null)
+      {
+        annot.add(consensus);
+      }
+      if (conservation != null)
+      {
+        annot.add(conservation);
+      }
     }
     return annot.toArray(new AlignmentAnnotation[0]);
   }
@@ -1227,8 +1284,81 @@ public class SequenceGroup implements AnnotatedCollectionI
     return aa;
   }
 
+  /**
+   * Returns a list of annotations that match the specified sequenceRef, calcId
+   * and label, ignoring null values.
+   * 
+   * @return list of AlignmentAnnotation objects
+   */
+  @Override
+  public Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
+          String calcId, String label)
+  {
+    ArrayList<AlignmentAnnotation> aa = new ArrayList<AlignmentAnnotation>();
+    for (AlignmentAnnotation ann : getAlignmentAnnotation())
+    {
+      if (ann.getCalcId() != null && ann.getCalcId().equals(calcId)
+              && ann.sequenceRef != null && ann.sequenceRef == seq
+              && ann.label != null && ann.label.equals(label))
+      {
+        aa.add(ann);
+      }
+    }
+    return aa;
+  }
+
+  /**
+   * Answer true if any annotation matches the calcId passed in (if not null).
+   * 
+   * @param calcId
+   * @return
+   */
+  public boolean hasAnnotation(String calcId)
+  {
+    if (calcId != null && !"".equals(calcId))
+    {
+      for (AlignmentAnnotation a : getAlignmentAnnotation())
+      {
+        if (a.getCalcId() == calcId)
+        {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  /**
+   * Remove all sequences from the group (leaving other properties unchanged).
+   */
   public void clear()
   {
-    sequences.clear();
+    synchronized (sequences)
+    {
+      sequences.clear();
+    }
+  }
+
+  private AnnotatedCollectionI context;
+
+  /**
+   * set the alignment or group context for this group
+   * 
+   * @param context
+   */
+  public void setContext(AnnotatedCollectionI context)
+  {
+    this.context = context;
+  }
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see jalview.datamodel.AnnotatedCollectionI#getContext()
+   */
+  @Override
+  public AnnotatedCollectionI getContext()
+  {
+    return context;
   }
 }