2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.datamodel;
23 import jalview.analysis.AAFrequency;
24 import jalview.analysis.Conservation;
25 import jalview.schemes.ColourSchemeI;
26 import jalview.schemes.ResidueProperties;
28 import java.awt.Color;
29 import java.util.ArrayList;
30 import java.util.Hashtable;
31 import java.util.List;
33 import java.util.Vector;
36 * Collects a set contiguous ranges on a set of sequences
41 public class SequenceGroup implements AnnotatedCollectionI
47 Conservation conserve;
51 boolean displayBoxes = true;
53 boolean displayText = true;
55 boolean colourText = false;
58 * after Olivier's non-conserved only character display
60 boolean showNonconserved = false;
65 private List<SequenceI> sequences = new ArrayList<SequenceI>();
68 * representative sequence for this group (if any)
70 private SequenceI seqrep = null;
75 * Colourscheme applied to group if any
77 public ColourSchemeI cs;
79 // start column (base 0)
82 // end column (base 0)
85 public Color outlineColour = Color.black;
87 public Color idColour = null;
89 public int thresholdTextColour = 0;
91 public Color textColour = Color.black;
93 public Color textColour2 = Color.white;
96 * consensus calculation property
98 private boolean ignoreGapsInConsensus = true;
101 * consensus calculation property
103 private boolean showSequenceLogo = false;
106 * flag indicating if logo should be rendered normalised
108 private boolean normaliseSequenceLogo;
111 * @return the includeAllConsSymbols
113 public boolean isShowSequenceLogo()
115 return showSequenceLogo;
119 * Creates a new SequenceGroup object.
121 public SequenceGroup()
123 groupName = "JGroup:" + this.hashCode();
127 * Creates a new SequenceGroup object.
132 * @param displayBoxes
136 * first column of group
138 * last column of group
140 public SequenceGroup(List<SequenceI> sequences, String groupName,
141 ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
142 boolean colourText, int start, int end)
144 this.sequences = sequences;
145 this.groupName = groupName;
146 this.displayBoxes = displayBoxes;
147 this.displayText = displayText;
148 this.colourText = colourText;
152 recalcConservation();
160 public SequenceGroup(SequenceGroup seqsel)
164 sequences = new ArrayList<SequenceI>();
165 sequences.addAll(seqsel.sequences);
166 if (seqsel.groupName != null)
168 groupName = new String(seqsel.groupName);
170 displayBoxes = seqsel.displayBoxes;
171 displayText = seqsel.displayText;
172 colourText = seqsel.colourText;
173 startRes = seqsel.startRes;
174 endRes = seqsel.endRes;
176 if (seqsel.description != null)
178 description = new String(seqsel.description);
180 hidecols = seqsel.hidecols;
181 hidereps = seqsel.hidereps;
182 idColour = seqsel.idColour;
183 outlineColour = seqsel.outlineColour;
184 seqrep = seqsel.seqrep;
185 textColour = seqsel.textColour;
186 textColour2 = seqsel.textColour2;
187 thresholdTextColour = seqsel.thresholdTextColour;
188 width = seqsel.width;
189 ignoreGapsInConsensus = seqsel.ignoreGapsInConsensus;
190 if (seqsel.conserve != null)
192 recalcConservation(); // safer than
193 // aaFrequency = (Vector) seqsel.aaFrequency.clone(); // ??
198 public SequenceI[] getSelectionAsNewSequences(AlignmentI align)
200 int iSize = sequences.size();
201 SequenceI[] seqs = new SequenceI[iSize];
202 SequenceI[] inorder = getSequencesInOrder(align);
204 for (int i = 0, ipos = 0; i < inorder.length; i++)
206 SequenceI seq = inorder[i];
208 seqs[ipos] = seq.getSubSequence(startRes, endRes + 1);
209 if (seqs[ipos] != null)
211 seqs[ipos].setDescription(seq.getDescription());
212 seqs[ipos].setDBRefs(seq.getDBRefs());
213 seqs[ipos].setSequenceFeatures(seq.getSequenceFeatures());
214 if (seq.getDatasetSequence() != null)
216 seqs[ipos].setDatasetSequence(seq.getDatasetSequence());
219 if (seq.getAnnotation() != null)
221 AlignmentAnnotation[] alann = align.getAlignmentAnnotation();
222 // Only copy annotation that is either a score or referenced by the
223 // alignment's annotation vector
224 for (int a = 0; a < seq.getAnnotation().length; a++)
226 AlignmentAnnotation tocopy = seq.getAnnotation()[a];
229 boolean found = false;
230 for (int pos = 0; pos < alann.length; pos++)
232 if (alann[pos] == tocopy)
243 AlignmentAnnotation newannot = new AlignmentAnnotation(
244 seq.getAnnotation()[a]);
245 newannot.restrict(startRes, endRes);
246 newannot.setSequenceRef(seqs[ipos]);
247 newannot.adjustForAlignment();
248 seqs[ipos].addAlignmentAnnotation(newannot);
258 if (iSize != inorder.length)
260 SequenceI[] nseqs = new SequenceI[iSize];
261 System.arraycopy(seqs, 0, nseqs, 0, iSize);
269 * If sequence ends in gaps, the end residue can be correctly calculated here
275 public int findEndRes(SequenceI seq)
280 for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)
282 ch = seq.getCharAt(j);
283 if (!jalview.util.Comparison.isGap((ch)))
291 eres += seq.getStart() - 1;
298 public List<SequenceI> getSequences()
304 public List<SequenceI> getSequences(
305 Map<SequenceI, SequenceCollectionI> hiddenReps)
307 if (hiddenReps == null)
309 // TODO: need a synchronizedCollection here ?
314 List<SequenceI> allSequences = new ArrayList<SequenceI>();
315 for (SequenceI seq : sequences)
317 allSequences.add(seq);
318 if (hiddenReps.containsKey(seq))
320 SequenceCollectionI hsg = hiddenReps.get(seq);
321 for (SequenceI seq2 : hsg.getSequences())
323 if (seq2 != seq && !allSequences.contains(seq2))
325 allSequences.add(seq2);
335 public SequenceI[] getSequencesAsArray(
336 Map<SequenceI, SequenceCollectionI> map)
338 List<SequenceI> tmp = getSequences(map);
343 return tmp.toArray(new SequenceI[tmp.size()]);
352 * @return DOCUMENT ME!
354 public boolean adjustForRemoveLeft(int col)
356 // return value is true if the group still exists
359 startRes = startRes - col;
364 endRes = endRes - col;
366 if (startRes > endRes)
373 // must delete this group!!
386 * @return DOCUMENT ME!
388 public boolean adjustForRemoveRight(int col)
407 * @return DOCUMENT ME!
409 public String getName()
414 public String getDescription()
425 public void setName(String name)
428 // TODO: URGENT: update dependent objects (annotation row)
431 public void setDescription(String desc)
439 * @return DOCUMENT ME!
441 public Conservation getConservation()
452 public void setConservation(Conservation c)
458 * Add s to this sequence group. If aligment sequence is already contained in
459 * group, it will not be added again, but recalculation may happen if the flag
463 * alignment sequence to be added
465 * true means Group's conservation should be recalculated
467 public void addSequence(SequenceI s, boolean recalc)
469 synchronized (sequences)
471 if (s != null && !sequences.contains(s))
478 recalcConservation();
484 * Max Gaps Threshold (percent) for performing a conservation calculation
486 private int consPercGaps = 25;
489 * @return Max Gaps Threshold for performing a conservation calculation
491 public int getConsPercGaps()
497 * set Max Gaps Threshold (percent) for performing a conservation calculation
499 * @param consPercGaps
501 public void setConsPercGaps(int consPercGaps)
503 this.consPercGaps = consPercGaps;
507 * calculate residue conservation and colourschemes for group - but only if
508 * necessary. returns true if the calculation resulted in a visible change to
511 public boolean recalcConservation()
513 return recalcConservation(false);
517 * calculate residue conservation for group - but only if necessary. returns
518 * true if the calculation resulted in a visible change to group
521 * when set, colourschemes for this group are not refreshed after
524 public boolean recalcConservation(boolean defer)
526 if (cs == null && consensus == null && conservation == null)
530 // TODO: try harder to detect changes in state in order to minimise
531 // recalculation effort
534 Hashtable cnsns[] = AAFrequency.calculate(sequences, startRes,
535 endRes + 1, showSequenceLogo);
536 if (consensus != null)
538 _updateConsensusRow(cnsns, sequences.size());
542 cs.setConsensus(cnsns);
545 if ((conservation != null)
546 || (cs != null && cs.conservationApplied()))
548 Conservation c = new Conservation(groupName,
549 ResidueProperties.propHash, 3, sequences, startRes,
552 c.verdict(false, consPercGaps);
553 if (conservation != null)
555 _updateConservationRow(c);
559 if (cs.conservationApplied())
561 cs.setConservation(c);
565 if (cs != null && !defer)
567 // TODO: JAL-2034 should cs.alignmentChanged modify return state
568 cs.alignmentChanged(context != null ? context : this, null);
575 } catch (java.lang.OutOfMemoryError err)
578 System.out.println("Out of memory loading groups: " + err);
583 private void _updateConservationRow(Conservation c)
585 if (conservation == null)
590 conservation.label = "Conservation for " + getName();
591 conservation.description = "Conservation for group " + getName()
592 + " less than " + consPercGaps + "% gaps";
593 // preserve width if already set
594 int aWidth = (conservation.annotations != null) ? (endRes < conservation.annotations.length ? conservation.annotations.length
597 conservation.annotations = null;
598 conservation.annotations = new Annotation[aWidth]; // should be alignment
600 c.completeAnnotations(conservation, null, startRes, endRes + 1);
603 public Hashtable[] consensusData = null;
605 private void _updateConsensusRow(Hashtable[] cnsns, long nseq)
607 if (consensus == null)
611 consensus.label = "Consensus for " + getName();
612 consensus.description = "Percent Identity";
613 consensusData = cnsns;
614 // preserve width if already set
615 int aWidth = (consensus.annotations != null) ? (endRes < consensus.annotations.length ? consensus.annotations.length
618 consensus.annotations = null;
619 consensus.annotations = new Annotation[aWidth]; // should be alignment width
621 AAFrequency.completeConsensus(consensus, cnsns, startRes, endRes + 1,
622 ignoreGapsInConsensus, showSequenceLogo, nseq); // TODO: setting
625 // ignoreGapsInConsensusCalculation);
630 * sequence to either add or remove from group
632 * flag passed to delete/addSequence to indicate if group properties
633 * should be recalculated
635 public void addOrRemove(SequenceI s, boolean recalc)
637 synchronized (sequences)
639 if (sequences.contains(s))
641 deleteSequence(s, recalc);
645 addSequence(s, recalc);
656 * true means recalculate conservation
658 public void deleteSequence(SequenceI s, boolean recalc)
660 synchronized (sequences)
666 recalcConservation();
674 * @return the first column selected by this group. Runs from 0<=i<N_cols
677 public int getStartRes()
684 * @return the groups last selected column. Runs from 0<=i<N_cols
687 public int getEndRes()
693 * Set the first column selected by this group. Runs from 0<=i<N_cols
697 public void setStartRes(int i)
703 * Set the groups last selected column. Runs from 0<=i<N_cols
707 public void setEndRes(int i)
713 * @return number of sequences in group
717 return sequences.size();
722 * @return the ith sequence
724 public SequenceI getSequenceAt(int i)
726 return sequences.get(i);
733 public void setColourText(boolean state)
741 * @return DOCUMENT ME!
743 public boolean getColourText()
754 public void setDisplayText(boolean state)
762 * @return DOCUMENT ME!
764 public boolean getDisplayText()
775 public void setDisplayBoxes(boolean state)
777 displayBoxes = state;
783 * @return DOCUMENT ME!
785 public boolean getDisplayBoxes()
791 * computes the width of current set of sequences and returns it
793 * @return DOCUMENT ME!
796 public int getWidth()
798 synchronized (sequences)
800 // MC This needs to get reset when characters are inserted and deleted
801 boolean first = true;
802 for (SequenceI seq : sequences)
804 if (first || seq.getLength() > width)
806 width = seq.getLength();
820 public void setOutlineColour(Color c)
828 * @return DOCUMENT ME!
830 public Color getOutlineColour()
832 return outlineColour;
837 * returns the sequences in the group ordered by the ordering given by al.
838 * this used to return an array with null entries regardless, new behaviour is
839 * below. TODO: verify that this does not affect use in applet or application
843 * @return SequenceI[] intersection of sequences in group with al, ordered by
844 * al, or null if group does not intersect with al
846 public SequenceI[] getSequencesInOrder(AlignmentI al)
848 return getSequencesInOrder(al, true);
852 * return an array representing the intersection of the group with al,
853 * optionally returning an array the size of al.getHeight() where nulls mark
854 * the non-intersected sequences
858 * @return null or array
860 public SequenceI[] getSequencesInOrder(AlignmentI al, boolean trim)
862 synchronized (sequences)
864 int sSize = sequences.size();
865 int alHeight = al.getHeight();
867 SequenceI[] seqs = new SequenceI[(trim) ? sSize : alHeight];
870 for (int i = 0; i < alHeight && index < sSize; i++)
872 if (sequences.contains(al.getSequenceAt(i)))
874 seqs[(trim) ? index : i] = al.getSequenceAt(i);
886 if (index < seqs.length)
888 SequenceI[] dummy = seqs;
889 seqs = new SequenceI[index];
892 seqs[index] = dummy[index];
901 * @return the idColour
903 public Color getIdColour()
910 * the idColour to set
912 public void setIdColour(Color idColour)
914 this.idColour = idColour;
918 * @return the representative sequence for this group
921 public SequenceI getSeqrep()
927 * set the representative sequence for this group. Note - this affects the
928 * interpretation of the Hidereps attribute.
931 * the seqrep to set (null means no sequence representative)
934 public void setSeqrep(SequenceI seqrep)
936 this.seqrep = seqrep;
941 * @return true if group has a sequence representative
944 public boolean hasSeqrep()
946 return seqrep != null;
950 * visibility of rows or represented rows covered by group
952 private boolean hidereps = false;
955 * set visibility of sequences covered by (if no sequence representative is
956 * defined) or represented by this group.
960 public void setHidereps(boolean visibility)
962 hidereps = visibility;
967 * @return true if sequences represented (or covered) by this group should be
970 public boolean isHidereps()
976 * visibility of columns intersecting this group
978 private boolean hidecols = false;
981 * set intended visibility of columns covered by this group
985 public void setHideCols(boolean visibility)
987 hidecols = visibility;
992 * @return true if columns covered by group should be hidden
994 public boolean isHideCols()
1000 * create a new sequence group from the intersection of this group with an
1001 * alignment Hashtable of hidden representatives
1007 * @return new group containing sequences common to this group and alignment
1009 public SequenceGroup intersect(AlignmentI alignment,
1010 Map<SequenceI, SequenceCollectionI> map)
1012 SequenceGroup sgroup = new SequenceGroup(this);
1013 SequenceI[] insect = getSequencesInOrder(alignment);
1014 sgroup.sequences = new ArrayList<SequenceI>();
1015 for (int s = 0; insect != null && s < insect.length; s++)
1017 if (map == null || map.containsKey(insect[s]))
1019 sgroup.sequences.add(insect[s]);
1026 * @return the showUnconserved
1028 public boolean getShowNonconserved()
1030 return showNonconserved;
1034 * @param showNonconserved
1035 * the showUnconserved to set
1037 public void setShowNonconserved(boolean displayNonconserved)
1039 this.showNonconserved = displayNonconserved;
1042 AlignmentAnnotation consensus = null, conservation = null;
1045 * flag indicating if consensus histogram should be rendered
1047 private boolean showConsensusHistogram;
1050 * set this alignmentAnnotation object as the one used to render consensus
1055 public void setConsensus(AlignmentAnnotation aan)
1057 if (consensus == null)
1065 * @return automatically calculated consensus row note: the row is a stub if a
1066 * consensus calculation has not yet been performed on the group
1068 public AlignmentAnnotation getConsensus()
1070 // TODO get or calculate and get consensus annotation row for this group
1071 int aWidth = this.getWidth();
1079 if (consensus == null)
1081 consensus = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1082 100f, AlignmentAnnotation.BAR_GRAPH);
1083 consensus.hasText = true;
1084 consensus.autoCalculated = true;
1085 consensus.groupRef = this;
1086 consensus.label = "Consensus for " + getName();
1087 consensus.description = "Percent Identity";
1093 * set this alignmentAnnotation object as the one used to render consensus
1098 public void setConservationRow(AlignmentAnnotation aan)
1100 if (conservation == null)
1107 * get the conservation annotation row for this group
1109 * @return autoCalculated annotation row
1111 public AlignmentAnnotation getConservationRow()
1113 if (conservation == null)
1115 conservation = new AlignmentAnnotation("", "", new Annotation[1], 0f,
1116 11f, AlignmentAnnotation.BAR_GRAPH);
1119 conservation.hasText = true;
1120 conservation.autoCalculated = true;
1121 conservation.groupRef = this;
1122 conservation.label = "Conservation for " + getName();
1123 conservation.description = "Conservation for group " + getName()
1124 + " less than " + consPercGaps + "% gaps";
1125 return conservation;
1130 * @return true if annotation rows have been instantiated for this group
1132 public boolean hasAnnotationRows()
1134 return consensus != null || conservation != null;
1137 public SequenceI getConsensusSeq()
1140 StringBuffer seqs = new StringBuffer();
1141 for (int i = 0; i < consensus.annotations.length; i++)
1143 if (consensus.annotations[i] != null)
1145 if (consensus.annotations[i].description.charAt(0) == '[')
1147 seqs.append(consensus.annotations[i].description.charAt(1));
1151 seqs.append(consensus.annotations[i].displayCharacter);
1156 SequenceI sq = new Sequence("Group" + getName() + " Consensus",
1158 sq.setDescription("Percentage Identity Consensus "
1159 + ((ignoreGapsInConsensus) ? " without gaps" : ""));
1163 public void setIgnoreGapsConsensus(boolean state)
1165 if (this.ignoreGapsInConsensus != state && consensus != null)
1167 ignoreGapsInConsensus = state;
1168 recalcConservation();
1170 ignoreGapsInConsensus = state;
1173 public boolean getIgnoreGapsConsensus()
1175 return ignoreGapsInConsensus;
1179 * @param showSequenceLogo
1180 * indicates if a sequence logo is shown for consensus annotation
1182 public void setshowSequenceLogo(boolean showSequenceLogo)
1184 // TODO: decouple calculation from settings update
1185 if (this.showSequenceLogo != showSequenceLogo && consensus != null)
1187 this.showSequenceLogo = showSequenceLogo;
1188 recalcConservation();
1190 this.showSequenceLogo = showSequenceLogo;
1195 * @param showConsHist
1196 * flag indicating if the consensus histogram for this group should
1199 public void setShowConsensusHistogram(boolean showConsHist)
1202 if (showConsensusHistogram != showConsHist && consensus != null)
1204 this.showConsensusHistogram = showConsHist;
1205 recalcConservation();
1207 this.showConsensusHistogram = showConsHist;
1211 * @return the showConsensusHistogram
1213 public boolean isShowConsensusHistogram()
1215 return showConsensusHistogram;
1219 * set flag indicating if logo should be normalised when rendered
1223 public void setNormaliseSequenceLogo(boolean norm)
1225 normaliseSequenceLogo = norm;
1228 public boolean isNormaliseSequenceLogo()
1230 return normaliseSequenceLogo;
1235 * returns a new array with all annotation involving this group
1237 public AlignmentAnnotation[] getAlignmentAnnotation()
1239 // TODO add in other methods like 'getAlignmentAnnotation(String label),
1241 ArrayList<AlignmentAnnotation> annot = new ArrayList<AlignmentAnnotation>();
1242 synchronized (sequences)
1244 for (SequenceI seq : sequences)
1246 AlignmentAnnotation[] aa = seq.getAnnotation();
1249 for (AlignmentAnnotation al : aa)
1251 if (al.groupRef == this)
1258 if (consensus != null)
1260 annot.add(consensus);
1262 if (conservation != null)
1264 annot.add(conservation);
1267 return annot.toArray(new AlignmentAnnotation[0]);
1271 public Iterable<AlignmentAnnotation> findAnnotation(String calcId)
1273 ArrayList<AlignmentAnnotation> aa = new ArrayList<AlignmentAnnotation>();
1274 for (AlignmentAnnotation a : getAlignmentAnnotation())
1276 if (a.getCalcId() == calcId)
1285 * Returns a list of annotations that match the specified sequenceRef, calcId
1286 * and label, ignoring null values.
1288 * @return list of AlignmentAnnotation objects
1291 public Iterable<AlignmentAnnotation> findAnnotations(SequenceI seq,
1292 String calcId, String label)
1294 ArrayList<AlignmentAnnotation> aa = new ArrayList<AlignmentAnnotation>();
1295 for (AlignmentAnnotation ann : getAlignmentAnnotation())
1297 if (ann.getCalcId() != null && ann.getCalcId().equals(calcId)
1298 && ann.sequenceRef != null && ann.sequenceRef == seq
1299 && ann.label != null && ann.label.equals(label))
1308 * Answer true if any annotation matches the calcId passed in (if not null).
1313 public boolean hasAnnotation(String calcId)
1315 if (calcId != null && !"".equals(calcId))
1317 for (AlignmentAnnotation a : getAlignmentAnnotation())
1319 if (a.getCalcId() == calcId)
1329 * Remove all sequences from the group (leaving other properties unchanged).
1333 synchronized (sequences)
1339 private AnnotatedCollectionI context;
1342 * set the alignment or group context for this group
1346 public void setContext(AnnotatedCollectionI context)
1348 this.context = context;
1354 * @see jalview.datamodel.AnnotatedCollectionI#getContext()
1357 public AnnotatedCollectionI getContext()