checks for negative start column in restrict
[jalview.git] / src / jalview / datamodel / AlignmentAnnotation.java
index 8e6d50d..3ed84a3 100755 (executable)
@@ -20,7 +20,6 @@ package jalview.datamodel;
 
 import java.util.Enumeration;
 import java.util.Hashtable;
-import java.util.Vector;
 
 /**
  * DOCUMENT ME!
@@ -55,6 +54,15 @@ public class AlignmentAnnotation
   /** DOCUMENT ME!! */
   public float graphMax;
 
+  /**
+   * Score associated with label and description.
+   */
+  public double score= Double.NaN;
+  /**
+   * flag indicating if annotation has a score.
+   */
+  public boolean hasScore=false;
+
   public GraphLine threshold;
 
   // Graphical hints and tips
@@ -80,12 +88,17 @@ public class AlignmentAnnotation
 
   public int graphHeight = 40;
 
+  public boolean padGaps = false;
+
   public static final int NO_GRAPH = 0;
 
   public static final int BAR_GRAPH = 1;
 
   public static final int LINE_GRAPH = 2;
 
+  public boolean belowAlignment = true;
+
+
   public static int getGraphValueFromString(String string)
   {
     if (string.equalsIgnoreCase("BAR_GRAPH"))
@@ -107,7 +120,8 @@ public class AlignmentAnnotation
    *
    * @param label DOCUMENT ME!
    * @param description DOCUMENT ME!
-   * @param annotations DOCUMENT ME!
+   * @param annotations DOCUMENT ME!about:blank
+Loading...
    */
   public AlignmentAnnotation(String label, String description,
                              Annotation[] annotations)
@@ -118,7 +132,7 @@ public class AlignmentAnnotation
     this.description = description;
     this.annotations = annotations;
 
-    areLabelsSecondaryStructure();
+     validateRangeAndDisplay();
   }
 
   void areLabelsSecondaryStructure()
@@ -130,11 +144,15 @@ public class AlignmentAnnotation
       {
         continue;
       }
-
       if (annotations[i].secondaryStructure == 'H' ||
           annotations[i].secondaryStructure == 'E')
       {
-        hasIcons = true;
+          hasIcons = true;
+      }
+
+      if(annotations[i].displayCharacter==null)
+      {
+        continue;
       }
 
       if (annotations[i].displayCharacter.length() == 1
@@ -142,19 +160,19 @@ public class AlignmentAnnotation
           && !annotations[i].displayCharacter.equals("E")
           && !annotations[i].displayCharacter.equals("-")
           && !annotations[i].displayCharacter.equals("."))
-      {
-        if (jalview.schemes.ResidueProperties.aaIndex
-            [annotations[i].displayCharacter.charAt(0)] < 23)
         {
-          nonSSLabel = true;
+          if (jalview.schemes.ResidueProperties.aaIndex
+                  [annotations[i].displayCharacter.charAt(0)] < 23)
+          {
+            nonSSLabel = true;
+          }
         }
-      }
 
-      if (annotations[i].displayCharacter.length() > 0)
-      {
-        hasText = true;
+        if (annotations[i].displayCharacter.length() > 0)
+        {
+          hasText = true;
+        }
       }
-    }
 
     if (nonSSLabel)
     {
@@ -169,7 +187,6 @@ public class AlignmentAnnotation
         }
 
       }
-
     }
 
     annotationId = this.hashCode() + "";
@@ -189,6 +206,8 @@ public class AlignmentAnnotation
                              int graphType)
   {
     // graphs are not editable
+    editable = graphType==0;
+
     this.label = label;
     this.description = description;
     this.annotations = annotations;
@@ -205,11 +224,18 @@ public class AlignmentAnnotation
    * if appropriate.
    */
   private void validateRangeAndDisplay() {
+
+    if (annotations==null)
+    {
+      visible=false; // try to prevent renderer from displaying.
+      return; // this is a non-annotation row annotation - ie a sequence score.
+    }
+
     int graphType = graph;
     float min = graphMin;
     float max = graphMax;
     boolean drawValues = true;
-    
+
     if (min == max)
     {
       min = 999999999;
@@ -220,7 +246,9 @@ public class AlignmentAnnotation
           continue;
         }
 
-        if (drawValues && annotations[i].displayCharacter.length() > 1)
+        if (drawValues
+            && annotations[i].displayCharacter!=null
+            && annotations[i].displayCharacter.length() > 1)
         {
           drawValues = false;
         }
@@ -253,16 +281,17 @@ public class AlignmentAnnotation
       }
     }
   }
-  
+
   /**
    * Copy constructor
-   * creates a new independent annotation row with the same associated sequenceRef 
+   * creates a new independent annotation row with the same associated sequenceRef
    * @param annotation
    */
   public AlignmentAnnotation(AlignmentAnnotation annotation)
   {
     this.label = new String(annotation.label);
-    this.description = new String(annotation.description);
+    if (annotation.description != null)
+      this.description = new String(annotation.description);
     this.graphMin = annotation.graphMin;
     this.graphMax = annotation.graphMax;
     this.graph = annotation.graph;
@@ -274,29 +303,44 @@ public class AlignmentAnnotation
     this.hasText = annotation.hasText;
     this.height = annotation.height;
     this.label = annotation.label;
+    this.padGaps = annotation.padGaps;
+    this.visible = annotation.visible;
+    if (this.hasScore = annotation.hasScore)
+    {
+      this.score = annotation.score;
+    }
     if (threshold!=null) {
       threshold = new GraphLine(annotation.threshold);
     }
     if (annotation.annotations!=null) {
-      Vector anvec = new Vector();
       Annotation[] ann = annotation.annotations;
       this.annotations = new Annotation[ann.length];
       for (int i=0; i<ann.length; i++) {
         annotations[i] = new Annotation(ann[i]);
-        anvec.addElement(ann[i]); // for lookup if sequenceMapping exists.
       };
       if (annotation.sequenceRef!=null) {
         this.sequenceRef = annotation.sequenceRef;
         if (annotation.sequenceMapping!=null)
         {
+          Integer p=null;
           sequenceMapping = new Hashtable();
           Enumeration pos=annotation.sequenceMapping.keys();
           while (pos.hasMoreElements()) {
-            Integer p = (Integer) pos.nextElement();
-            Annotation a = (Annotation) sequenceMapping.get(p);
-            sequenceMapping.put(p, annotations[anvec.indexOf(a)]); 
+            // could optimise this!
+            p = (Integer) pos.nextElement();
+            Annotation a = (Annotation) annotation.sequenceMapping.get(p);
+            if (a==null)
+            {
+              continue;
+            }
+            for (int i=0; i<ann.length; i++)
+            {
+              if (ann[i]==a)
+              {
+                sequenceMapping.put(p, annotations[i]);
+              }
+            }
           }
-          anvec.removeAllElements();
         } else {
           this.sequenceMapping = null;
         }
@@ -306,6 +350,70 @@ 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 (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)
+    {
+      System.arraycopy(annotations, startRes, temp, 0, endRes-startRes+1);
+    }
+    if (sequenceRef!=null) {
+      // Clip the mapping, if it exists.
+      int spos = sequenceRef.findPosition(startRes);
+      int epos = sequenceRef.findPosition(endRes);
+      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)
+          {
+            newmapping.put(pos, sequenceMapping.get(pos));
+          }
+        }
+        sequenceMapping.clear();
+        sequenceMapping = newmapping;
+      }
+    }
+    annotations=temp;
+  }
+  /**
+   * set the annotation row to be at least length Annotations
+   * @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)
+    {
+      return true; // annotation row is correct - null == not visible and undefined 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;
+
+  }
+
+  /**
    * DOCUMENT ME!
    *
    * @return DOCUMENT ME!
@@ -378,10 +486,13 @@ public class AlignmentAnnotation
     {
       return;
     }
-
+    sequenceRef=seqRef;
+    if (annotations==null)
+    {
+      return;
+    }
     sequenceMapping = new java.util.Hashtable();
 
-    sequenceRef = seqRef;
     int seqPos;
 
     for (int i = 0; i < annotations.length; i++)
@@ -407,7 +518,12 @@ public class AlignmentAnnotation
   {
     if (sequenceRef==null)
       return;
-    
+
+    if (annotations==null)
+    {
+      return;
+    }
+
     int a = 0, aSize = sequenceRef.getLength();
 
     if (aSize == 0)
@@ -451,7 +567,7 @@ public class AlignmentAnnotation
     ann = null;
     return j;
   }
-  
+
   /**
    * Associate this annotion with the aligned residues of a particular sequence.
    * sequenceMapping will be updated in the following way:
@@ -462,31 +578,93 @@ public class AlignmentAnnotation
    */
   public void setSequenceRef(SequenceI sequenceI)
   {
-    if (sequenceI!=null) {
-      if (sequenceRef!=null) {
-        if (sequenceRef!=sequenceI && !sequenceRef.equals(sequenceI)) {
+    if (sequenceI != null)
+    {
+      if (sequenceRef != null)
+      {
+        if (sequenceRef != sequenceI && !sequenceRef.equals(sequenceI) && sequenceRef.getDatasetSequence()!=sequenceI.getDatasetSequence())
+        {
+          // if sequenceRef isn't intersecting with sequenceI
           // throw away old mapping and reconstruct.
-          sequenceRef=null;
-          if (sequenceMapping!=null) 
+          sequenceRef = null;
+          if (sequenceMapping != null)
           {
-            sequenceMapping=null;
+            sequenceMapping = null;
             // compactAnnotationArray();
           }
-          createSequenceMapping(sequenceI, 1,true);
+          createSequenceMapping(sequenceI, 1, true);
           adjustForAlignment();
-        } else {
+        }
+        else
+        {
           // Mapping carried over
           sequenceRef = sequenceI;
         }
-      } else {
+      }
+      else
+      {
         // No mapping exists
         createSequenceMapping(sequenceI, 1, true);
         adjustForAlignment();
       }
-    } else {
+    }
+    else
+    {
       // throw away the mapping without compacting.
-      sequenceMapping=null;
+      sequenceMapping = null;
       sequenceRef = null;
     }
   }
+
+  /**
+   * @return the score
+   */
+  public double getScore()
+  {
+    return score;
+  }
+
+  /**
+   * @param score the score to set
+   */
+  public void setScore(double score)
+  {
+    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
+   */
+  public AlignmentAnnotation(String label, String description, double score)
+  {
+    this(label, description, null);
+    setScore(score);
+  }
+
+  public void setPadGaps(boolean padgaps, char gapchar)
+  {
+    this.padGaps = padgaps;
+    if(padgaps)
+    {
+      hasText = true;
+      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);
+      }
+    }
+  }
 }