src/jalview/datamodel/AlignmentAnnotation.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.datamodel;
  22
  23 import jalview.analysis.Rna;
  24 import jalview.analysis.SecStrConsensus.SimpleBP;
  25 import jalview.analysis.WUSSParseException;
  26
  27 import java.util.ArrayList;
  28 import java.util.Enumeration;
  29 import java.util.HashMap;
  30 import java.util.Hashtable;
  31 import java.util.Map;
  32 import java.util.Map.Entry;
  33
  34 /**
  35  * DOCUMENT ME!
  36  *
  37  * @author $author$
  38  * @version $Revision$
  39  */
  40 public class AlignmentAnnotation
  41 {
  42   /**
  43    * If true, this annotations is calculated every edit, eg consensus, quality
  44    * or conservation graphs
  45    */
  46   public boolean autoCalculated = false;
  47
  48   /**
  49    * unique ID for this annotation, used to match up the same annotation row
  50    * shown in multiple views and alignments
  51    */
  52   public String annotationId;
  53
  54   /**
  55    * the sequence this annotation is associated with (or null)
  56    */
  57   public SequenceI sequenceRef;
  58
  59   /** label shown in dropdown menus and in the annotation label area */
  60   public String label;
  61
  62   /** longer description text shown as a tooltip */
  63   public String description;
  64
  65   /** Array of annotations placed in the current coordinate system */
  66   public Annotation[] annotations;
  67
  68   public ArrayList<SimpleBP> bps = null;
  69
  70   /**
  71    * RNA secondary structure contact positions
  72    */
  73   public SequenceFeature[] _rnasecstr = null;
  74
  75   /**
  76    * position of annotation resulting in invalid WUSS parsing or -1
  77    */
  78   private long invalidrnastruc = -1;
  79
  80   /**
  81    * Updates the _rnasecstr field Determines the positions that base pair and
  82    * the positions of helices based on secondary structure from a Stockholm file
  83    *
  84    * @param RNAannot
  85    */
  86   private void _updateRnaSecStr(CharSequence RNAannot)
  87   {
  88     try
  89     {
  90       _rnasecstr = Rna.GetBasePairs(RNAannot);
  91       bps = Rna.GetModeleBP(RNAannot);
  92       invalidrnastruc = -1;
  93     } catch (WUSSParseException px)
  94     {
  95       // DEBUG System.out.println(px);
  96       invalidrnastruc = px.getProblemPos();
  97     }
  98     if (invalidrnastruc > -1)
  99     {
 100       return;
 101     }
 102     Rna.HelixMap(_rnasecstr);
 103     // setRNAStruc(RNAannot);
 104
 105     if (_rnasecstr != null && _rnasecstr.length > 0)
 106     {
 107       // show all the RNA secondary structure annotation symbols.
 108       isrna = true;
 109       showAllColLabels = true;
 110       scaleColLabel = true;
 111     }
 112     // System.out.println("featuregroup " + _rnasecstr[0].getFeatureGroup());
 113   }
 114
 115   /**
 116    * map of positions in the associated annotation
 117    */
 118   public java.util.Hashtable<Integer, Annotation> sequenceMapping;
 119
 120   /** DOCUMENT ME!! */
 121   public float graphMin;
 122
 123   /** DOCUMENT ME!! */
 124   public float graphMax;
 125
 126   /**
 127    * Score associated with label and description.
 128    */
 129   public double score = Double.NaN;
 130
 131   /**
 132    * flag indicating if annotation has a score.
 133    */
 134   public boolean hasScore = false;
 135
 136   public GraphLine threshold;
 137
 138   // Graphical hints and tips
 139
 140   /** Can this row be edited by the user ? */
 141   public boolean editable = false;
 142
 143   /** Indicates if annotation has a graphical symbol track */
 144   public boolean hasIcons; //
 145
 146   /** Indicates if annotation has a text character label */
 147   public boolean hasText;
 148
 149   /** is the row visible */
 150   public boolean visible = true;
 151
 152   public int graphGroup = -1;
 153
 154   /** Displayed height of row in pixels */
 155   public int height = 0;
 156
 157   public int graph = 0;
 158
 159   public int graphHeight = 40;
 160
 161   public boolean padGaps = false;
 162
 163   public static final int NO_GRAPH = 0;
 164
 165   public static final int BAR_GRAPH = 1;
 166
 167   public static final int LINE_GRAPH = 2;
 168
 169   public boolean belowAlignment = true;
 170
 171   public SequenceGroup groupRef = null;
 172
 173   /**
 174    * display every column label, even if there is a row of identical labels
 175    */
 176   public boolean showAllColLabels = false;
 177
 178   /**
 179    * scale the column label to fit within the alignment column.
 180    */
 181   public boolean scaleColLabel = false;
 182
 183   /**
 184    * centre the column labels relative to the alignment column
 185    */
 186   public boolean centreColLabels = false;
 187
 188   private boolean isrna;
 189
 190   /*
 191    * (non-Javadoc)
 192    *
 193    * @see java.lang.Object#finalize()
 194    */
 195   protected void finalize() throws Throwable
 196   {
 197     sequenceRef = null;
 198     groupRef = null;
 199     super.finalize();
 200   }
 201
 202   public static int getGraphValueFromString(String string)
 203   {
 204     if (string.equalsIgnoreCase("BAR_GRAPH"))
 205     {
 206       return BAR_GRAPH;
 207     }
 208     else if (string.equalsIgnoreCase("LINE_GRAPH"))
 209     {
 210       return LINE_GRAPH;
 211     }
 212     else
 213     {
 214       return NO_GRAPH;
 215     }
 216   }
 217
 218   // JBPNote: what does this do ?
 219   public void ConcenStru(CharSequence RNAannot) throws WUSSParseException
 220   {
 221     bps = Rna.GetModeleBP(RNAannot);
 222   }
 223
 224   /**
 225    * Creates a new AlignmentAnnotation object.
 226    *
 227    * @param label
 228    *          short label shown under sequence labels
 229    * @param description
 230    *          text displayed on mouseover
 231    * @param annotations
 232    *          set of positional annotation elements
 233    */
 234   public AlignmentAnnotation(String label, String description,
 235           Annotation[] annotations)
 236   {
 237     // always editable?
 238     editable = true;
 239     this.label = label;
 240     this.description = description;
 241     this.annotations = annotations;
 242
 243     validateRangeAndDisplay();
 244   }
 245
 246   /**
 247    * Checks if annotation labels represent secondary structures
 248    *
 249    */
 250   void areLabelsSecondaryStructure()
 251   {
 252     boolean nonSSLabel = false;
 253     isrna = false;
 254     StringBuffer rnastring = new StringBuffer();
 255
 256     char firstChar = 0;
 257     for (int i = 0; i < annotations.length; i++)
 258     {
 259       if (annotations[i] == null)
 260       {
 261         continue;
 262       }
 263       if (annotations[i].secondaryStructure == 'H'
 264               || annotations[i].secondaryStructure == 'E')
 265       {
 266         hasIcons |= true;
 267       }
 268       else
 269       // Check for RNA secondary structure
 270       {
 271         // System.out.println(annotations[i].secondaryStructure);
 272         // TODO: 2.8.2 should this ss symbol validation check be a function in
 273         // RNA/ResidueProperties ?
 274         if (annotations[i].secondaryStructure == '('
 275                 || annotations[i].secondaryStructure == '['
 276                 || annotations[i].secondaryStructure == '<'
 277                 || annotations[i].secondaryStructure == '{'
 278                 || annotations[i].secondaryStructure == 'A'
 279                 || annotations[i].secondaryStructure == 'B'
 280                 || annotations[i].secondaryStructure == 'C'
 281                 || annotations[i].secondaryStructure == 'D'
 282                 || annotations[i].secondaryStructure == 'E'
 283                 || annotations[i].secondaryStructure == 'F'
 284                 || annotations[i].secondaryStructure == 'G'
 285                 || annotations[i].secondaryStructure == 'H'
 286                 || annotations[i].secondaryStructure == 'I'
 287                 || annotations[i].secondaryStructure == 'J'
 288                 || annotations[i].secondaryStructure == 'K'
 289                 || annotations[i].secondaryStructure == 'L'
 290                 || annotations[i].secondaryStructure == 'M'
 291                 || annotations[i].secondaryStructure == 'N'
 292                 || annotations[i].secondaryStructure == 'O'
 293                 || annotations[i].secondaryStructure == 'P'
 294                 || annotations[i].secondaryStructure == 'Q'
 295                 || annotations[i].secondaryStructure == 'R'
 296                 || annotations[i].secondaryStructure == 'S'
 297                 || annotations[i].secondaryStructure == 'T'
 298                 || annotations[i].secondaryStructure == 'U'
 299                 || annotations[i].secondaryStructure == 'V'
 300                 || annotations[i].secondaryStructure == 'W'
 301                 || annotations[i].secondaryStructure == 'X'
 302                 || annotations[i].secondaryStructure == 'Y'
 303                 || annotations[i].secondaryStructure == 'Z')
 304         {
 305           hasIcons |= true;
 306           isrna |= true;
 307         }
 308       }
 309
 310       // System.out.println("displaychar " + annotations[i].displayCharacter);
 311
 312       if (annotations[i].displayCharacter == null
 313               || annotations[i].displayCharacter.length() == 0)
 314       {
 315         rnastring.append('.');
 316         continue;
 317       }
 318       if (annotations[i].displayCharacter.length() == 1)
 319       {
 320         firstChar = annotations[i].displayCharacter.charAt(0);
 321         // check to see if it looks like a sequence or is secondary structure
 322         // labelling.
 323         if (annotations[i].secondaryStructure != ' '
 324                 && !hasIcons
 325                 &&
 326                 // Uncomment to only catch case where
 327                 // displayCharacter==secondary
 328                 // Structure
 329                 // to correctly redisplay SS annotation imported from Stockholm,
 330                 // exported to JalviewXML and read back in again.
 331                 // &&
 332                 // annotations[i].displayCharacter.charAt(0)==annotations[i].secondaryStructure
 333                 firstChar != ' '
 334                 && firstChar != '$'
 335                 && firstChar != 0xCE
 336                 && firstChar != '('
 337                 && firstChar != '['
 338                 && firstChar != '>'
 339                 && firstChar != '{'
 340                 && firstChar != 'A'
 341                 && firstChar != 'B'
 342                 && firstChar != 'C'
 343                 && firstChar != 'D'
 344                 && firstChar != 'E'
 345                 && firstChar != 'F'
 346                 && firstChar != 'G'
 347                 && firstChar != 'H'
 348                 && firstChar != 'I'
 349                 && firstChar != 'J'
 350                 && firstChar != 'K'
 351                 && firstChar != 'L'
 352                 && firstChar != 'M'
 353                 && firstChar != 'N'
 354                 && firstChar != 'O'
 355                 && firstChar != 'P'
 356                 && firstChar != 'Q'
 357                 && firstChar != 'R'
 358                 && firstChar != 'S'
 359                 && firstChar != 'T'
 360                 && firstChar != 'U'
 361                 && firstChar != 'V'
 362                 && firstChar != 'W'
 363                 && firstChar != 'X'
 364                 && firstChar != 'Y'
 365                 && firstChar != 'Z'
 366                 && firstChar != '-'
 367                 && firstChar < jalview.schemes.ResidueProperties.aaIndex.length)
 368         {
 369           if (jalview.schemes.ResidueProperties.aaIndex[firstChar] < 23) // TODO:
 370                                                                          // parameterise
 371                                                                          // to
 372                                                                          // gap
 373                                                                          // symbol
 374                                                                          // number
 375           {
 376             nonSSLabel = true;
 377           }
 378         }
 379       }
 380       else
 381       {
 382         rnastring.append(annotations[i].displayCharacter.charAt(1));
 383       }
 384
 385       if (annotations[i].displayCharacter.length() > 0)
 386       {
 387         hasText = true;
 388       }
 389     }
 390
 391     if (nonSSLabel)
 392     {
 393       hasIcons = false;
 394       for (int j = 0; j < annotations.length; j++)
 395       {
 396         if (annotations[j] != null
 397                 && annotations[j].secondaryStructure != ' ')
 398         {
 399           annotations[j].displayCharacter = String
 400                   .valueOf(annotations[j].secondaryStructure);
 401           annotations[j].secondaryStructure = ' ';
 402         }
 403
 404       }
 405     }
 406     else
 407     {
 408       if (isrna)
 409       {
 410         _updateRnaSecStr(new AnnotCharSequence());
 411       }
 412     }
 413
 414     annotationId = this.hashCode() + "";
 415   }
 416
 417   /**
 418    * flyweight access to positions in the alignment annotation row for RNA
 419    * processing
 420    *
 421    * @author jimp
 422    *
 423    */
 424   private class AnnotCharSequence implements CharSequence
 425   {
 426     int offset = 0;
 427
 428     int max = 0;
 429
 430     public AnnotCharSequence()
 431     {
 432       this(0, annotations.length);
 433     }
 434
 435     public AnnotCharSequence(int start, int end)
 436     {
 437       offset = start;
 438       max = end;
 439     }
 440
 441     @Override
 442     public CharSequence subSequence(int start, int end)
 443     {
 444       return new AnnotCharSequence(offset + start, offset + end);
 445     }
 446
 447     @Override
 448     public int length()
 449     {
 450       return max - offset;
 451     }
 452
 453     @Override
 454     public char charAt(int index)
 455     {
 456       String dc;
 457       return ((index + offset < 0) || (index + offset) >= max
 458               || annotations[index + offset] == null || (dc = annotations[index
 459               + offset].displayCharacter.trim()).length() < 1) ? '.' : dc
 460               .charAt(0);
 461     }
 462
 463     public String toString()
 464     {
 465       char[] string = new char[max - offset];
 466       int mx = annotations.length;
 467
 468       for (int i = offset; i < mx; i++)
 469       {
 470         String dc;
 471         string[i] = (annotations[i] == null || (dc = annotations[i].displayCharacter
 472                 .trim()).length() < 1) ? '.' : dc.charAt(0);
 473       }
 474       return new String(string);
 475     }
 476   };
 477
 478   private long _lastrnaannot = -1;
 479
 480   public String getRNAStruc()
 481   {
 482     if (isrna)
 483     {
 484       String rnastruc = new AnnotCharSequence().toString();
 485       if (_lastrnaannot != rnastruc.hashCode())
 486       {
 487         // ensure rna structure contacts are up to date
 488         _lastrnaannot = rnastruc.hashCode();
 489         _updateRnaSecStr(rnastruc);
 490       }
 491       return rnastruc;
 492     }
 493     return null;
 494   }
 495
 496   /**
 497    * Creates a new AlignmentAnnotation object.
 498    *
 499    * @param label
 500    *          DOCUMENT ME!
 501    * @param description
 502    *          DOCUMENT ME!
 503    * @param annotations
 504    *          DOCUMENT ME!
 505    * @param min
 506    *          DOCUMENT ME!
 507    * @param max
 508    *          DOCUMENT ME!
 509    * @param winLength
 510    *          DOCUMENT ME!
 511    */
 512   public AlignmentAnnotation(String label, String description,
 513           Annotation[] annotations, float min, float max, int graphType)
 514   {
 515     // graphs are not editable
 516     editable = graphType == 0;
 517
 518     this.label = label;
 519     this.description = description;
 520     this.annotations = annotations;
 521     graph = graphType;
 522     graphMin = min;
 523     graphMax = max;
 524     validateRangeAndDisplay();
 525   }
 526
 527   /**
 528    * checks graphMin and graphMax, secondary structure symbols, sets graphType
 529    * appropriately, sets null labels to the empty string if appropriate.
 530    */
 531   public void validateRangeAndDisplay()
 532   {
 533
 534     if (annotations == null)
 535     {
 536       visible = false; // try to prevent renderer from displaying.
 537       return; // this is a non-annotation row annotation - ie a sequence score.
 538     }
 539
 540     int graphType = graph;
 541     float min = graphMin;
 542     float max = graphMax;
 543     boolean drawValues = true;
 544     _linecolour = null;
 545     if (min == max)
 546     {
 547       min = 999999999;
 548       for (int i = 0; i < annotations.length; i++)
 549       {
 550         if (annotations[i] == null)
 551         {
 552           continue;
 553         }
 554
 555         if (drawValues && annotations[i].displayCharacter != null
 556                 && annotations[i].displayCharacter.length() > 1)
 557         {
 558           drawValues = false;
 559         }
 560
 561         if (annotations[i].value > max)
 562         {
 563           max = annotations[i].value;
 564         }
 565
 566         if (annotations[i].value < min)
 567         {
 568           min = annotations[i].value;
 569         }
 570         if (_linecolour == null && annotations[i].colour != null)
 571         {
 572           _linecolour = annotations[i].colour;
 573         }
 574       }
 575       // ensure zero is origin for min/max ranges on only one side of zero
 576       if (min > 0)
 577       {
 578         min = 0;
 579       }
 580       else
 581       {
 582         if (max < 0)
 583         {
 584           max = 0;
 585         }
 586       }
 587     }
 588
 589     graphMin = min;
 590     graphMax = max;
 591
 592     areLabelsSecondaryStructure();
 593
 594     if (!drawValues && graphType != NO_GRAPH)
 595     {
 596       for (int i = 0; i < annotations.length; i++)
 597       {
 598         if (annotations[i] != null)
 599         {
 600           annotations[i].displayCharacter = "X";
 601         }
 602       }
 603     }
 604   }
 605
 606   /**
 607    * Copy constructor creates a new independent annotation row with the same
 608    * associated sequenceRef
 609    *
 610    * @param annotation
 611    */
 612   public AlignmentAnnotation(AlignmentAnnotation annotation)
 613   {
 614     this.label = new String(annotation.label);
 615     if (annotation.description != null)
 616     {
 617       this.description = new String(annotation.description);
 618     }
 619     this.graphMin = annotation.graphMin;
 620     this.graphMax = annotation.graphMax;
 621     this.graph = annotation.graph;
 622     this.graphHeight = annotation.graphHeight;
 623     this.graphGroup = annotation.graphGroup;
 624     this.groupRef = annotation.groupRef;
 625     this.editable = annotation.editable;
 626     this.autoCalculated = annotation.autoCalculated;
 627     this.hasIcons = annotation.hasIcons;
 628     this.hasText = annotation.hasText;
 629     this.height = annotation.height;
 630     this.label = annotation.label;
 631     this.padGaps = annotation.padGaps;
 632     this.visible = annotation.visible;
 633     this.centreColLabels = annotation.centreColLabels;
 634     this.scaleColLabel = annotation.scaleColLabel;
 635     this.showAllColLabels = annotation.showAllColLabels;
 636     this.calcId = annotation.calcId;
 637     if (this.hasScore = annotation.hasScore)
 638     {
 639       this.score = annotation.score;
 640     }
 641     if (annotation.threshold != null)
 642     {
 643       threshold = new GraphLine(annotation.threshold);
 644     }
 645     if (annotation.annotations != null)
 646     {
 647       Annotation[] ann = annotation.annotations;
 648       this.annotations = new Annotation[ann.length];
 649       for (int i = 0; i < ann.length; i++)
 650       {
 651         if (ann[i] != null)
 652         {
 653           annotations[i] = new Annotation(ann[i]);
 654           if (_linecolour != null)
 655           {
 656             _linecolour = annotations[i].colour;
 657           }
 658         }
 659       }
 660       ;
 661       if (annotation.sequenceRef != null)
 662       {
 663         this.sequenceRef = annotation.sequenceRef;
 664         if (annotation.sequenceMapping != null)
 665         {
 666           Integer p = null;
 667           sequenceMapping = new Hashtable();
 668           Enumeration pos = annotation.sequenceMapping.keys();
 669           while (pos.hasMoreElements())
 670           {
 671             // could optimise this!
 672             p = (Integer) pos.nextElement();
 673             Annotation a = annotation.sequenceMapping.get(p);
 674             if (a == null)
 675             {
 676               continue;
 677             }
 678             for (int i = 0; i < ann.length; i++)
 679             {
 680               if (ann[i] == a)
 681               {
 682                 sequenceMapping.put(p, annotations[i]);
 683               }
 684             }
 685           }
 686         }
 687         else
 688         {
 689           this.sequenceMapping = null;
 690         }
 691       }
 692     }
 693     // TODO: check if we need to do this: JAL-952
 694     // if (this.isrna=annotation.isrna)
 695     {
 696       // _rnasecstr=new SequenceFeature[annotation._rnasecstr];
 697     }
 698     validateRangeAndDisplay(); // construct hashcodes, etc.
 699   }
 700
 701   /**
 702    * clip the annotation to the columns given by startRes and endRes (inclusive)
 703    * and prune any existing sequenceMapping to just those columns.
 704    *
 705    * @param startRes
 706    * @param endRes
 707    */
 708   public void restrict(int startRes, int endRes)
 709   {
 710     if (annotations == null)
 711     {
 712       // non-positional
 713       return;
 714     }
 715     if (startRes < 0)
 716     {
 717       startRes = 0;
 718     }
 719     if (startRes >= annotations.length)
 720     {
 721       startRes = annotations.length - 1;
 722     }
 723     if (endRes >= annotations.length)
 724     {
 725       endRes = annotations.length - 1;
 726     }
 727     if (annotations == null)
 728     {
 729       return;
 730     }
 731     Annotation[] temp = new Annotation[endRes - startRes + 1];
 732     if (startRes < annotations.length)
 733     {
 734       System.arraycopy(annotations, startRes, temp, 0, endRes - startRes
 735               + 1);
 736     }
 737     if (sequenceRef != null)
 738     {
 739       // Clip the mapping, if it exists.
 740       int spos = sequenceRef.findPosition(startRes);
 741       int epos = sequenceRef.findPosition(endRes);
 742       if (sequenceMapping != null)
 743       {
 744         Hashtable newmapping = new Hashtable();
 745         Enumeration e = sequenceMapping.keys();
 746         while (e.hasMoreElements())
 747         {
 748           Integer pos = (Integer) e.nextElement();
 749           if (pos.intValue() >= spos && pos.intValue() <= epos)
 750           {
 751             newmapping.put(pos, sequenceMapping.get(pos));
 752           }
 753         }
 754         sequenceMapping.clear();
 755         sequenceMapping = newmapping;
 756       }
 757     }
 758     annotations = temp;
 759   }
 760
 761   /**
 762    * set the annotation row to be at least length Annotations
 763    *
 764    * @param length
 765    *          minimum number of columns required in the annotation row
 766    * @return false if the annotation row is greater than length
 767    */
 768   public boolean padAnnotation(int length)
 769   {
 770     if (annotations == null)
 771     {
 772       return true; // annotation row is correct - null == not visible and
 773       // undefined length
 774     }
 775     if (annotations.length < length)
 776     {
 777       Annotation[] na = new Annotation[length];
 778       System.arraycopy(annotations, 0, na, 0, annotations.length);
 779       annotations = na;
 780       return true;
 781     }
 782     return annotations.length > length;
 783
 784   }
 785
 786   /**
 787    * DOCUMENT ME!
 788    *
 789    * @return DOCUMENT ME!
 790    */
 791   public String toString()
 792   {
 793     StringBuffer buffer = new StringBuffer();
 794
 795     for (int i = 0; i < annotations.length; i++)
 796     {
 797       if (annotations[i] != null)
 798       {
 799         if (graph != 0)
 800         {
 801           buffer.append(annotations[i].value);
 802         }
 803         else if (hasIcons)
 804         {
 805           buffer.append(annotations[i].secondaryStructure);
 806         }
 807         else
 808         {
 809           buffer.append(annotations[i].displayCharacter);
 810         }
 811       }
 812
 813       buffer.append(", ");
 814     }
 815     // TODO: remove disgusting hack for 'special' treatment of consensus line.
 816     if (label.indexOf("Consensus") == 0)
 817     {
 818       buffer.append("\n");
 819
 820       for (int i = 0; i < annotations.length; i++)
 821       {
 822         if (annotations[i] != null)
 823         {
 824           buffer.append(annotations[i].description);
 825         }
 826
 827         buffer.append(", ");
 828       }
 829     }
 830
 831     return buffer.toString();
 832   }
 833
 834   public void setThreshold(GraphLine line)
 835   {
 836     threshold = line;
 837   }
 838
 839   public GraphLine getThreshold()
 840   {
 841     return threshold;
 842   }
 843
 844   /**
 845    * Attach the annotation to seqRef, starting from startRes position. If
 846    * alreadyMapped is true then the indices of the annotation[] array are
 847    * sequence positions rather than alignment column positions.
 848    *
 849    * @param seqRef
 850    * @param startRes
 851    * @param alreadyMapped
 852    */
 853   public void createSequenceMapping(SequenceI seqRef, int startRes,
 854           boolean alreadyMapped)
 855   {
 856
 857     if (seqRef == null)
 858     {
 859       return;
 860     }
 861     sequenceRef = seqRef;
 862     if (annotations == null)
 863     {
 864       return;
 865     }
 866     sequenceMapping = new java.util.Hashtable();
 867
 868     int seqPos;
 869
 870     for (int i = 0; i < annotations.length; i++)
 871     {
 872       if (annotations[i] != null)
 873       {
 874         if (alreadyMapped)
 875         {
 876           seqPos = seqRef.findPosition(i);
 877         }
 878         else
 879         {
 880           seqPos = i + startRes;
 881         }
 882
 883         sequenceMapping.put(new Integer(seqPos), annotations[i]);
 884       }
 885     }
 886
 887   }
 888
 889   public void adjustForAlignment()
 890   {
 891     if (sequenceRef == null)
 892     {
 893       return;
 894     }
 895
 896     if (annotations == null)
 897     {
 898       return;
 899     }
 900
 901     int a = 0, aSize = sequenceRef.getLength();
 902
 903     if (aSize == 0)
 904     {
 905       // Its been deleted
 906       return;
 907     }
 908
 909     int position;
 910     Annotation[] temp = new Annotation[aSize];
 911     Integer index;
 912
 913     for (a = sequenceRef.getStart(); a <= sequenceRef.getEnd(); a++)
 914     {
 915       index = new Integer(a);
 916       if (sequenceMapping.containsKey(index))
 917       {
 918         position = sequenceRef.findIndex(a) - 1;
 919
 920         temp[position] = sequenceMapping.get(index);
 921       }
 922     }
 923
 924     annotations = temp;
 925   }
 926
 927   /**
 928    * remove any null entries in annotation row and return the number of non-null
 929    * annotation elements.
 930    *
 931    * @return
 932    */
 933   public int compactAnnotationArray()
 934   {
 935     int i = 0, iSize = annotations.length;
 936     while (i < iSize)
 937     {
 938       if (annotations[i] == null)
 939       {
 940         if (i + 1 < iSize)
 941         {
 942           System.arraycopy(annotations, i + 1, annotations, i, iSize - i
 943                   - 1);
 944         }
 945         iSize--;
 946       }
 947       else
 948       {
 949         i++;
 950       }
 951     }
 952     Annotation[] ann = annotations;
 953     annotations = new Annotation[i];
 954     System.arraycopy(ann, 0, annotations, 0, i);
 955     ann = null;
 956     return iSize;
 957   }
 958
 959   /**
 960    * Associate this annotion with the aligned residues of a particular sequence.
 961    * sequenceMapping will be updated in the following way: null sequenceI -
 962    * existing mapping will be discarded but annotations left in mapped
 963    * positions. valid sequenceI not equal to current sequenceRef: mapping is
 964    * discarded and rebuilt assuming 1:1 correspondence TODO: overload with
 965    * parameter to specify correspondence between current and new sequenceRef
 966    *
 967    * @param sequenceI
 968    */
 969   public void setSequenceRef(SequenceI sequenceI)
 970   {
 971     if (sequenceI != null)
 972     {
 973       if (sequenceRef != null)
 974       {
 975         boolean rIsDs=sequenceRef.getDatasetSequence()==null,tIsDs=sequenceI.getDatasetSequence()==null;
 976         if (sequenceRef != sequenceI
 977                 && (rIsDs && !tIsDs && sequenceRef != sequenceI
 978                         .getDatasetSequence())
 979                 && (!rIsDs && tIsDs && sequenceRef.getDatasetSequence() != sequenceI)
 980                 && (!rIsDs && !tIsDs && sequenceRef.getDatasetSequence() != sequenceI
 981                         .getDatasetSequence())
 982                 && !sequenceRef.equals(sequenceI))
 983         {
 984           // if sequenceRef isn't intersecting with sequenceI
 985           // throw away old mapping and reconstruct.
 986           sequenceRef = null;
 987           if (sequenceMapping != null)
 988           {
 989             sequenceMapping = null;
 990             // compactAnnotationArray();
 991           }
 992           createSequenceMapping(sequenceI, 1, true);
 993           adjustForAlignment();
 994         }
 995         else
 996         {
 997           // Mapping carried over
 998           sequenceRef = sequenceI;
 999         }
1000       }
1001       else
1002       {
1003         // No mapping exists
1004         createSequenceMapping(sequenceI, 1, true);
1005         adjustForAlignment();
1006       }
1007     }
1008     else
1009     {
1010       // throw away the mapping without compacting.
1011       sequenceMapping = null;
1012       sequenceRef = null;
1013     }
1014   }
1015
1016   /**
1017    * @return the score
1018    */
1019   public double getScore()
1020   {
1021     return score;
1022   }
1023
1024   /**
1025    * @param score
1026    *          the score to set
1027    */
1028   public void setScore(double score)
1029   {
1030     hasScore = true;
1031     this.score = score;
1032   }
1033
1034   /**
1035    *
1036    * @return true if annotation has an associated score
1037    */
1038   public boolean hasScore()
1039   {
1040     return hasScore || !Double.isNaN(score);
1041   }
1042
1043   /**
1044    * Score only annotation
1045    *
1046    * @param label
1047    * @param description
1048    * @param score
1049    */
1050   public AlignmentAnnotation(String label, String description, double score)
1051   {
1052     this(label, description, null);
1053     setScore(score);
1054   }
1055
1056   /**
1057    * copy constructor with edit based on the hidden columns marked in colSel
1058    *
1059    * @param alignmentAnnotation
1060    * @param colSel
1061    */
1062   public AlignmentAnnotation(AlignmentAnnotation alignmentAnnotation,
1063           ColumnSelection colSel)
1064   {
1065     this(alignmentAnnotation);
1066     if (annotations == null)
1067     {
1068       return;
1069     }
1070     colSel.makeVisibleAnnotation(this);
1071   }
1072
1073   public void setPadGaps(boolean padgaps, char gapchar)
1074   {
1075     this.padGaps = padgaps;
1076     if (padgaps)
1077     {
1078       hasText = true;
1079       for (int i = 0; i < annotations.length; i++)
1080       {
1081         if (annotations[i] == null)
1082         {
1083           annotations[i] = new Annotation(String.valueOf(gapchar), null,
1084                   ' ', 0f, null);
1085         }
1086         else if (annotations[i].displayCharacter == null
1087                 || annotations[i].displayCharacter.equals(" "))
1088         {
1089           annotations[i].displayCharacter = String.valueOf(gapchar);
1090         }
1091       }
1092     }
1093   }
1094
1095   /**
1096    * format description string for display
1097    *
1098    * @param seqname
1099    * @return Get the annotation description string optionally prefixed by
1100    *         associated sequence name (if any)
1101    */
1102   public String getDescription(boolean seqname)
1103   {
1104     if (seqname && this.sequenceRef != null)
1105     {
1106       int i = description.toLowerCase().indexOf("<html>");
1107       if (i > -1)
1108       {
1109         // move the html tag to before the sequence reference.
1110         return "<html>" + sequenceRef.getName() + " : "
1111                 + description.substring(i + 6);
1112       }
1113       return sequenceRef.getName() + " : " + description;
1114     }
1115     return description;
1116   }
1117
1118   public boolean isValidStruc()
1119   {
1120     return invalidrnastruc == -1;
1121   }
1122
1123   public long getInvalidStrucPos()
1124   {
1125     return invalidrnastruc;
1126   }
1127
1128   /**
1129    * machine readable ID string indicating what generated this annotation
1130    */
1131   protected String calcId = "";
1132
1133   /**
1134    * properties associated with the calcId
1135    */
1136   protected Map<String, String> properties = new HashMap<String, String>();
1137
1138   /**
1139    * base colour for line graphs. If null, will be set automatically by
1140    * searching the alignment annotation
1141    */
1142   public java.awt.Color _linecolour;
1143
1144   public String getCalcId()
1145   {
1146     return calcId;
1147   }
1148
1149   public void setCalcId(String calcId)
1150   {
1151     this.calcId = calcId;
1152   }
1153
1154   public boolean isRNA()
1155   {
1156     return isrna;
1157   }
1158
1159   /**
1160    * transfer annotation to the given sequence using the given mapping from the
1161    * current positions or an existing sequence mapping
1162    *
1163    * @param sq
1164    * @param sp2sq
1165    *          map involving sq as To or From
1166    */
1167   public void liftOver(SequenceI sq, Mapping sp2sq)
1168   {
1169     if (sp2sq.getMappedWidth() != sp2sq.getWidth())
1170     {
1171       // TODO: employ getWord/MappedWord to transfer annotation between cDNA and Protein reference frames
1172       throw new Error("liftOver currently not implemented for transfer of annotation between different types of seqeunce");
1173     }
1174     boolean mapIsTo = (sp2sq != null) ? (sp2sq.getTo() == sq || sp2sq
1175             .getTo() == sq.getDatasetSequence()) : false;
1176
1177     // TODO build a better annotation element map and get rid of annotations[]
1178     Hashtable<Integer, Annotation> mapForsq = new Hashtable();
1179     if (sequenceMapping != null)
1180     {
1181       if (sp2sq != null)
1182       {
1183         for (Entry<Integer, Annotation> ie : sequenceMapping.entrySet())
1184         {
1185           Integer mpos = Integer.valueOf(mapIsTo ? sp2sq
1186                   .getMappedPosition(ie.getKey()) : sp2sq.getPosition(ie
1187                   .getKey()));
1188           if (mpos >= sq.getStart() && mpos <= sq.getEnd())
1189           {
1190             mapForsq.put(mpos, ie.getValue());
1191           }
1192         }
1193         sequenceMapping = mapForsq;
1194         sequenceRef = sq;
1195         adjustForAlignment();
1196       }
1197       else
1198       {
1199         // trim positions
1200       }
1201     }
1202   }
1203
1204   /**
1205    * like liftOver but more general.
1206    *
1207    * Takes an array of int pairs that will be used to update the internal
1208    * sequenceMapping and so shuffle the annotated positions
1209    *
1210    * @param newref
1211    *          - new sequence reference for the annotation row - if null,
1212    *          sequenceRef is left unchanged
1213    * @param mapping
1214    *          array of ints containing corresponding positions
1215    * @param from
1216    *          - column for current coordinate system (-1 for index+1)
1217    * @param to
1218    *          - column for destination coordinate system (-1 for index+1)
1219    * @param idxoffset
1220    *          - offset added to index when referencing either coordinate system
1221    * @note no checks are made as to whether from and/or to are sensible
1222    * @note caller should add the remapped annotation to newref if they have not
1223    *       already
1224    */
1225   public void remap(SequenceI newref, int[][] mapping, int from, int to,
1226           int idxoffset)
1227   {
1228     if (mapping != null)
1229     {
1230       Hashtable<Integer, Annotation> old = sequenceMapping, remap = new Hashtable<Integer, Annotation>();
1231       int index = -1;
1232       for (int mp[] : mapping)
1233       {
1234         if (index++ < 0)
1235         {
1236           continue;
1237         }
1238         Annotation ann = null;
1239         if (from == -1)
1240         {
1241           ann = sequenceMapping.get(Integer.valueOf(idxoffset + index));
1242         }
1243         else
1244         {
1245           if (mp != null && mp.length > from)
1246           {
1247             ann = sequenceMapping.get(Integer.valueOf(mp[from]));
1248           }
1249         }
1250         if (ann != null)
1251         {
1252           if (to == -1)
1253           {
1254             remap.put(Integer.valueOf(idxoffset + index), ann);
1255           }
1256           else
1257           {
1258             if (to > -1 && to < mp.length)
1259             {
1260               remap.put(Integer.valueOf(mp[to]), ann);
1261             }
1262           }
1263         }
1264       }
1265       sequenceMapping = remap;
1266       old.clear();
1267       if (newref != null)
1268       {
1269         sequenceRef = newref;
1270       }
1271       adjustForAlignment();
1272     }
1273   }
1274
1275   public Object getProperty(String property)
1276   {
1277     if (properties == null)
1278     {
1279       return null;
1280     }
1281     return properties.get(property);
1282   }
1283
1284   public void setProperty(String property, String value)
1285   {
1286     if (properties==null)
1287     {
1288       properties = new HashMap<String,String>();
1289     }
1290     properties.put(property, value);
1291   }
1292 }