src/jalview/datamodel/SequenceGroup.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
   3  * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18 package jalview.datamodel;
  19
  20 import java.util.*;
  21 import java.util.List;
  22
  23 import java.awt.*;
  24
  25 import jalview.analysis.*;
  26 import jalview.schemes.*;
  27
  28 /**
  29  * Collects a set contiguous ranges on a set of sequences
  30  *
  31  * @author $author$
  32  * @version $Revision$
  33  */
  34 public class SequenceGroup implements AnnotatedCollectionI
  35 {
  36   String groupName;
  37
  38   String description;
  39
  40   Conservation conserve;
  41
  42   Vector aaFrequency;
  43
  44   boolean displayBoxes = true;
  45
  46   boolean displayText = true;
  47
  48   boolean colourText = false;
  49
  50   /**
  51    * after Olivier's non-conserved only character display
  52    */
  53   boolean showNonconserved = false;
  54
  55   /**
  56    * group members
  57    */
  58   private Vector<SequenceI> sequences = new Vector<SequenceI>();
  59
  60   /**
  61    * representative sequence for this group (if any)
  62    */
  63   private SequenceI seqrep = null;
  64
  65   int width = -1;
  66
  67   /**
  68    * Colourscheme applied to group if any
  69    */
  70   public ColourSchemeI cs;
  71
  72   int startRes = 0;
  73
  74   int endRes = 0;
  75
  76   public Color outlineColour = Color.black;
  77
  78   public Color idColour = null;
  79
  80   public int thresholdTextColour = 0;
  81
  82   public Color textColour = Color.black;
  83
  84   public Color textColour2 = Color.white;
  85
  86   /**
  87    * consensus calculation property
  88    */
  89   private boolean ignoreGapsInConsensus = true;
  90
  91   /**
  92    * consensus calculation property
  93    */
  94   private boolean showSequenceLogo = false;
  95
  96   /**
  97    * flag indicating if logo should be rendered normalised
  98    */
  99   private boolean normaliseSequenceLogo;
 100
 101   /**
 102    * @return the includeAllConsSymbols
 103    */
 104   public boolean isShowSequenceLogo()
 105   {
 106     return showSequenceLogo;
 107   }
 108
 109   /**
 110    * Creates a new SequenceGroup object.
 111    */
 112   public SequenceGroup()
 113   {
 114     groupName = "JGroup:" + this.hashCode();
 115   }
 116
 117   /**
 118    * Creates a new SequenceGroup object.
 119    *
 120    * @param sequences
 121    * @param groupName
 122    * @param scheme
 123    * @param displayBoxes
 124    * @param displayText
 125    * @param colourText
 126    * @param start
 127    *          first column of group
 128    * @param end
 129    *          last column of group
 130    */
 131   public SequenceGroup(Vector sequences, String groupName,
 132           ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
 133           boolean colourText, int start, int end)
 134   {
 135     this.sequences = sequences;
 136     this.groupName = groupName;
 137     this.displayBoxes = displayBoxes;
 138     this.displayText = displayText;
 139     this.colourText = colourText;
 140     this.cs = scheme;
 141     startRes = start;
 142     endRes = end;
 143     recalcConservation();
 144   }
 145
 146   /**
 147    * copy constructor
 148    *
 149    * @param seqsel
 150    */
 151   public SequenceGroup(SequenceGroup seqsel)
 152   {
 153     if (seqsel != null)
 154     {
 155       sequences = new Vector();
 156       Enumeration<SequenceI> sq = seqsel.sequences.elements();
 157       while (sq.hasMoreElements())
 158       {
 159         sequences.addElement(sq.nextElement());
 160       }
 161       ;
 162       if (seqsel.groupName != null)
 163       {
 164         groupName = new String(seqsel.groupName);
 165       }
 166       displayBoxes = seqsel.displayBoxes;
 167       displayText = seqsel.displayText;
 168       colourText = seqsel.colourText;
 169       startRes = seqsel.startRes;
 170       endRes = seqsel.endRes;
 171       cs = seqsel.cs;
 172       if (seqsel.description != null)
 173         description = new String(seqsel.description);
 174       hidecols = seqsel.hidecols;
 175       hidereps = seqsel.hidereps;
 176       idColour = seqsel.idColour;
 177       outlineColour = seqsel.outlineColour;
 178       seqrep = seqsel.seqrep;
 179       textColour = seqsel.textColour;
 180       textColour2 = seqsel.textColour2;
 181       thresholdTextColour = seqsel.thresholdTextColour;
 182       width = seqsel.width;
 183       ignoreGapsInConsensus = seqsel.ignoreGapsInConsensus;
 184       if (seqsel.conserve != null)
 185       {
 186         recalcConservation(); // safer than
 187         // aaFrequency = (Vector) seqsel.aaFrequency.clone(); // ??
 188       }
 189     }
 190   }
 191
 192   public SequenceI[] getSelectionAsNewSequences(AlignmentI align)
 193   {
 194     int iSize = sequences.size();
 195     SequenceI[] seqs = new SequenceI[iSize];
 196     SequenceI[] inorder = getSequencesInOrder(align);
 197
 198     for (int i = 0, ipos = 0; i < inorder.length; i++)
 199     {
 200       SequenceI seq = inorder[i];
 201
 202       seqs[ipos] = seq.getSubSequence(startRes, endRes + 1);
 203       if (seqs[ipos] != null)
 204       {
 205         seqs[ipos].setDescription(seq.getDescription());
 206         seqs[ipos].setDBRef(seq.getDBRef());
 207         seqs[ipos].setSequenceFeatures(seq.getSequenceFeatures());
 208         if (seq.getDatasetSequence() != null)
 209         {
 210           seqs[ipos].setDatasetSequence(seq.getDatasetSequence());
 211         }
 212
 213         if (seq.getAnnotation() != null)
 214         {
 215           AlignmentAnnotation[] alann = align.getAlignmentAnnotation();
 216           // Only copy annotation that is either a score or referenced by the
 217           // alignment's annotation vector
 218           for (int a = 0; a < seq.getAnnotation().length; a++)
 219           {
 220             AlignmentAnnotation tocopy = seq.getAnnotation()[a];
 221             if (alann != null)
 222             {
 223               boolean found = false;
 224               for (int pos = 0; pos < alann.length; pos++)
 225               {
 226                 if (alann[pos] == tocopy)
 227                 {
 228                   found = true;
 229                   break;
 230                 }
 231               }
 232               if (!found)
 233                 continue;
 234             }
 235             AlignmentAnnotation newannot = new AlignmentAnnotation(
 236                     seq.getAnnotation()[a]);
 237             newannot.restrict(startRes, endRes);
 238             newannot.setSequenceRef(seqs[ipos]);
 239             newannot.adjustForAlignment();
 240             seqs[ipos].addAlignmentAnnotation(newannot);
 241           }
 242         }
 243         ipos++;
 244       }
 245       else
 246       {
 247         iSize--;
 248       }
 249     }
 250     if (iSize != inorder.length)
 251     {
 252       SequenceI[] nseqs = new SequenceI[iSize];
 253       System.arraycopy(seqs, 0, nseqs, 0, iSize);
 254       seqs = nseqs;
 255     }
 256     return seqs;
 257
 258   }
 259
 260   /**
 261    * If sequence ends in gaps, the end residue can be correctly calculated here
 262    *
 263    * @param seq
 264    *          SequenceI
 265    * @return int
 266    */
 267   public int findEndRes(SequenceI seq)
 268   {
 269     int eres = 0;
 270     char ch;
 271
 272     for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)
 273     {
 274       ch = seq.getCharAt(j);
 275       if (!jalview.util.Comparison.isGap((ch)))
 276       {
 277         eres++;
 278       }
 279     }
 280
 281     if (eres > 0)
 282     {
 283       eres += seq.getStart() - 1;
 284     }
 285
 286     return eres;
 287   }
 288
 289   public List<SequenceI> getSequences()
 290   {
 291     return sequences;
 292   }
 293
 294   public List<SequenceI> getSequences(
 295           Map<SequenceI, SequenceCollectionI> hiddenReps)
 296   {
 297     if (hiddenReps == null)
 298     {
 299       return sequences;
 300     }
 301     else
 302     {
 303       Vector allSequences = new Vector();
 304       SequenceI seq;
 305       for (int i = 0; i < sequences.size(); i++)
 306       {
 307         seq = (SequenceI) sequences.elementAt(i);
 308         allSequences.addElement(seq);
 309         if (hiddenReps.containsKey(seq))
 310         {
 311           SequenceCollectionI hsg = hiddenReps.get(seq);
 312           for (SequenceI seq2 : hsg.getSequences())
 313           {
 314             if (seq2 != seq && !allSequences.contains(seq2))
 315             {
 316               allSequences.addElement(seq2);
 317             }
 318           }
 319         }
 320       }
 321
 322       return allSequences;
 323     }
 324   }
 325
 326   public SequenceI[] getSequencesAsArray(
 327           Map<SequenceI, SequenceCollectionI> map)
 328   {
 329     List<SequenceI> tmp = getSequences(map);
 330     if (tmp == null)
 331     {
 332       return null;
 333     }
 334     return tmp.toArray(new SequenceI[tmp.size()]);
 335   }
 336
 337   /**
 338    * DOCUMENT ME!
 339    *
 340    * @param col
 341    *          DOCUMENT ME!
 342    *
 343    * @return DOCUMENT ME!
 344    */
 345   public boolean adjustForRemoveLeft(int col)
 346   {
 347     // return value is true if the group still exists
 348     if (startRes >= col)
 349     {
 350       startRes = startRes - col;
 351     }
 352
 353     if (endRes >= col)
 354     {
 355       endRes = endRes - col;
 356
 357       if (startRes > endRes)
 358       {
 359         startRes = 0;
 360       }
 361     }
 362     else
 363     {
 364       // must delete this group!!
 365       return false;
 366     }
 367
 368     return true;
 369   }
 370
 371   /**
 372    * DOCUMENT ME!
 373    *
 374    * @param col
 375    *          DOCUMENT ME!
 376    *
 377    * @return DOCUMENT ME!
 378    */
 379   public boolean adjustForRemoveRight(int col)
 380   {
 381     if (startRes > col)
 382     {
 383       // delete this group
 384       return false;
 385     }
 386
 387     if (endRes >= col)
 388     {
 389       endRes = col;
 390     }
 391
 392     return true;
 393   }
 394
 395   /**
 396    * DOCUMENT ME!
 397    *
 398    * @return DOCUMENT ME!
 399    */
 400   public String getName()
 401   {
 402     return groupName;
 403   }
 404
 405   public String getDescription()
 406   {
 407     return description;
 408   }
 409
 410   /**
 411    * DOCUMENT ME!
 412    *
 413    * @param name
 414    *          DOCUMENT ME!
 415    */
 416   public void setName(String name)
 417   {
 418     groupName = name;
 419     // TODO: URGENT: update dependent objects (annotation row)
 420   }
 421
 422   public void setDescription(String desc)
 423   {
 424     description = desc;
 425   }
 426
 427   /**
 428    * DOCUMENT ME!
 429    *
 430    * @return DOCUMENT ME!
 431    */
 432   public Conservation getConservation()
 433   {
 434     return conserve;
 435   }
 436
 437   /**
 438    * DOCUMENT ME!
 439    *
 440    * @param c
 441    *          DOCUMENT ME!
 442    */
 443   public void setConservation(Conservation c)
 444   {
 445     conserve = c;
 446   }
 447
 448   /**
 449    * Add s to this sequence group. If aligment sequence is already contained in
 450    * group, it will not be added again, but recalculation may happen if the flag
 451    * is set.
 452    *
 453    * @param s
 454    *          alignment sequence to be added
 455    * @param recalc
 456    *          true means Group's conservation should be recalculated
 457    */
 458   public void addSequence(SequenceI s, boolean recalc)
 459   {
 460     if (s != null && !sequences.contains(s))
 461     {
 462       sequences.addElement(s);
 463     }
 464
 465     if (recalc)
 466     {
 467       recalcConservation();
 468     }
 469   }
 470
 471   /**
 472    * Max Gaps Threshold for performing a conservation calculation TODO: make
 473    * this a configurable property - or global to an alignment view
 474    */
 475   private int consPercGaps = 25;
 476
 477   /**
 478    * calculate residue conservation for group - but only if necessary.
 479    */
 480   public void recalcConservation()
 481   {
 482     if (cs == null && consensus == null && conservation == null)
 483     {
 484       return;
 485     }
 486     if (cs != null)
 487     {
 488       cs.alignmentChanged(this, null);
 489     }
 490     try
 491     {
 492       Hashtable cnsns[] = AAFrequency.calculate(sequences, startRes,
 493               endRes + 1, showSequenceLogo);
 494       if (consensus != null)
 495       {
 496         _updateConsensusRow(cnsns);
 497       }
 498       if (cs != null)
 499       {
 500         cs.setConsensus(cnsns);
 501         cs.alignmentChanged(this, null);
 502       }
 503
 504       if ((conservation != null)
 505               || (cs != null && cs.conservationApplied()))
 506       {
 507         Conservation c = new Conservation(groupName,
 508                 ResidueProperties.propHash, 3, sequences, startRes,
 509                 endRes + 1);
 510         c.calculate();
 511         c.verdict(false, consPercGaps);
 512         if (conservation != null)
 513         {
 514           _updateConservationRow(c);
 515         }
 516         if (cs != null)
 517         {
 518           if (cs.conservationApplied())
 519           {
 520             cs.setConservation(c);
 521             cs.alignmentChanged(this, null);
 522           }
 523         }
 524       }
 525     } catch (java.lang.OutOfMemoryError err)
 526     {
 527       // TODO: catch OOM
 528       System.out.println("Out of memory loading groups: " + err);
 529     }
 530
 531   }
 532
 533   private void _updateConservationRow(Conservation c)
 534   {
 535     if (conservation == null)
 536     {
 537       getConservation();
 538     }
 539     // update Labels
 540     conservation.label = "Conservation for " + getName();
 541     conservation.description = "Conservation for group " + getName()
 542             + " less than " + consPercGaps + "% gaps";
 543     // preserve width if already set
 544     int aWidth = (conservation.annotations != null) ? (endRes < conservation.annotations.length ? conservation.annotations.length
 545             : endRes + 1)
 546             : endRes + 1;
 547     conservation.annotations = null;
 548     conservation.annotations = new Annotation[aWidth]; // should be alignment
 549                                                        // width
 550     c.completeAnnotations(conservation, null, startRes, endRes + 1);
 551   }
 552
 553   public Hashtable[] consensusData = null;
 554
 555   private void _updateConsensusRow(Hashtable[] cnsns)
 556   {
 557     if (consensus == null)
 558     {
 559       getConsensus();
 560     }
 561     consensus.label = "Consensus for " + getName();
 562     consensus.description = "Percent Identity";
 563     consensusData = cnsns;
 564     // preserve width if already set
 565     int aWidth = (consensus.annotations != null) ? (endRes < consensus.annotations.length ? consensus.annotations.length
 566             : endRes + 1)
 567             : endRes + 1;
 568     consensus.annotations = null;
 569     consensus.annotations = new Annotation[aWidth]; // should be alignment width
 570
 571     AAFrequency.completeConsensus(consensus, cnsns, startRes, endRes + 1,
 572             ignoreGapsInConsensus, showSequenceLogo); // TODO: setting container
 573                                                       // for
 574                                                       // ignoreGapsInConsensusCalculation);
 575   }
 576
 577   /**
 578    * @param s
 579    *          sequence to either add or remove from group
 580    * @param recalc
 581    *          flag passed to delete/addSequence to indicate if group properties
 582    *          should be recalculated
 583    */
 584   public void addOrRemove(SequenceI s, boolean recalc)
 585   {
 586     if (sequences.contains(s))
 587     {
 588       deleteSequence(s, recalc);
 589     }
 590     else
 591     {
 592       addSequence(s, recalc);
 593     }
 594   }
 595
 596   /**
 597    * DOCUMENT ME!
 598    *
 599    * @param s
 600    *          DOCUMENT ME!
 601    * @param recalc
 602    *          DOCUMENT ME!
 603    */
 604   public void deleteSequence(SequenceI s, boolean recalc)
 605   {
 606     sequences.removeElement(s);
 607
 608     if (recalc)
 609     {
 610       recalcConservation();
 611     }
 612   }
 613
 614   /**
 615    * DOCUMENT ME!
 616    *
 617    * @return DOCUMENT ME!
 618    */
 619   public int getStartRes()
 620   {
 621     return startRes;
 622   }
 623
 624   /**
 625    * DOCUMENT ME!
 626    *
 627    * @return DOCUMENT ME!
 628    */
 629   public int getEndRes()
 630   {
 631     return endRes;
 632   }
 633
 634   /**
 635    * Set the first column selected by this group. Runs from 0<=i<N_cols
 636    *
 637    * @param i
 638    */
 639   public void setStartRes(int i)
 640   {
 641     startRes = i;
 642   }
 643
 644   /**
 645    * Set the groups last selected column. Runs from 0<=i<N_cols
 646    *
 647    * @param i
 648    */
 649   public void setEndRes(int i)
 650   {
 651     endRes = i;
 652   }
 653
 654   /**
 655    * DOCUMENT ME!
 656    *
 657    * @return DOCUMENT ME!
 658    */
 659   public int getSize()
 660   {
 661     return sequences.size();
 662   }
 663
 664   /**
 665    * DOCUMENT ME!
 666    *
 667    * @param i
 668    *          DOCUMENT ME!
 669    *
 670    * @return DOCUMENT ME!
 671    */
 672   public SequenceI getSequenceAt(int i)
 673   {
 674     return (SequenceI) sequences.elementAt(i);
 675   }
 676
 677   /**
 678    * DOCUMENT ME!
 679    *
 680    * @param state
 681    *          DOCUMENT ME!
 682    */
 683   public void setColourText(boolean state)
 684   {
 685     colourText = state;
 686   }
 687
 688   /**
 689    * DOCUMENT ME!
 690    *
 691    * @return DOCUMENT ME!
 692    */
 693   public boolean getColourText()
 694   {
 695     return colourText;
 696   }
 697
 698   /**
 699    * DOCUMENT ME!
 700    *
 701    * @param state
 702    *          DOCUMENT ME!
 703    */
 704   public void setDisplayText(boolean state)
 705   {
 706     displayText = state;
 707   }
 708
 709   /**
 710    * DOCUMENT ME!
 711    *
 712    * @return DOCUMENT ME!
 713    */
 714   public boolean getDisplayText()
 715   {
 716     return displayText;
 717   }
 718
 719   /**
 720    * DOCUMENT ME!
 721    *
 722    * @param state
 723    *          DOCUMENT ME!
 724    */
 725   public void setDisplayBoxes(boolean state)
 726   {
 727     displayBoxes = state;
 728   }
 729
 730   /**
 731    * DOCUMENT ME!
 732    *
 733    * @return DOCUMENT ME!
 734    */
 735   public boolean getDisplayBoxes()
 736   {
 737     return displayBoxes;
 738   }
 739
 740   /**
 741    * DOCUMENT ME!
 742    *
 743    * @return DOCUMENT ME!
 744    */
 745   public int getWidth()
 746   {
 747     // MC This needs to get reset when characters are inserted and deleted
 748     if (sequences.size() > 0)
 749     {
 750       width = ((SequenceI) sequences.elementAt(0)).getLength();
 751     }
 752
 753     for (int i = 1; i < sequences.size(); i++)
 754     {
 755       SequenceI seq = (SequenceI) sequences.elementAt(i);
 756
 757       if (seq.getLength() > width)
 758       {
 759         width = seq.getLength();
 760       }
 761     }
 762
 763     return width;
 764   }
 765
 766   /**
 767    * DOCUMENT ME!
 768    *
 769    * @param c
 770    *          DOCUMENT ME!
 771    */
 772   public void setOutlineColour(Color c)
 773   {
 774     outlineColour = c;
 775   }
 776
 777   /**
 778    * DOCUMENT ME!
 779    *
 780    * @return DOCUMENT ME!
 781    */
 782   public Color getOutlineColour()
 783   {
 784     return outlineColour;
 785   }
 786
 787   /**
 788    *
 789    * returns the sequences in the group ordered by the ordering given by al.
 790    * this used to return an array with null entries regardless, new behaviour is
 791    * below. TODO: verify that this does not affect use in applet or application
 792    *
 793    * @param al
 794    *          Alignment
 795    * @return SequenceI[] intersection of sequences in group with al, ordered by
 796    *         al, or null if group does not intersect with al
 797    */
 798   public SequenceI[] getSequencesInOrder(AlignmentI al)
 799   {
 800     return getSequencesInOrder(al, true);
 801   }
 802
 803   /**
 804    * return an array representing the intersection of the group with al,
 805    * optionally returning an array the size of al.getHeight() where nulls mark
 806    * the non-intersected sequences
 807    *
 808    * @param al
 809    * @param trim
 810    * @return null or array
 811    */
 812   public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim)
 813   {
 814     int sSize = sequences.size();
 815     int alHeight = al.getHeight();
 816
 817     SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight];
 818
 819     int index = 0;
 820     for (int i = 0; i < alHeight && index < sSize; i++)
 821     {
 822       if (sequences.contains(al.getSequenceAt(i)))
 823       {
 824         seqs[(trim) ? index : i] = al.getSequenceAt(i);
 825         index++;
 826       }
 827     }
 828     if (index == 0)
 829     {
 830       return null;
 831     }
 832     if (!trim)
 833     {
 834       return seqs;
 835     }
 836     if (index < seqs.length)
 837     {
 838       SequenceI[] dummy = seqs;
 839       seqs = new SequenceI[index];
 840       while (--index >= 0)
 841       {
 842         seqs[index] = dummy[index];
 843         dummy[index] = null;
 844       }
 845     }
 846     return seqs;
 847   }
 848
 849   /**
 850    * @return the idColour
 851    */
 852   public Color getIdColour()
 853   {
 854     return idColour;
 855   }
 856
 857   /**
 858    * @param idColour
 859    *          the idColour to set
 860    */
 861   public void setIdColour(Color idColour)
 862   {
 863     this.idColour = idColour;
 864   }
 865
 866   /**
 867    * @return the representative sequence for this group
 868    */
 869   public SequenceI getSeqrep()
 870   {
 871     return seqrep;
 872   }
 873
 874   /**
 875    * set the representative sequence for this group. Note - this affects the
 876    * interpretation of the Hidereps attribute.
 877    *
 878    * @param seqrep
 879    *          the seqrep to set (null means no sequence representative)
 880    */
 881   public void setSeqrep(SequenceI seqrep)
 882   {
 883     this.seqrep = seqrep;
 884   }
 885
 886   /**
 887    *
 888    * @return true if group has a sequence representative
 889    */
 890   public boolean hasSeqrep()
 891   {
 892     return seqrep != null;
 893   }
 894
 895   /**
 896    * visibility of rows or represented rows covered by group
 897    */
 898   private boolean hidereps = false;
 899
 900   /**
 901    * set visibility of sequences covered by (if no sequence representative is
 902    * defined) or represented by this group.
 903    *
 904    * @param visibility
 905    */
 906   public void setHidereps(boolean visibility)
 907   {
 908     hidereps = visibility;
 909   }
 910
 911   /**
 912    *
 913    * @return true if sequences represented (or covered) by this group should be
 914    *         hidden
 915    */
 916   public boolean isHidereps()
 917   {
 918     return hidereps;
 919   }
 920
 921   /**
 922    * visibility of columns intersecting this group
 923    */
 924   private boolean hidecols = false;
 925
 926   /**
 927    * set intended visibility of columns covered by this group
 928    *
 929    * @param visibility
 930    */
 931   public void setHideCols(boolean visibility)
 932   {
 933     hidecols = visibility;
 934   }
 935
 936   /**
 937    *
 938    * @return true if columns covered by group should be hidden
 939    */
 940   public boolean isHideCols()
 941   {
 942     return hidecols;
 943   }
 944
 945   /**
 946    * create a new sequence group from the intersection of this group with an
 947    * alignment Hashtable of hidden representatives
 948    *
 949    * @param alignment
 950    *          (may not be null)
 951    * @param map
 952    *          (may be null)
 953    * @return new group containing sequences common to this group and alignment
 954    */
 955   public SequenceGroup intersect(AlignmentI alignment,
 956           Map<SequenceI, SequenceCollectionI> map)
 957   {
 958     SequenceGroup sgroup = new SequenceGroup(this);
 959     SequenceI[] insect = getSequencesInOrder(alignment);
 960     sgroup.sequences = new Vector();
 961     for (int s = 0; insect != null && s < insect.length; s++)
 962     {
 963       if (map == null || map.containsKey(insect[s]))
 964       {
 965         sgroup.sequences.addElement(insect[s]);
 966       }
 967     }
 968     // Enumeration en =getSequences(hashtable).elements();
 969     // while (en.hasMoreElements())
 970     // {
 971     // SequenceI elem = (SequenceI) en.nextElement();
 972     // if (alignment.getSequences().contains(elem))
 973     // {
 974     // sgroup.addSequence(elem, false);
 975     // }
 976     // }
 977     return sgroup;
 978   }
 979
 980   /**
 981    * @return the showUnconserved
 982    */
 983   public boolean getShowNonconserved()
 984   {
 985     return showNonconserved;
 986   }
 987
 988   /**
 989    * @param showNonconserved
 990    *          the showUnconserved to set
 991    */
 992   public void setShowNonconserved(boolean displayNonconserved)
 993   {
 994     this.showNonconserved = displayNonconserved;
 995   }
 996
 997   AlignmentAnnotation consensus = null, conservation = null;
 998
 999   /**
1000    * flag indicating if consensus histogram should be rendered
1001    */
1002   private boolean showConsensusHistogram;
1003
1004   /**
1005    * set this alignmentAnnotation object as the one used to render consensus
1006    * annotation
1007    *
1008    * @param aan
1009    */
1010   public void setConsensus(AlignmentAnnotation aan)
1011   {
1012     if (consensus == null)
1013     {
1014       consensus = aan;
1015     }
1016   }
1017
1018   /**
1019    *
1020    * @return automatically calculated consensus row
1021    */
1022   public AlignmentAnnotation getConsensus()
1023   {
1024     // TODO get or calculate and get consensus annotation row for this group
1025     int aWidth = this.getWidth();
1026     // pointer
1027     // possibility
1028     // here.
1029     if (aWidth < 0)
1030     {
1031       return null;
1032     }
1033     if (consensus == null)
1034     {
1035       consensus = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1036               100f, AlignmentAnnotation.BAR_GRAPH);
1037     }
1038     consensus.hasText = true;
1039     consensus.autoCalculated = true;
1040     consensus.groupRef = this;
1041     consensus.label = "Consensus for " + getName();
1042     consensus.description = "Percent Identity";
1043     return consensus;
1044   }
1045
1046   /**
1047    * set this alignmentAnnotation object as the one used to render consensus
1048    * annotation
1049    *
1050    * @param aan
1051    */
1052   public void setConservationRow(AlignmentAnnotation aan)
1053   {
1054     if (conservation == null)
1055     {
1056       conservation = aan;
1057     }
1058   }
1059
1060   /**
1061    * get the conservation annotation row for this group
1062    *
1063    * @return autoCalculated annotation row
1064    */
1065   public AlignmentAnnotation getConservationRow()
1066   {
1067     if (conservation == null)
1068     {
1069       conservation = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1070               11f, AlignmentAnnotation.BAR_GRAPH);
1071     }
1072
1073     conservation.hasText = true;
1074     conservation.autoCalculated = true;
1075     conservation.groupRef = this;
1076     conservation.label = "Conservation for " + getName();
1077     conservation.description = "Conservation for group " + getName()
1078             + " less than " + consPercGaps + "% gaps";
1079     return conservation;
1080   }
1081
1082   /**
1083    *
1084    * @return true if annotation rows have been instantiated for this group
1085    */
1086   public boolean hasAnnotationRows()
1087   {
1088     return consensus != null || conservation != null;
1089   }
1090
1091   public SequenceI getConsensusSeq()
1092   {
1093     getConsensus();
1094     StringBuffer seqs = new StringBuffer();
1095     for (int i = 0; i < consensus.annotations.length; i++)
1096     {
1097       if (consensus.annotations[i] != null)
1098       {
1099         if (consensus.annotations[i].description.charAt(0) == '[')
1100         {
1101           seqs.append(consensus.annotations[i].description.charAt(1));
1102         }
1103         else
1104         {
1105           seqs.append(consensus.annotations[i].displayCharacter);
1106         }
1107       }
1108     }
1109
1110     SequenceI sq = new Sequence("Group" + getName() + " Consensus",
1111             seqs.toString());
1112     sq.setDescription("Percentage Identity Consensus "
1113             + ((ignoreGapsInConsensus) ? " without gaps" : ""));
1114     return sq;
1115   }
1116
1117   public void setIgnoreGapsConsensus(boolean state)
1118   {
1119     if (this.ignoreGapsInConsensus != state && consensus != null)
1120     {
1121       ignoreGapsInConsensus = state;
1122       recalcConservation();
1123     }
1124     ignoreGapsInConsensus = state;
1125   }
1126
1127   public boolean getIgnoreGapsConsensus()
1128   {
1129     return ignoreGapsInConsensus;
1130   }
1131
1132   /**
1133    * @param showSequenceLogo
1134    *          indicates if a sequence logo is shown for consensus annotation
1135    */
1136   public void setshowSequenceLogo(boolean showSequenceLogo)
1137   {
1138     // TODO: decouple calculation from settings update
1139     if (this.showSequenceLogo != showSequenceLogo && consensus != null)
1140     {
1141       this.showSequenceLogo = showSequenceLogo;
1142       recalcConservation();
1143     }
1144     this.showSequenceLogo = showSequenceLogo;
1145   }
1146
1147   /**
1148    *
1149    * @param showConsHist
1150    *          flag indicating if the consensus histogram for this group should
1151    *          be rendered
1152    */
1153   public void setShowConsensusHistogram(boolean showConsHist)
1154   {
1155
1156     if (showConsensusHistogram != showConsHist && consensus != null)
1157     {
1158       this.showConsensusHistogram = showConsHist;
1159       recalcConservation();
1160     }
1161     this.showConsensusHistogram = showConsHist;
1162   }
1163
1164   /**
1165    * @return the showConsensusHistogram
1166    */
1167   public boolean isShowConsensusHistogram()
1168   {
1169     return showConsensusHistogram;
1170   }
1171
1172   /**
1173    * set flag indicating if logo should be normalised when rendered
1174    *
1175    * @param norm
1176    */
1177   public void setNormaliseSequenceLogo(boolean norm)
1178   {
1179     normaliseSequenceLogo = norm;
1180   }
1181
1182   public boolean isNormaliseSequenceLogo()
1183   {
1184     return normaliseSequenceLogo;
1185   }
1186
1187   @Override
1188   /**
1189    * returns a new array with all annotation involving this group
1190    */
1191   public AlignmentAnnotation[] getAlignmentAnnotation()
1192   {
1193     // TODO add in other methods like 'getAlignmentAnnotation(String label),
1194     // etc'
1195     ArrayList<AlignmentAnnotation> annot = new ArrayList<AlignmentAnnotation>();
1196     for (SequenceI seq : (Vector<SequenceI>) sequences)
1197     {
1198       for (AlignmentAnnotation al : seq.getAnnotation())
1199       {
1200         if (al.groupRef == this)
1201         {
1202           annot.add(al);
1203         }
1204       }
1205     }
1206     if (consensus != null)
1207     {
1208       annot.add(consensus);
1209     }
1210     if (conservation != null)
1211     {
1212       annot.add(conservation);
1213     }
1214     return annot.toArray(new AlignmentAnnotation[0]);
1215   }
1216
1217   @Override
1218   public Iterable<AlignmentAnnotation> findAnnotation(String calcId)
1219   {
1220     ArrayList<AlignmentAnnotation> aa = new ArrayList<AlignmentAnnotation>();
1221     for (AlignmentAnnotation a : getAlignmentAnnotation())
1222     {
1223       if (a.getCalcId() == calcId)
1224       {
1225         aa.add(a);
1226       }
1227     }
1228     return aa;
1229   }
1230
1231   public void clear()
1232   {
1233     sequences.clear();
1234   }
1235 }