X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FAlignmentAnnotation.java;h=1d624d4adf16d2b94da968b2ca9b8b3c2b1ca032;hb=a45774ee31d9f35d4eff46d54d7deab719afb092;hp=f2864db79cfb3a8026d8fa67eebcacf54a5a9d8d;hpb=56ad3ae1c8b2fefd7af371049e344acfc1f23944;p=jalview.git

diff --git a/src/jalview/datamodel/AlignmentAnnotation.java b/src/jalview/datamodel/AlignmentAnnotation.java
index f2864db..1d624d4 100755
--- a/src/jalview/datamodel/AlignmentAnnotation.java
+++ b/src/jalview/datamodel/AlignmentAnnotation.java
@@ -1,20 +1,19 @@
 /*
- * 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
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * 
+ * 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.
+ * 
+ * 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/>.
  */
 package jalview.datamodel;
 
@@ -23,14 +22,16 @@ import java.util.Hashtable;
 
 /**
  * DOCUMENT ME!
- *
+ * 
  * @author $author$
  * @version $Revision$
  */
 public class AlignmentAnnotation
 {
-  /** If true, this annotations is calculated every edit,
-   * eg consensus, quality or conservation graphs */
+  /**
+   * If true, this annotations is calculated every edit, eg consensus, quality
+   * or conservation graphs
+   */
   public boolean autoCalculated = false;
 
   public String annotationId;
@@ -57,31 +58,32 @@ public class AlignmentAnnotation
   /**
    * Score associated with label and description.
    */
-  public double score= Double.NaN;
+  public double score = Double.NaN;
+
   /**
    * flag indicating if annotation has a score.
    */
-  public boolean hasScore=false;
+  public boolean hasScore = false;
 
   public GraphLine threshold;
 
   // Graphical hints and tips
 
-  /** DOCUMENT ME!! */
+  /** Can this row be edited by the user ? */
   public boolean editable = false;
 
-  /** DOCUMENT ME!! */
+  /** Indicates if annotation has a graphical symbol track */
   public boolean hasIcons; //
 
-  /** DOCUMENT ME!! */
+  /** Indicates if annotation has a text character label */
   public boolean hasText;
 
-  /** DOCUMENT ME!! */
+  /** is the row visible */
   public boolean visible = true;
 
   public int graphGroup = -1;
 
-  /** DOCUMENT ME!! */
+  /** Displayed height of row in pixels */
   public int height = 0;
 
   public int graph = 0;
@@ -98,6 +100,34 @@ public class AlignmentAnnotation
 
   public boolean belowAlignment = true;
 
+  public SequenceGroup groupRef = null;
+
+  /**
+   * display every column label, even if there is a row of identical labels
+   */
+  public boolean showAllColLabels = false;
+
+  /**
+   * scale the column label to fit within the alignment column.
+   */
+  public boolean scaleColLabel = false;
+
+  /**
+   * centre the column labels relative to the alignment column
+   */
+  public boolean centreColLabels = false;
+
+  /*
+   * (non-Javadoc)
+   * 
+   * @see java.lang.Object#finalize()
+   */
+  protected void finalize() throws Throwable
+  {
+    sequenceRef = null;
+    groupRef = null;
+    super.finalize();
+  }
 
   public static int getGraphValueFromString(String string)
   {
@@ -117,13 +147,16 @@ public class AlignmentAnnotation
 
   /**
    * Creates a new AlignmentAnnotation object.
-   *
-   * @param label short label shown under sequence labels
-   * @param description text displayed on mouseover
-   * @param annotations set of positional annotation elements
+   * 
+   * @param label
+   *          short label shown under sequence labels
+   * @param description
+   *          text displayed on mouseover
+   * @param annotations
+   *          set of positional annotation elements
    */
   public AlignmentAnnotation(String label, String description,
-                             Annotation[] annotations)
+          Annotation[] annotations)
   {
     // always editable?
     editable = true;
@@ -131,44 +164,56 @@ public class AlignmentAnnotation
     this.description = description;
     this.annotations = annotations;
 
-     validateRangeAndDisplay();
+    validateRangeAndDisplay();
   }
 
   void areLabelsSecondaryStructure()
   {
     boolean nonSSLabel = false;
-    char firstChar=0;
+    char firstChar = 0;
     for (int i = 0; i < annotations.length; i++)
     {
       if (annotations[i] == null)
       {
         continue;
       }
-      if (annotations[i].secondaryStructure == 'H' ||
-          annotations[i].secondaryStructure == 'E')
+      if (annotations[i].secondaryStructure == 'H'
+              || annotations[i].secondaryStructure == 'E')
       {
-          hasIcons = true;
+        hasIcons |= true;
       }
 
-      if(annotations[i].displayCharacter==null)
+      if (annotations[i].displayCharacter == null)
       {
         continue;
       }
       if (annotations[i].displayCharacter.length() == 1)
-      {      
+      {
         firstChar = annotations[i].displayCharacter.charAt(0);
-        // check to see if it looks like a sequence or is secondary structure labelling.
-        if (
-                // Uncomment to only catch case where displayCharacter==secondary Structure 
-              // to correctly redisplay SS annotation imported from Stockholm, exported to JalviewXML and read back in again.
-          // && annotations[i].displayCharacter.charAt(0)==annotations[i].secondaryStructure
-          firstChar!='H'
-          && firstChar!='E'
-          && firstChar!='-'
-          && firstChar!='-' && firstChar<jalview.schemes.ResidueProperties.aaIndex.length)
+        // check to see if it looks like a sequence or is secondary structure
+        // labelling.
+        if (annotations[i].secondaryStructure != ' '
+                && !hasIcons
+                &&
+                // Uncomment to only catch case where
+                // displayCharacter==secondary
+                // Structure
+                // to correctly redisplay SS annotation imported from Stockholm,
+                // exported to JalviewXML and read back in again.
+                // &&
+                // annotations[i].displayCharacter.charAt(0)==annotations[i].secondaryStructure
+                firstChar != ' '
+                && firstChar != 'H'
+                && firstChar != 'E'
+                && firstChar != '-'
+                && firstChar < jalview.schemes.ResidueProperties.aaIndex.length)
         {
-          if (jalview.schemes.ResidueProperties.aaIndex
-                  [firstChar] < 23)
+          if (jalview.schemes.ResidueProperties.aaIndex[firstChar] < 23) // TODO:
+                                                                         // parameterise
+                                                                         // to
+                                                                         // gap
+                                                                         // symbol
+                                                                         // number
           {
             nonSSLabel = true;
           }
@@ -186,10 +231,11 @@ public class AlignmentAnnotation
       hasIcons = false;
       for (int j = 0; j < annotations.length; j++)
       {
-        if (annotations[j] != null && annotations[j].secondaryStructure != ' ')
+        if (annotations[j] != null
+                && annotations[j].secondaryStructure != ' ')
         {
-          annotations[j].displayCharacter
-              = String.valueOf(annotations[j].secondaryStructure);
+          annotations[j].displayCharacter = String
+                  .valueOf(annotations[j].secondaryStructure);
           annotations[j].secondaryStructure = ' ';
         }
 
@@ -198,22 +244,28 @@ public class AlignmentAnnotation
 
     annotationId = this.hashCode() + "";
   }
+
   /**
    * Creates a new AlignmentAnnotation object.
-   *
-   * @param label DOCUMENT ME!
-   * @param description DOCUMENT ME!
-   * @param annotations DOCUMENT ME!
-   * @param min DOCUMENT ME!
-   * @param max DOCUMENT ME!
-   * @param winLength DOCUMENT ME!
+   * 
+   * @param label
+   *          DOCUMENT ME!
+   * @param description
+   *          DOCUMENT ME!
+   * @param annotations
+   *          DOCUMENT ME!
+   * @param min
+   *          DOCUMENT ME!
+   * @param max
+   *          DOCUMENT ME!
+   * @param winLength
+   *          DOCUMENT ME!
    */
   public AlignmentAnnotation(String label, String description,
-                             Annotation[] annotations, float min, float max,
-                             int graphType)
+          Annotation[] annotations, float min, float max, int graphType)
   {
     // graphs are not editable
-    editable = graphType==0;
+    editable = graphType == 0;
 
     this.label = label;
     this.description = description;
@@ -223,18 +275,17 @@ public class AlignmentAnnotation
     graphMax = max;
     validateRangeAndDisplay();
   }
+
   /**
-   * checks graphMin and graphMax,
-   * secondary structure symbols,
-   * sets graphType appropriately,
-   * sets null labels to the empty string
-   * if appropriate.
+   * checks graphMin and graphMax, secondary structure symbols, sets graphType
+   * appropriately, sets null labels to the empty string if appropriate.
    */
-  private void validateRangeAndDisplay() {
+  private void validateRangeAndDisplay()
+  {
 
-    if (annotations==null)
+    if (annotations == null)
     {
-      visible=false; // try to prevent renderer from displaying.
+      visible = false; // try to prevent renderer from displaying.
       return; // this is a non-annotation row annotation - ie a sequence score.
     }
 
@@ -253,9 +304,8 @@ public class AlignmentAnnotation
           continue;
         }
 
-        if (drawValues
-            && annotations[i].displayCharacter!=null
-            && annotations[i].displayCharacter.length() > 1)
+        if (drawValues && annotations[i].displayCharacter != null
+                && annotations[i].displayCharacter.length() > 1)
         {
           drawValues = false;
         }
@@ -270,6 +320,18 @@ public class AlignmentAnnotation
           min = annotations[i].value;
         }
       }
+      // ensure zero is origin for min/max ranges on only one side of zero
+      if (min > 0)
+      {
+        min = 0;
+      }
+      else
+      {
+        if (max < 0)
+        {
+          max = 0;
+        }
+      }
     }
 
     graphMin = min;
@@ -290,8 +352,9 @@ public class AlignmentAnnotation
   }
 
   /**
-   * Copy constructor
-   * creates a new independent annotation row with the same associated sequenceRef
+   * Copy constructor creates a new independent annotation row with the same
+   * associated sequenceRef
+   * 
    * @param annotation
    */
   public AlignmentAnnotation(AlignmentAnnotation annotation)
@@ -304,6 +367,7 @@ public class AlignmentAnnotation
     this.graph = annotation.graph;
     this.graphHeight = annotation.graphHeight;
     this.graphGroup = annotation.graphGroup;
+    this.groupRef = annotation.groupRef;
     this.editable = annotation.editable;
     this.autoCalculated = annotation.autoCalculated;
     this.hasIcons = annotation.hasIcons;
@@ -316,39 +380,47 @@ public class AlignmentAnnotation
     {
       this.score = annotation.score;
     }
-    if (threshold!=null) {
+    if (annotation.threshold != null)
+    {
       threshold = new GraphLine(annotation.threshold);
     }
-    if (annotation.annotations!=null) {
+    if (annotation.annotations != null)
+    {
       Annotation[] ann = annotation.annotations;
       this.annotations = new Annotation[ann.length];
-      for (int i=0; i<ann.length; i++) {
+      for (int i = 0; i < ann.length; i++)
+      {
         annotations[i] = new Annotation(ann[i]);
-      };
-      if (annotation.sequenceRef!=null) {
+      }
+      ;
+      if (annotation.sequenceRef != null)
+      {
         this.sequenceRef = annotation.sequenceRef;
-        if (annotation.sequenceMapping!=null)
+        if (annotation.sequenceMapping != null)
         {
-          Integer p=null;
+          Integer p = null;
           sequenceMapping = new Hashtable();
-          Enumeration pos=annotation.sequenceMapping.keys();
-          while (pos.hasMoreElements()) {
+          Enumeration pos = annotation.sequenceMapping.keys();
+          while (pos.hasMoreElements())
+          {
             // could optimise this!
             p = (Integer) pos.nextElement();
             Annotation a = (Annotation) annotation.sequenceMapping.get(p);
-            if (a==null)
+            if (a == null)
             {
               continue;
             }
-            for (int i=0; i<ann.length; i++)
+            for (int i = 0; i < ann.length; i++)
             {
-              if (ann[i]==a)
+              if (ann[i] == a)
               {
                 sequenceMapping.put(p, annotations[i]);
               }
             }
           }
-        } else {
+        }
+        else
+        {
           this.sequenceMapping = null;
         }
       }
@@ -359,41 +431,44 @@ public class AlignmentAnnotation
   /**
    * clip the annotation to the columns given by startRes and endRes (inclusive)
    * and prune any existing sequenceMapping to just those columns.
+   * 
    * @param startRes
    * @param endRes
    */
   public void restrict(int startRes, int endRes)
   {
-    if (annotations==null)
+    if (annotations == null)
     {
       // non-positional
       return;
     }
-    if (startRes<0)
-      startRes=0;
-    if (startRes>=annotations.length)
-      startRes = annotations.length-1;
-    if (endRes>=annotations.length)
-      endRes = annotations.length-1;
-    if (annotations==null)
+    if (startRes < 0)
+      startRes = 0;
+    if (startRes >= annotations.length)
+      startRes = annotations.length - 1;
+    if (endRes >= annotations.length)
+      endRes = annotations.length - 1;
+    if (annotations == null)
       return;
-    Annotation[] temp = new Annotation[endRes-startRes+1];
-    if (startRes<annotations.length)
+    Annotation[] temp = new Annotation[endRes - startRes + 1];
+    if (startRes < annotations.length)
     {
-      System.arraycopy(annotations, startRes, temp, 0, endRes-startRes+1);
+      System.arraycopy(annotations, startRes, temp, 0, endRes - startRes
+              + 1);
     }
-    if (sequenceRef!=null) {
+    if (sequenceRef != null)
+    {
       // Clip the mapping, if it exists.
       int spos = sequenceRef.findPosition(startRes);
       int epos = sequenceRef.findPosition(endRes);
-      if (sequenceMapping!=null)
+      if (sequenceMapping != null)
       {
         Hashtable newmapping = new Hashtable();
         Enumeration e = sequenceMapping.keys();
         while (e.hasMoreElements())
         {
           Integer pos = (Integer) e.nextElement();
-          if (pos.intValue()>=spos && pos.intValue()<=epos)
+          if (pos.intValue() >= spos && pos.intValue() <= epos)
           {
             newmapping.put(pos, sequenceMapping.get(pos));
           }
@@ -402,32 +477,37 @@ public class AlignmentAnnotation
         sequenceMapping = newmapping;
       }
     }
-    annotations=temp;
+    annotations = temp;
   }
+
   /**
    * set the annotation row to be at least length Annotations
-   * @param length minimum number of columns required in the annotation row
+   * 
+   * @param length
+   *          minimum number of columns required in the annotation row
    * @return false if the annotation row is greater than length
    */
-  public boolean padAnnotation(int length) {
-    if (annotations==null)
+  public boolean padAnnotation(int length)
+  {
+    if (annotations == null)
     {
-      return true; // annotation row is correct - null == not visible and undefined length
+      return true; // annotation row is correct - null == not visible and
+      // undefined length
     }
-    if (annotations.length<length)
+    if (annotations.length < length)
     {
       Annotation[] na = new Annotation[length];
       System.arraycopy(annotations, 0, na, 0, annotations.length);
       annotations = na;
       return true;
     }
-    return annotations.length>length;
+    return annotations.length > length;
 
   }
 
   /**
    * DOCUMENT ME!
-   *
+   * 
    * @return DOCUMENT ME!
    */
   public String toString()
@@ -454,8 +534,8 @@ public class AlignmentAnnotation
 
       buffer.append(", ");
     }
-
-    if (label.equals("Consensus"))
+    // TODO: remove disgusting hack for 'special' treatment of consensus line.
+    if (label.indexOf("Consensus") == 0)
     {
       buffer.append("\n");
 
@@ -484,22 +564,24 @@ public class AlignmentAnnotation
   }
 
   /**
-   * Attach the annotation to seqRef, starting from startRes position. If alreadyMapped is true then the indices of the annotation[] array are sequence positions rather than alignment column positions.
+   * Attach the annotation to seqRef, starting from startRes position. If
+   * alreadyMapped is true then the indices of the annotation[] array are
+   * sequence positions rather than alignment column positions.
+   * 
    * @param seqRef
    * @param startRes
    * @param alreadyMapped
    */
-  public void createSequenceMapping(SequenceI seqRef,
-                                    int startRes,
-                                    boolean alreadyMapped)
+  public void createSequenceMapping(SequenceI seqRef, int startRes,
+          boolean alreadyMapped)
   {
 
     if (seqRef == null)
     {
       return;
     }
-    sequenceRef=seqRef;
-    if (annotations==null)
+    sequenceRef = seqRef;
+    if (annotations == null)
     {
       return;
     }
@@ -528,10 +610,10 @@ public class AlignmentAnnotation
 
   public void adjustForAlignment()
   {
-    if (sequenceRef==null)
+    if (sequenceRef == null)
       return;
 
-    if (annotations==null)
+    if (annotations == null)
     {
       return;
     }
@@ -540,7 +622,7 @@ public class AlignmentAnnotation
 
     if (aSize == 0)
     {
-      //Its been deleted
+      // Its been deleted
       return;
     }
 
@@ -561,20 +643,27 @@ public class AlignmentAnnotation
 
     annotations = temp;
   }
+
   /**
-   * remove any null entries in annotation row and return the
-   * number of non-null annotation elements.
+   * remove any null entries in annotation row and return the number of non-null
+   * annotation elements.
+   * 
    * @return
    */
-  public int compactAnnotationArray() {
-    int i=0,iSize=annotations.length;
-    while (i<iSize)
+  public int compactAnnotationArray()
+  {
+    int i = 0, iSize = annotations.length;
+    while (i < iSize)
     {
-      if (annotations[i]==null) {
-        if (i+1<iSize)
-          System.arraycopy(annotations, i+1, annotations, i, iSize-i-1);
+      if (annotations[i] == null)
+      {
+        if (i + 1 < iSize)
+          System.arraycopy(annotations, i + 1, annotations, i, iSize - i
+                  - 1);
         iSize--;
-      } else {
+      }
+      else
+      {
         i++;
       }
     }
@@ -587,10 +676,12 @@ public class AlignmentAnnotation
 
   /**
    * Associate this annotion with the aligned residues of a particular sequence.
-   * sequenceMapping will be updated in the following way:
-   *   null sequenceI - existing mapping will be discarded but annotations left in mapped positions.
-   *   valid sequenceI not equal to current sequenceRef: mapping is discarded and rebuilt assuming 1:1 correspondence
-   *   TODO: overload with parameter to specify correspondence between current and new sequenceRef
+   * sequenceMapping will be updated in the following way: null sequenceI -
+   * existing mapping will be discarded but annotations left in mapped
+   * positions. valid sequenceI not equal to current sequenceRef: mapping is
+   * discarded and rebuilt assuming 1:1 correspondence TODO: overload with
+   * parameter to specify correspondence between current and new sequenceRef
+   * 
    * @param sequenceI
    */
   public void setSequenceRef(SequenceI sequenceI)
@@ -599,7 +690,10 @@ public class AlignmentAnnotation
     {
       if (sequenceRef != null)
       {
-        if (sequenceRef != sequenceI && !sequenceRef.equals(sequenceI) && sequenceRef.getDatasetSequence()!=sequenceI.getDatasetSequence())
+        if (sequenceRef != sequenceI
+                && !sequenceRef.equals(sequenceI)
+                && sequenceRef.getDatasetSequence() != sequenceI
+                        .getDatasetSequence())
         {
           // if sequenceRef isn't intersecting with sequenceI
           // throw away old mapping and reconstruct.
@@ -642,23 +736,27 @@ public class AlignmentAnnotation
   }
 
   /**
-   * @param score the score to set
+   * @param score
+   *          the score to set
    */
   public void setScore(double score)
   {
-    hasScore=true;
+    hasScore = true;
     this.score = score;
   }
+
   /**
-   *
+   * 
    * @return true if annotation has an associated score
    */
   public boolean hasScore()
   {
     return hasScore || !Double.isNaN(score);
   }
+
   /**
    * Score only annotation
+   * 
    * @param label
    * @param description
    * @param score
@@ -668,8 +766,10 @@ public class AlignmentAnnotation
     this(label, description, null);
     setScore(score);
   }
+
   /**
    * copy constructor with edit based on the hidden columns marked in colSel
+   * 
    * @param alignmentAnnotation
    * @param colSel
    */
@@ -677,7 +777,7 @@ public class AlignmentAnnotation
           ColumnSelection colSel)
   {
     this(alignmentAnnotation);
-    if (annotations==null)
+    if (annotations == null)
     {
       return;
     }
@@ -687,29 +787,39 @@ public class AlignmentAnnotation
   public void setPadGaps(boolean padgaps, char gapchar)
   {
     this.padGaps = padgaps;
-    if(padgaps)
+    if (padgaps)
     {
       hasText = true;
-      for(int i=0; i<annotations.length; i++)
+      for (int i = 0; i < annotations.length; i++)
       {
-        if(annotations[i]==null)
-          annotations[i] = new Annotation(String.valueOf(gapchar),null,' ',0f);
-        else if(annotations[i].displayCharacter==null ||annotations[i].displayCharacter.equals(" "))
-          annotations[i].displayCharacter=String.valueOf(gapchar);
+        if (annotations[i] == null)
+          annotations[i] = new Annotation(String.valueOf(gapchar), null,
+                  ' ', 0f);
+        else if (annotations[i].displayCharacter == null
+                || annotations[i].displayCharacter.equals(" "))
+          annotations[i].displayCharacter = String.valueOf(gapchar);
       }
     }
   }
 
   /**
    * format description string for display
+   * 
    * @param seqname
-   * @return Get the annotation description string optionally prefixed by associated sequence name (if any) 
+   * @return Get the annotation description string optionally prefixed by
+   *         associated sequence name (if any)
    */
   public String getDescription(boolean seqname)
   {
-    if (seqname && this.sequenceRef!=null)
+    if (seqname && this.sequenceRef != null)
     {
-      return sequenceRef.getName()+" : "+description;
+      int i=description.toLowerCase().indexOf("<html>");
+      if (i>-1)
+      {
+        // move the html tag to before the sequence reference.
+        return "<html>"+sequenceRef.getName()+" : "+description.substring(i+6);
+      }
+      return sequenceRef.getName() + " : " + description;
     }
     return description;
   }