src/jalview/datamodel/SequenceGroup.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ 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.AAFrequency;
  24 import jalview.analysis.Conservation;
  25 import jalview.renderer.ResidueShader;
  26 import jalview.renderer.ResidueShaderI;
  27 import jalview.schemes.ColourSchemeI;
  28
  29 import java.awt.Color;
  30 import java.beans.PropertyChangeListener;
  31 import java.beans.PropertyChangeSupport;
  32 import java.util.ArrayList;
  33 import java.util.List;
  34 import java.util.Map;
  35
  36 /**
  37  * Collects a set contiguous ranges on a set of sequences
  38  *
  39  * @author $author$
  40  * @version $Revision$
  41  */
  42 public class SequenceGroup implements AnnotatedCollectionI
  43 {
  44   // TODO ideally this event notification functionality should be separated into
  45   // a
  46   // subclass of ViewportProperties similarly to ViewportRanges. Done here as
  47   // quick fix for JAL-2665
  48   public static final String SEQ_GROUP_CHANGED = "Sequence group changed";
  49
  50   protected PropertyChangeSupport changeSupport = new PropertyChangeSupport(
  51           this);
  52
  53   public void addPropertyChangeListener(PropertyChangeListener listener)
  54   {
  55     changeSupport.addPropertyChangeListener(listener);
  56   }
  57
  58   public void removePropertyChangeListener(PropertyChangeListener listener)
  59   {
  60     changeSupport.removePropertyChangeListener(listener);
  61   }
  62   // end of event notification functionality initialisation
  63
  64   String groupName;
  65
  66   String description;
  67
  68   Conservation conserve;
  69
  70   boolean displayBoxes = true;
  71
  72   boolean displayText = true;
  73
  74   boolean colourText = false;
  75
  76   /**
  77    * True if the group is defined as a group on the alignment, false if it is
  78    * just a selection.
  79    */
  80   boolean isDefined = false;
  81
  82   /**
  83    * after Olivier's non-conserved only character display
  84    */
  85   boolean showNonconserved = false;
  86
  87   /**
  88    * group members
  89    */
  90   private List<SequenceI> sequences = new ArrayList<>();
  91
  92   /**
  93    * representative sequence for this group (if any)
  94    */
  95   private SequenceI seqrep = null;
  96
  97   int width = -1;
  98
  99   /**
 100    * Colourscheme applied to group if any
 101    */
 102   public ResidueShaderI cs;
 103
 104   // start column (base 0)
 105   int startRes = 0;
 106
 107   // end column (base 0)
 108   int endRes = 0;
 109
 110   public Color outlineColour = Color.black;
 111
 112   public Color idColour = null;
 113
 114   public int thresholdTextColour = 0;
 115
 116   public Color textColour = Color.black;
 117
 118   public Color textColour2 = Color.white;
 119
 120   /**
 121    * consensus calculation property
 122    */
 123   private boolean ignoreGapsInConsensus = true;
 124
 125   /**
 126    * consensus calculation property
 127    */
 128   private boolean showSequenceLogo = false;
 129
 130   /**
 131    * flag indicating if logo should be rendered normalised
 132    */
 133   private boolean normaliseSequenceLogo;
 134
 135   /*
 136    * visibility of rows or represented rows covered by group
 137    */
 138   private boolean hidereps = false;
 139
 140   /*
 141    * visibility of columns intersecting this group
 142    */
 143   private boolean hidecols = false;
 144
 145   AlignmentAnnotation consensus = null;
 146
 147   AlignmentAnnotation conservation = null;
 148
 149   private boolean showConsensusHistogram;
 150
 151   private AnnotatedCollectionI context;
 152
 153   /**
 154    * Creates a new SequenceGroup object.
 155    */
 156   public SequenceGroup()
 157   {
 158     groupName = "JGroup:" + this.hashCode();
 159     cs = new ResidueShader();
 160   }
 161
 162   /**
 163    * Creates a new SequenceGroup object.
 164    *
 165    * @param sequences
 166    * @param groupName
 167    * @param scheme
 168    * @param displayBoxes
 169    * @param displayText
 170    * @param colourText
 171    * @param start
 172    *          first column of group
 173    * @param end
 174    *          last column of group
 175    */
 176   public SequenceGroup(List<SequenceI> sequences, String groupName,
 177           ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
 178           boolean colourText, int start, int end)
 179   {
 180     this();
 181     this.sequences = sequences;
 182     this.groupName = groupName;
 183     this.displayBoxes = displayBoxes;
 184     this.displayText = displayText;
 185     this.colourText = colourText;
 186     this.cs = new ResidueShader(scheme);
 187     startRes = start;
 188     endRes = end;
 189     recalcConservation();
 190   }
 191
 192   /**
 193    * copy constructor
 194    *
 195    * @param seqsel
 196    */
 197   public SequenceGroup(SequenceGroup seqsel)
 198   {
 199     this();
 200     if (seqsel != null)
 201     {
 202       sequences = new ArrayList<>();
 203       sequences.addAll(seqsel.sequences);
 204       if (seqsel.groupName != null)
 205       {
 206         groupName = new String(seqsel.groupName);
 207       }
 208       displayBoxes = seqsel.displayBoxes;
 209       displayText = seqsel.displayText;
 210       colourText = seqsel.colourText;
 211       startRes = seqsel.startRes;
 212       endRes = seqsel.endRes;
 213       cs = new ResidueShader((ResidueShader) seqsel.cs);
 214       if (seqsel.description != null)
 215       {
 216         description = new String(seqsel.description);
 217       }
 218       hidecols = seqsel.hidecols;
 219       hidereps = seqsel.hidereps;
 220       showNonconserved = seqsel.showNonconserved;
 221       showSequenceLogo = seqsel.showSequenceLogo;
 222       normaliseSequenceLogo = seqsel.normaliseSequenceLogo;
 223       showConsensusHistogram = seqsel.showConsensusHistogram;
 224       idColour = seqsel.idColour;
 225       outlineColour = seqsel.outlineColour;
 226       seqrep = seqsel.seqrep;
 227       textColour = seqsel.textColour;
 228       textColour2 = seqsel.textColour2;
 229       thresholdTextColour = seqsel.thresholdTextColour;
 230       width = seqsel.width;
 231       ignoreGapsInConsensus = seqsel.ignoreGapsInConsensus;
 232       if (seqsel.conserve != null)
 233       {
 234         recalcConservation(); // safer than
 235         // aaFrequency = (Vector) seqsel.aaFrequency.clone(); // ??
 236       }
 237     }
 238   }
 239
 240   public boolean isShowSequenceLogo()
 241   {
 242     return showSequenceLogo;
 243   }
 244
 245   public SequenceI[] getSelectionAsNewSequences(AlignmentI align)
 246   {
 247     int iSize = sequences.size();
 248     SequenceI[] seqs = new SequenceI[iSize];
 249     SequenceI[] inorder = getSequencesInOrder(align);
 250
 251     for (int i = 0, ipos = 0; i < inorder.length; i++)
 252     {
 253       SequenceI seq = inorder[i];
 254
 255       seqs[ipos] = seq.getSubSequence(startRes, endRes + 1);
 256       if (seqs[ipos] != null)
 257       {
 258         seqs[ipos].setDescription(seq.getDescription());
 259         seqs[ipos].setDBRefs(seq.getDBRefs());
 260         seqs[ipos].setSequenceFeatures(seq.getSequenceFeatures());
 261         if (seq.getDatasetSequence() != null)
 262         {
 263           seqs[ipos].setDatasetSequence(seq.getDatasetSequence());
 264         }
 265
 266         if (seq.getAnnotation() != null)
 267         {
 268           AlignmentAnnotation[] alann = align.getAlignmentAnnotation();
 269           // Only copy annotation that is either a score or referenced by the
 270           // alignment's annotation vector
 271           for (int a = 0; a < seq.getAnnotation().length; a++)
 272           {
 273             AlignmentAnnotation tocopy = seq.getAnnotation()[a];
 274             if (alann != null)
 275             {
 276               boolean found = false;
 277               for (int pos = 0; pos < alann.length; pos++)
 278               {
 279                 if (alann[pos] == tocopy)
 280                 {
 281                   found = true;
 282                   break;
 283                 }
 284               }
 285               if (!found)
 286               {
 287                 continue;
 288               }
 289             }
 290             AlignmentAnnotation newannot = new AlignmentAnnotation(
 291                     seq.getAnnotation()[a]);
 292             newannot.restrict(startRes, endRes);
 293             newannot.setSequenceRef(seqs[ipos]);
 294             newannot.adjustForAlignment();
 295             seqs[ipos].addAlignmentAnnotation(newannot);
 296           }
 297         }
 298         ipos++;
 299       }
 300       else
 301       {
 302         iSize--;
 303       }
 304     }
 305     if (iSize != inorder.length)
 306     {
 307       SequenceI[] nseqs = new SequenceI[iSize];
 308       System.arraycopy(seqs, 0, nseqs, 0, iSize);
 309       seqs = nseqs;
 310     }
 311     return seqs;
 312
 313   }
 314
 315   /**
 316    * If sequence ends in gaps, the end residue can be correctly calculated here
 317    *
 318    * @param seq
 319    *          SequenceI
 320    * @return int
 321    */
 322   public int findEndRes(SequenceI seq)
 323   {
 324     int eres = 0;
 325     char ch;
 326
 327     for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)
 328     {
 329       ch = seq.getCharAt(j);
 330       if (!jalview.util.Comparison.isGap((ch)))
 331       {
 332         eres++;
 333       }
 334     }
 335
 336     if (eres > 0)
 337     {
 338       eres += seq.getStart() - 1;
 339     }
 340
 341     return eres;
 342   }
 343
 344   @Override
 345   public List<SequenceI> getSequences()
 346   {
 347     return sequences;
 348   }
 349
 350   @Override
 351   public List<SequenceI> getSequences(
 352           Map<SequenceI, SequenceCollectionI> hiddenReps)
 353   {
 354     if (hiddenReps == null)
 355     {
 356       // TODO: need a synchronizedCollection here ?
 357       return sequences;
 358     }
 359     else
 360     {
 361       List<SequenceI> allSequences = new ArrayList<>();
 362       for (SequenceI seq : sequences)
 363       {
 364         allSequences.add(seq);
 365         if (hiddenReps.containsKey(seq))
 366         {
 367           SequenceCollectionI hsg = hiddenReps.get(seq);
 368           for (SequenceI seq2 : hsg.getSequences())
 369           {
 370             if (seq2 != seq && !allSequences.contains(seq2))
 371             {
 372               allSequences.add(seq2);
 373             }
 374           }
 375         }
 376       }
 377
 378       return allSequences;
 379     }
 380   }
 381
 382   public SequenceI[] getSequencesAsArray(
 383           Map<SequenceI, SequenceCollectionI> map)
 384   {
 385     List<SequenceI> tmp = getSequences(map);
 386     if (tmp == null)
 387     {
 388       return null;
 389     }
 390     return tmp.toArray(new SequenceI[tmp.size()]);
 391   }
 392
 393   /**
 394    * DOCUMENT ME!
 395    *
 396    * @param col
 397    *          DOCUMENT ME!
 398    *
 399    * @return DOCUMENT ME!
 400    */
 401   public boolean adjustForRemoveLeft(int col)
 402   {
 403     // return value is true if the group still exists
 404     if (startRes >= col)
 405     {
 406       startRes = startRes - col;
 407     }
 408
 409     if (endRes >= col)
 410     {
 411       endRes = endRes - col;
 412
 413       if (startRes > endRes)
 414       {
 415         startRes = 0;
 416       }
 417     }
 418     else
 419     {
 420       // must delete this group!!
 421       return false;
 422     }
 423
 424     return true;
 425   }
 426
 427   /**
 428    * DOCUMENT ME!
 429    *
 430    * @param col
 431    *          DOCUMENT ME!
 432    *
 433    * @return DOCUMENT ME!
 434    */
 435   public boolean adjustForRemoveRight(int col)
 436   {
 437     if (startRes > col)
 438     {
 439       // delete this group
 440       return false;
 441     }
 442
 443     if (endRes >= col)
 444     {
 445       endRes = col;
 446     }
 447
 448     return true;
 449   }
 450
 451   /**
 452    * DOCUMENT ME!
 453    *
 454    * @return DOCUMENT ME!
 455    */
 456   public String getName()
 457   {
 458     return groupName;
 459   }
 460
 461   public String getDescription()
 462   {
 463     return description;
 464   }
 465
 466   /**
 467    * DOCUMENT ME!
 468    *
 469    * @param name
 470    *          DOCUMENT ME!
 471    */
 472   public void setName(String name)
 473   {
 474     groupName = name;
 475     // TODO: URGENT: update dependent objects (annotation row)
 476   }
 477
 478   public void setDescription(String desc)
 479   {
 480     description = desc;
 481   }
 482
 483   /**
 484    * DOCUMENT ME!
 485    *
 486    * @return DOCUMENT ME!
 487    */
 488   public Conservation getConservation()
 489   {
 490     return conserve;
 491   }
 492
 493   /**
 494    * DOCUMENT ME!
 495    *
 496    * @param c
 497    *          DOCUMENT ME!
 498    */
 499   public void setConservation(Conservation c)
 500   {
 501     conserve = c;
 502   }
 503
 504   /**
 505    * Add s to this sequence group. If aligment sequence is already contained in
 506    * group, it will not be added again, but recalculation may happen if the flag
 507    * is set.
 508    *
 509    * @param s
 510    *          alignment sequence to be added
 511    * @param recalc
 512    *          true means Group's conservation should be recalculated
 513    */
 514   public void addSequence(SequenceI s, boolean recalc)
 515   {
 516     synchronized (sequences)
 517     {
 518       if (s != null && !sequences.contains(s))
 519       {
 520         sequences.add(s);
 521         changeSupport.firePropertyChange(SEQ_GROUP_CHANGED,
 522                 sequences.size() - 1, sequences.size());
 523       }
 524
 525       if (recalc)
 526       {
 527         recalcConservation();
 528       }
 529     }
 530   }
 531
 532   /**
 533    * Max Gaps Threshold (percent) for performing a conservation calculation
 534    */
 535   private int consPercGaps = 25;
 536
 537   /**
 538    * @return Max Gaps Threshold for performing a conservation calculation
 539    */
 540   public int getConsPercGaps()
 541   {
 542     return consPercGaps;
 543   }
 544
 545   /**
 546    * set Max Gaps Threshold (percent) for performing a conservation calculation
 547    *
 548    * @param consPercGaps
 549    */
 550   public void setConsPercGaps(int consPercGaps)
 551   {
 552     this.consPercGaps = consPercGaps;
 553   }
 554
 555   /**
 556    * calculate residue conservation and colourschemes for group - but only if
 557    * necessary. returns true if the calculation resulted in a visible change to
 558    * group
 559    */
 560   public boolean recalcConservation()
 561   {
 562     return recalcConservation(false);
 563   }
 564
 565   /**
 566    * calculate residue conservation for group - but only if necessary. returns
 567    * true if the calculation resulted in a visible change to group
 568    *
 569    * @param defer
 570    *          when set, colourschemes for this group are not refreshed after
 571    *          recalculation
 572    */
 573   public boolean recalcConservation(boolean defer)
 574   {
 575     if (cs == null && consensus == null && conservation == null)
 576     {
 577       return false;
 578     }
 579     // TODO: try harder to detect changes in state in order to minimise
 580     // recalculation effort
 581     boolean upd = false;
 582     try
 583     {
 584       ProfilesI cnsns = AAFrequency.calculate(sequences, startRes,
 585               endRes + 1, showSequenceLogo);
 586       if (consensus != null)
 587       {
 588         _updateConsensusRow(cnsns, sequences.size());
 589         upd = true;
 590       }
 591       if (cs != null)
 592       {
 593         cs.setConsensus(cnsns);
 594         upd = true;
 595       }
 596
 597       if ((conservation != null)
 598               || (cs != null && cs.conservationApplied()))
 599       {
 600         Conservation c = new Conservation(groupName, sequences, startRes,
 601                 endRes + 1);
 602         c.calculate();
 603         c.verdict(false, consPercGaps);
 604         if (conservation != null)
 605         {
 606           _updateConservationRow(c);
 607         }
 608         if (cs != null)
 609         {
 610           if (cs.conservationApplied())
 611           {
 612             cs.setConservation(c);
 613           }
 614         }
 615         // eager update - will cause a refresh of overview regardless
 616         upd = true;
 617       }
 618       if (cs != null && !defer)
 619       {
 620         // TODO: JAL-2034 should cs.alignmentChanged modify return state
 621         cs.alignmentChanged(context != null ? context : this, null);
 622         return true;
 623       }
 624       else
 625       {
 626         return upd;
 627       }
 628     } catch (java.lang.OutOfMemoryError err)
 629     {
 630       // TODO: catch OOM
 631       System.out.println("Out of memory loading groups: " + err);
 632     }
 633     return upd;
 634   }
 635
 636   private void _updateConservationRow(Conservation c)
 637   {
 638     if (conservation == null)
 639     {
 640       getConservation();
 641     }
 642     // update Labels
 643     conservation.label = "Conservation for " + getName();
 644     conservation.description = "Conservation for group " + getName()
 645             + " less than " + consPercGaps + "% gaps";
 646     // preserve width if already set
 647     int aWidth = (conservation.annotations != null) ? (endRes < conservation.annotations.length ? conservation.annotations.length
 648             : endRes + 1)
 649             : endRes + 1;
 650     conservation.annotations = null;
 651     conservation.annotations = new Annotation[aWidth]; // should be alignment
 652                                                        // width
 653     c.completeAnnotations(conservation, null, startRes, endRes + 1);
 654   }
 655
 656   public ProfilesI consensusData = null;
 657
 658   private void _updateConsensusRow(ProfilesI cnsns, long nseq)
 659   {
 660     if (consensus == null)
 661     {
 662       getConsensus();
 663     }
 664     consensus.label = "Consensus for " + getName();
 665     consensus.description = "Percent Identity";
 666     consensusData = cnsns;
 667     // preserve width if already set
 668     int aWidth = (consensus.annotations != null) ? (endRes < consensus.annotations.length ? consensus.annotations.length
 669             : endRes + 1)
 670             : endRes + 1;
 671     consensus.annotations = null;
 672     consensus.annotations = new Annotation[aWidth]; // should be alignment width
 673
 674     AAFrequency.completeConsensus(consensus, cnsns, startRes, endRes + 1,
 675             ignoreGapsInConsensus, showSequenceLogo, nseq); // TODO: setting
 676                                                             // container
 677     // for
 678     // ignoreGapsInConsensusCalculation);
 679   }
 680
 681   /**
 682    * @param s
 683    *          sequence to either add or remove from group
 684    * @param recalc
 685    *          flag passed to delete/addSequence to indicate if group properties
 686    *          should be recalculated
 687    */
 688   public void addOrRemove(SequenceI s, boolean recalc)
 689   {
 690     synchronized (sequences)
 691     {
 692       if (sequences.contains(s))
 693       {
 694         deleteSequence(s, recalc);
 695       }
 696       else
 697       {
 698         addSequence(s, recalc);
 699       }
 700     }
 701   }
 702
 703   /**
 704    * remove
 705    *
 706    * @param s
 707    *          to be removed
 708    * @param recalc
 709    *          true means recalculate conservation
 710    */
 711   public void deleteSequence(SequenceI s, boolean recalc)
 712   {
 713     synchronized (sequences)
 714     {
 715       sequences.remove(s);
 716       changeSupport.firePropertyChange(SEQ_GROUP_CHANGED,
 717               sequences.size() + 1, sequences.size());
 718
 719       if (recalc)
 720       {
 721         recalcConservation();
 722       }
 723     }
 724   }
 725
 726   /**
 727    *
 728    *
 729    * @return the first column selected by this group. Runs from 0<=i<N_cols
 730    */
 731   @Override
 732   public int getStartRes()
 733   {
 734     return startRes;
 735   }
 736
 737   /**
 738    *
 739    * @return the groups last selected column. Runs from 0<=i<N_cols
 740    */
 741   @Override
 742   public int getEndRes()
 743   {
 744     return endRes;
 745   }
 746
 747   /**
 748    * Set the first column selected by this group. Runs from 0<=i<N_cols
 749    *
 750    * @param i
 751    */
 752   public void setStartRes(int i)
 753   {
 754     int before = startRes;
 755     startRes = i;
 756     changeSupport.firePropertyChange(SEQ_GROUP_CHANGED, before, startRes);
 757   }
 758
 759   /**
 760    * Set the groups last selected column. Runs from 0<=i<N_cols
 761    *
 762    * @param i
 763    */
 764   public void setEndRes(int i)
 765   {
 766     int before = endRes;
 767     endRes = i;
 768     changeSupport.firePropertyChange(SEQ_GROUP_CHANGED, before, endRes);
 769   }
 770
 771   /**
 772    * @return number of sequences in group
 773    */
 774   public int getSize()
 775   {
 776     return sequences.size();
 777   }
 778
 779   /**
 780    * @param i
 781    * @return the ith sequence
 782    */
 783   public SequenceI getSequenceAt(int i)
 784   {
 785     return sequences.get(i);
 786   }
 787
 788   /**
 789    * @param state
 790    *          colourText
 791    */
 792   public void setColourText(boolean state)
 793   {
 794     colourText = state;
 795   }
 796
 797   /**
 798    * DOCUMENT ME!
 799    *
 800    * @return DOCUMENT ME!
 801    */
 802   public boolean getColourText()
 803   {
 804     return colourText;
 805   }
 806
 807   /**
 808    * DOCUMENT ME!
 809    *
 810    * @param state
 811    *          DOCUMENT ME!
 812    */
 813   public void setDisplayText(boolean state)
 814   {
 815     displayText = state;
 816   }
 817
 818   /**
 819    * DOCUMENT ME!
 820    *
 821    * @return DOCUMENT ME!
 822    */
 823   public boolean getDisplayText()
 824   {
 825     return displayText;
 826   }
 827
 828   /**
 829    * DOCUMENT ME!
 830    *
 831    * @param state
 832    *          DOCUMENT ME!
 833    */
 834   public void setDisplayBoxes(boolean state)
 835   {
 836     displayBoxes = state;
 837   }
 838
 839   /**
 840    * DOCUMENT ME!
 841    *
 842    * @return DOCUMENT ME!
 843    */
 844   public boolean getDisplayBoxes()
 845   {
 846     return displayBoxes;
 847   }
 848
 849   /**
 850    * computes the width of current set of sequences and returns it
 851    *
 852    * @return DOCUMENT ME!
 853    */
 854   @Override
 855   public int getWidth()
 856   {
 857     synchronized (sequences)
 858     {
 859       // MC This needs to get reset when characters are inserted and deleted
 860       boolean first = true;
 861       for (SequenceI seq : sequences)
 862       {
 863         if (first || seq.getLength() > width)
 864         {
 865           width = seq.getLength();
 866           first = false;
 867         }
 868       }
 869       return width;
 870     }
 871   }
 872
 873   /**
 874    * DOCUMENT ME!
 875    *
 876    * @param c
 877    *          DOCUMENT ME!
 878    */
 879   public void setOutlineColour(Color c)
 880   {
 881     outlineColour = c;
 882   }
 883
 884   /**
 885    * DOCUMENT ME!
 886    *
 887    * @return DOCUMENT ME!
 888    */
 889   public Color getOutlineColour()
 890   {
 891     return outlineColour;
 892   }
 893
 894   /**
 895    *
 896    * returns the sequences in the group ordered by the ordering given by al.
 897    * this used to return an array with null entries regardless, new behaviour is
 898    * below. TODO: verify that this does not affect use in applet or application
 899    *
 900    * @param al
 901    *          Alignment
 902    * @return SequenceI[] intersection of sequences in group with al, ordered by
 903    *         al, or null if group does not intersect with al
 904    */
 905   public SequenceI[] getSequencesInOrder(AlignmentI al)
 906   {
 907     return getSequencesInOrder(al, true);
 908   }
 909
 910   /**
 911    * return an array representing the intersection of the group with al,
 912    * optionally returning an array the size of al.getHeight() where nulls mark
 913    * the non-intersected sequences
 914    *
 915    * @param al
 916    * @param trim
 917    * @return null or array
 918    */
 919   public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim)
 920   {
 921     synchronized (sequences)
 922     {
 923       int sSize = sequences.size();
 924       int alHeight = al.getHeight();
 925
 926       SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight];
 927
 928       int index = 0;
 929       for (int i = 0; i < alHeight && index < sSize; i++)
 930       {
 931         if (sequences.contains(al.getSequenceAt(i)))
 932         {
 933           seqs[(trim) ? index : i] = al.getSequenceAt(i);
 934           index++;
 935         }
 936       }
 937       if (index == 0)
 938       {
 939         return null;
 940       }
 941       if (!trim)
 942       {
 943         return seqs;
 944       }
 945       if (index < seqs.length)
 946       {
 947         SequenceI[] dummy = seqs;
 948         seqs = new SequenceI[index];
 949         while (--index >= 0)
 950         {
 951           seqs[index] = dummy[index];
 952           dummy[index] = null;
 953         }
 954       }
 955       return seqs;
 956     }
 957   }
 958
 959   /**
 960    * @return the idColour
 961    */
 962   public Color getIdColour()
 963   {
 964     return idColour;
 965   }
 966
 967   /**
 968    * @param idColour
 969    *          the idColour to set
 970    */
 971   public void setIdColour(Color idColour)
 972   {
 973     this.idColour = idColour;
 974   }
 975
 976   /**
 977    * @return the representative sequence for this group
 978    */
 979   @Override
 980   public SequenceI getSeqrep()
 981   {
 982     return seqrep;
 983   }
 984
 985   /**
 986    * set the representative sequence for this group. Note - this affects the
 987    * interpretation of the Hidereps attribute.
 988    *
 989    * @param seqrep
 990    *          the seqrep to set (null means no sequence representative)
 991    */
 992   @Override
 993   public void setSeqrep(SequenceI seqrep)
 994   {
 995     this.seqrep = seqrep;
 996   }
 997
 998   /**
 999    *
1000    * @return true if group has a sequence representative
1001    */
1002   @Override
1003   public boolean hasSeqrep()
1004   {
1005     return seqrep != null;
1006   }
1007
1008   /**
1009    * set visibility of sequences covered by (if no sequence representative is
1010    * defined) or represented by this group.
1011    *
1012    * @param visibility
1013    */
1014   public void setHidereps(boolean visibility)
1015   {
1016     hidereps = visibility;
1017   }
1018
1019   /**
1020    *
1021    * @return true if sequences represented (or covered) by this group should be
1022    *         hidden
1023    */
1024   public boolean isHidereps()
1025   {
1026     return hidereps;
1027   }
1028
1029   /**
1030    * set intended visibility of columns covered by this group
1031    *
1032    * @param visibility
1033    */
1034   public void setHideCols(boolean visibility)
1035   {
1036     hidecols = visibility;
1037   }
1038
1039   /**
1040    *
1041    * @return true if columns covered by group should be hidden
1042    */
1043   public boolean isHideCols()
1044   {
1045     return hidecols;
1046   }
1047
1048   /**
1049    * create a new sequence group from the intersection of this group with an
1050    * alignment Hashtable of hidden representatives
1051    *
1052    * @param alignment
1053    *          (may not be null)
1054    * @param map
1055    *          (may be null)
1056    * @return new group containing sequences common to this group and alignment
1057    */
1058   public SequenceGroup intersect(AlignmentI alignment,
1059           Map<SequenceI, SequenceCollectionI> map)
1060   {
1061     SequenceGroup sgroup = new SequenceGroup(this);
1062     SequenceI[] insect = getSequencesInOrder(alignment);
1063     sgroup.sequences = new ArrayList<>();
1064     for (int s = 0; insect != null && s < insect.length; s++)
1065     {
1066       if (map == null || map.containsKey(insect[s]))
1067       {
1068         sgroup.sequences.add(insect[s]);
1069       }
1070     }
1071     return sgroup;
1072   }
1073
1074   /**
1075    * @return the showUnconserved
1076    */
1077   public boolean getShowNonconserved()
1078   {
1079     return showNonconserved;
1080   }
1081
1082   /**
1083    * @param showNonconserved
1084    *          the showUnconserved to set
1085    */
1086   public void setShowNonconserved(boolean displayNonconserved)
1087   {
1088     this.showNonconserved = displayNonconserved;
1089   }
1090
1091   /**
1092    * set this alignmentAnnotation object as the one used to render consensus
1093    * annotation
1094    *
1095    * @param aan
1096    */
1097   public void setConsensus(AlignmentAnnotation aan)
1098   {
1099     if (consensus == null)
1100     {
1101       consensus = aan;
1102     }
1103   }
1104
1105   /**
1106    *
1107    * @return automatically calculated consensus row note: the row is a stub if a
1108    *         consensus calculation has not yet been performed on the group
1109    */
1110   public AlignmentAnnotation getConsensus()
1111   {
1112     // TODO get or calculate and get consensus annotation row for this group
1113     int aWidth = this.getWidth();
1114     // pointer
1115     // possibility
1116     // here.
1117     if (aWidth < 0)
1118     {
1119       return null;
1120     }
1121     if (consensus == null)
1122     {
1123       consensus = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1124               100f, AlignmentAnnotation.BAR_GRAPH);
1125       consensus.hasText = true;
1126       consensus.autoCalculated = true;
1127       consensus.groupRef = this;
1128       consensus.label = "Consensus for " + getName();
1129       consensus.description = "Percent Identity";
1130     }
1131     return consensus;
1132   }
1133
1134   /**
1135    * set this alignmentAnnotation object as the one used to render consensus
1136    * annotation
1137    *
1138    * @param aan
1139    */
1140   public void setConservationRow(AlignmentAnnotation aan)
1141   {
1142     if (conservation == null)
1143     {
1144       conservation = aan;
1145     }
1146   }
1147
1148   /**
1149    * get the conservation annotation row for this group
1150    *
1151    * @return autoCalculated annotation row
1152    */
1153   public AlignmentAnnotation getConservationRow()
1154   {
1155     if (conservation == null)
1156     {
1157       conservation = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1158               11f, AlignmentAnnotation.BAR_GRAPH);
1159     }
1160
1161     conservation.hasText = true;
1162     conservation.autoCalculated = true;
1163     conservation.groupRef = this;
1164     conservation.label = "Conservation for " + getName();
1165     conservation.description = "Conservation for group " + getName()
1166             + " less than " + consPercGaps + "% gaps";
1167     return conservation;
1168   }
1169
1170   /**
1171    *
1172    * @return true if annotation rows have been instantiated for this group
1173    */
1174   public boolean hasAnnotationRows()
1175   {
1176     return consensus != null || conservation != null;
1177   }
1178
1179   public SequenceI getConsensusSeq()
1180   {
1181     getConsensus();
1182     StringBuffer seqs = new StringBuffer();
1183     for (int i = 0; i < consensus.annotations.length; i++)
1184     {
1185       if (consensus.annotations[i] != null)
1186       {
1187         if (consensus.annotations[i].description.charAt(0) == '[')
1188         {
1189           seqs.append(consensus.annotations[i].description.charAt(1));
1190         }
1191         else
1192         {
1193           seqs.append(consensus.annotations[i].displayCharacter);
1194         }
1195       }
1196     }
1197
1198     SequenceI sq = new Sequence("Group" + getName() + " Consensus",
1199             seqs.toString());
1200     sq.setDescription("Percentage Identity Consensus "
1201             + ((ignoreGapsInConsensus) ? " without gaps" : ""));
1202     return sq;
1203   }
1204
1205   public void setIgnoreGapsConsensus(boolean state)
1206   {
1207     if (this.ignoreGapsInConsensus != state && consensus != null)
1208     {
1209       ignoreGapsInConsensus = state;
1210       recalcConservation();
1211     }
1212     ignoreGapsInConsensus = state;
1213   }
1214
1215   public boolean getIgnoreGapsConsensus()
1216   {
1217     return ignoreGapsInConsensus;
1218   }
1219
1220   /**
1221    * @param showSequenceLogo
1222    *          indicates if a sequence logo is shown for consensus annotation
1223    */
1224   public void setshowSequenceLogo(boolean showSequenceLogo)
1225   {
1226     // TODO: decouple calculation from settings update
1227     if (this.showSequenceLogo != showSequenceLogo && consensus != null)
1228     {
1229       this.showSequenceLogo = showSequenceLogo;
1230       recalcConservation();
1231     }
1232     this.showSequenceLogo = showSequenceLogo;
1233   }
1234
1235   /**
1236    *
1237    * @param showConsHist
1238    *          flag indicating if the consensus histogram for this group should
1239    *          be rendered
1240    */
1241   public void setShowConsensusHistogram(boolean showConsHist)
1242   {
1243
1244     if (showConsensusHistogram != showConsHist && consensus != null)
1245     {
1246       this.showConsensusHistogram = showConsHist;
1247       recalcConservation();
1248     }
1249     this.showConsensusHistogram = showConsHist;
1250   }
1251
1252   /**
1253    * @return the showConsensusHistogram
1254    */
1255   public boolean isShowConsensusHistogram()
1256   {
1257     return showConsensusHistogram;
1258   }
1259
1260   /**
1261    * set flag indicating if logo should be normalised when rendered
1262    *
1263    * @param norm
1264    */
1265   public void setNormaliseSequenceLogo(boolean norm)
1266   {
1267     normaliseSequenceLogo = norm;
1268   }
1269
1270   public boolean isNormaliseSequenceLogo()
1271   {
1272     return normaliseSequenceLogo;
1273   }
1274
1275   @Override
1276   /**
1277    * returns a new array with all annotation involving this group
1278    */
1279   public AlignmentAnnotation[] getAlignmentAnnotation()
1280   {
1281     // TODO add in other methods like 'getAlignmentAnnotation(String label),
1282     // etc'
1283     ArrayList<AlignmentAnnotation> annot = new ArrayList<>();
1284     synchronized (sequences)
1285     {
1286       for (SequenceI seq : sequences)
1287       {
1288         AlignmentAnnotation[] aa = seq.getAnnotation();
1289         if (aa != null)
1290         {
1291           for (AlignmentAnnotation al : aa)
1292           {
1293             if (al.groupRef == this)
1294             {
1295               annot.add(al);
1296             }
1297           }
1298         }
1299       }
1300       if (consensus != null)
1301       {
1302         annot.add(consensus);
1303       }
1304       if (conservation != null)
1305       {
1306         annot.add(conservation);
1307       }
1308     }
1309     return annot.toArray(new AlignmentAnnotation[0]);
1310   }
1311
1312   @Override
1313   public Iterable<AlignmentAnnotation> findAnnotation(String calcId)
1314   {
1315     List<AlignmentAnnotation> aa = new ArrayList<>();
1316     if (calcId == null)
1317     {
1318       return aa;
1319     }
1320     for (AlignmentAnnotation a : getAlignmentAnnotation())
1321     {
1322       if (calcId.equals(a.getCalcId()))
1323       {
1324         aa.add(a);
1325       }
1326     }
1327     return aa;
1328   }
1329
1330   @Override
1331   public Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
1332           String calcId, String label)
1333   {
1334     ArrayList<AlignmentAnnotation> aa = new ArrayList<>();
1335     for (AlignmentAnnotation ann : getAlignmentAnnotation())
1336     {
1337       if ((calcId == null || (ann.getCalcId() != null && ann.getCalcId()
1338               .equals(calcId)))
1339               && (seq == null || (ann.sequenceRef != null && ann.sequenceRef == seq))
1340               && (label == null || (ann.label != null && ann.label
1341                       .equals(label))))
1342       {
1343         aa.add(ann);
1344       }
1345     }
1346     return aa;
1347   }
1348
1349   /**
1350    * Answer true if any annotation matches the calcId passed in (if not null).
1351    *
1352    * @param calcId
1353    * @return
1354    */
1355   public boolean hasAnnotation(String calcId)
1356   {
1357     if (calcId != null && !"".equals(calcId))
1358     {
1359       for (AlignmentAnnotation a : getAlignmentAnnotation())
1360       {
1361         if (a.getCalcId() == calcId)
1362         {
1363           return true;
1364         }
1365       }
1366     }
1367     return false;
1368   }
1369
1370   /**
1371    * Remove all sequences from the group (leaving other properties unchanged).
1372    */
1373   public void clear()
1374   {
1375     synchronized (sequences)
1376     {
1377       int before = sequences.size();
1378       sequences.clear();
1379       changeSupport.firePropertyChange(SEQ_GROUP_CHANGED, before,
1380               sequences.size());
1381     }
1382   }
1383
1384   /**
1385    * Sets the alignment or group context for this group, and whether it is
1386    * defined as a group
1387    *
1388    * @param ctx
1389    *          the context for the group
1390    * @param defined
1391    *          whether the group is defined on the alignment or is just a
1392    *          selection
1393    * @throws IllegalArgumentException
1394    *           if setting the context would result in a circular reference chain
1395    */
1396   public void setContext(AnnotatedCollectionI ctx, boolean defined)
1397   {
1398     setContext(ctx);
1399     this.isDefined = defined;
1400   }
1401
1402   /**
1403    * Sets the alignment or group context for this group
1404    *
1405    * @param ctx
1406    *          the context for the group
1407    * @throws IllegalArgumentException
1408    *           if setting the context would result in a circular reference chain
1409    */
1410   public void setContext(AnnotatedCollectionI ctx)
1411   {
1412     AnnotatedCollectionI ref = ctx;
1413     while (ref != null)
1414     {
1415       if (ref == this || ref.getContext() == ctx)
1416       {
1417         throw new IllegalArgumentException(
1418                 "Circular reference in SequenceGroup.context");
1419       }
1420       ref = ref.getContext();
1421     }
1422     this.context = ctx;
1423   }
1424
1425   /*
1426    * (non-Javadoc)
1427    *
1428    * @see jalview.datamodel.AnnotatedCollectionI#getContext()
1429    */
1430   @Override
1431   public AnnotatedCollectionI getContext()
1432   {
1433     return context;
1434   }
1435
1436   public boolean isDefined()
1437   {
1438     return isDefined;
1439   }
1440
1441   public void setColourScheme(ColourSchemeI scheme)
1442   {
1443     if (cs == null)
1444     {
1445       cs = new ResidueShader();
1446     }
1447     cs.setColourScheme(scheme);
1448   }
1449
1450   public void setGroupColourScheme(ResidueShaderI scheme)
1451   {
1452     cs = scheme;
1453   }
1454
1455   public ColourSchemeI getColourScheme()
1456   {
1457     return cs == null ? null : cs.getColourScheme();
1458   }
1459
1460   public ResidueShaderI getGroupColourScheme()
1461   {
1462     return cs;
1463   }
1464
1465   @Override
1466   public boolean isNucleotide()
1467   {
1468     if (context != null) {
1469       return context.isNucleotide();
1470     }
1471     return false;
1472   }
1473
1474   /**
1475    * @param seq
1476    * @return true if seq is a member of the group
1477    */
1478
1479   public boolean contains(SequenceI seq1)
1480   {
1481     return sequences.contains(seq1);
1482   }
1483
1484   /**
1485    * @param seq
1486    * @param apos
1487    * @return true if startRes<=apos and endRes>=apos and seq is in the group
1488    */
1489   public boolean contains(SequenceI seq, int apos)
1490   {
1491     return (startRes <= apos && endRes >= apos) && sequences.contains(seq);
1492   }
1493 }