2 * Jalview - A Sequence Alignment Editor and Viewer
\r
3 * Copyright (C) 2006 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
\r
5 * This program is free software; you can redistribute it and/or
\r
6 * modify it under the terms of the GNU General Public License
\r
7 * as published by the Free Software Foundation; either version 2
\r
8 * of the License, or (at your option) any later version.
\r
10 * This program is distributed in the hope that it will be useful,
\r
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
13 * GNU General Public License for more details.
\r
15 * You should have received a copy of the GNU General Public License
\r
16 * along with this program; if not, write to the Free Software
\r
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
\r
19 package jalview.datamodel;
\r
21 import jalview.analysis.*;
\r
23 import jalview.schemes.*;
\r
34 * @version $Revision$
\r
36 public class SequenceGroup
\r
40 Conservation conserve;
\r
42 boolean displayBoxes;
\r
43 boolean displayText;
\r
45 private Vector sequences = new Vector();
\r
48 /** DOCUMENT ME!! */
\r
49 public ColourSchemeI cs;
\r
52 Color outlineColour = Color.black;
\r
53 public int thresholdTextColour = 0;
\r
54 public Color textColour = Color.black;
\r
55 public Color textColour2 = Color.white;
\r
59 * Creates a new SequenceGroup object.
\r
61 public SequenceGroup()
\r
63 groupName = "Group";
\r
64 this.displayBoxes = true;
\r
65 this.displayText = true;
\r
66 this.colourText = false;
\r
71 * Creates a new SequenceGroup object.
\r
73 * @param sequences DOCUMENT ME!
\r
74 * @param groupName DOCUMENT ME!
\r
75 * @param scheme DOCUMENT ME!
\r
76 * @param displayBoxes DOCUMENT ME!
\r
77 * @param displayText DOCUMENT ME!
\r
78 * @param colourText DOCUMENT ME!
\r
79 * @param start DOCUMENT ME!
\r
80 * @param end DOCUMENT ME!
\r
82 public SequenceGroup(Vector sequences, String groupName,
\r
83 ColourSchemeI scheme, boolean displayBoxes, boolean displayText,
\r
84 boolean colourText, int start, int end)
\r
86 this.sequences = sequences;
\r
87 this.groupName = groupName;
\r
88 this.displayBoxes = displayBoxes;
\r
89 this.displayText = displayText;
\r
90 this.colourText = colourText;
\r
94 recalcConservation();
\r
98 * Creates a new SequenceGroup object.
\r
100 * @param groupName DOCUMENT ME!
\r
101 * @param scheme DOCUMENT ME!
\r
102 * @param displayBoxes DOCUMENT ME!
\r
103 * @param displayText DOCUMENT ME!
\r
104 * @param colourText DOCUMENT ME!
\r
105 * @param start DOCUMENT ME!
\r
106 * @param end DOCUMENT ME!
\r
108 public SequenceGroup(String groupName, ColourSchemeI scheme,
\r
109 boolean displayBoxes, boolean displayText, boolean colourText,
\r
110 int start, int end)
\r
112 this.groupName = groupName;
\r
113 this.displayBoxes = displayBoxes;
\r
114 this.displayText = displayText;
\r
115 this.colourText = colourText;
\r
121 public SequenceI [] getSelectionAsNewSequences(AlignmentI align)
\r
123 int iSize = sequences.size();
\r
124 SequenceI [] seqs = new SequenceI[iSize];
\r
125 SequenceI [] inorder = getSequencesInOrder(align);
\r
128 for (int i = 0; i < iSize; i++)
\r
130 SequenceI seq = inorder[i];
\r
132 seqs[i] = new Sequence(seq.getName(),
\r
133 seq.getSequence(startRes, endRes + 1),
\r
134 seq.findPosition(startRes),
\r
137 seqs[i].setDescription(seq.getDescription());
\r
138 seqs[i].setDBRef(seq.getDBRef());
\r
139 seqs[i].setSequenceFeatures(seq.getSequenceFeatures());
\r
140 if (seq.getDatasetSequence() != null)
\r
141 seqs[i].setDatasetSequence(seq.getDatasetSequence());
\r
143 if(seq.getAnnotation()!=null)
\r
145 for(int a=0; a<seq.getAnnotation().length; a++)
\r
146 seqs[i].addAlignmentAnnotation(seq.getAnnotation()[a]);
\r
155 * If sequence ends in gaps, the end residue can
\r
156 * be correctly calculated here
\r
157 * @param seq SequenceI
\r
160 public int findEndRes(SequenceI seq)
\r
165 for (int j = 0; j < endRes + 1 && j < seq.getLength(); j++)
\r
167 ch = seq.getCharAt(j);
\r
168 if (!jalview.util.Comparison.isGap( (ch)))
\r
176 eres += seq.getStart() - 1;
\r
182 public Vector getSequences(Hashtable hiddenReps)
\r
184 if(hiddenReps == null)
\r
188 Vector allSequences = new Vector();
\r
189 SequenceI seq, seq2;
\r
190 for (int i = 0; i < sequences.size(); i++)
\r
192 seq = (SequenceI) sequences.elementAt(i);
\r
193 allSequences.addElement(seq);
\r
194 if (hiddenReps.containsKey(seq) )
\r
196 SequenceGroup hsg = (SequenceGroup)hiddenReps.get(seq);
\r
197 for (int h = 0; h < hsg.getSize(); h++)
\r
199 seq2 = hsg.getSequenceAt(h);
\r
201 && !allSequences.contains(seq2))
\r
202 allSequences.addElement(seq2);
\r
207 return allSequences;
\r
211 public SequenceI[] getSequencesAsArray(Hashtable hiddenReps)
\r
213 Vector tmp = getSequences(hiddenReps);
\r
216 SequenceI [] result = new SequenceI[tmp.size()];
\r
217 for(int i=0; i<result.length; i++)
\r
218 result[i] = (SequenceI)tmp.elementAt(i);
\r
226 * @param col DOCUMENT ME!
\r
228 * @return DOCUMENT ME!
\r
230 public boolean adjustForRemoveLeft(int col)
\r
232 // return value is true if the group still exists
\r
233 if (startRes >= col)
\r
235 startRes = startRes - col;
\r
240 endRes = endRes - col;
\r
242 if (startRes > endRes)
\r
249 // must delete this group!!
\r
259 * @param col DOCUMENT ME!
\r
261 * @return DOCUMENT ME!
\r
263 public boolean adjustForRemoveRight(int col)
\r
265 if (startRes > col)
\r
267 // delete this group
\r
282 * @return DOCUMENT ME!
\r
284 public String getName()
\r
289 public String getDescription()
\r
291 return description;
\r
297 * @param name DOCUMENT ME!
\r
299 public void setName(String name)
\r
304 public void setDescription(String desc)
\r
306 description = desc;
\r
312 * @return DOCUMENT ME!
\r
314 public Conservation getConservation()
\r
322 * @param c DOCUMENT ME!
\r
324 public void setConservation(Conservation c)
\r
332 * @param s DOCUMENT ME!
\r
333 * @param recalc DOCUMENT ME!
\r
335 public void addSequence(SequenceI s, boolean recalc)
\r
337 if (s!=null && !sequences.contains(s))
\r
339 sequences.addElement(s);
\r
344 recalcConservation();
\r
351 public void recalcConservation()
\r
358 cs.setConsensus(AAFrequency.calculate(sequences, startRes, endRes+1));
\r
360 if (cs instanceof ClustalxColourScheme)
\r
362 ( (ClustalxColourScheme) cs).resetClustalX(sequences, getWidth());
\r
365 if (cs.conservationApplied())
\r
367 Conservation c = new Conservation(groupName,
\r
368 ResidueProperties.propHash, 3, sequences,
\r
369 startRes, endRes+1);
\r
371 c.verdict(false, 25);
\r
373 cs.setConservation(c);
\r
375 if (cs instanceof ClustalxColourScheme)
\r
377 ( (ClustalxColourScheme) cs).resetClustalX(sequences,
\r
382 catch (java.lang.OutOfMemoryError err)
\r
384 System.out.println("Out of memory loading groups: " + err);
\r
392 * @param s DOCUMENT ME!
\r
393 * @param recalc DOCUMENT ME!
\r
395 public void addOrRemove(SequenceI s, boolean recalc)
\r
397 if (sequences.contains(s))
\r
399 deleteSequence(s, recalc);
\r
403 addSequence(s, recalc);
\r
410 * @param s DOCUMENT ME!
\r
411 * @param recalc DOCUMENT ME!
\r
413 public void deleteSequence(SequenceI s, boolean recalc)
\r
415 sequences.removeElement(s);
\r
419 recalcConservation();
\r
426 * @return DOCUMENT ME!
\r
428 public int getStartRes()
\r
436 * @return DOCUMENT ME!
\r
438 public int getEndRes()
\r
446 * @param i DOCUMENT ME!
\r
448 public void setStartRes(int i)
\r
456 * @param i DOCUMENT ME!
\r
458 public void setEndRes(int i)
\r
466 * @return DOCUMENT ME!
\r
468 public int getSize()
\r
470 return sequences.size();
\r
476 * @param i DOCUMENT ME!
\r
478 * @return DOCUMENT ME!
\r
480 public SequenceI getSequenceAt(int i)
\r
482 return (SequenceI) sequences.elementAt(i);
\r
488 * @param state DOCUMENT ME!
\r
490 public void setColourText(boolean state)
\r
492 colourText = state;
\r
498 * @return DOCUMENT ME!
\r
500 public boolean getColourText()
\r
508 * @param state DOCUMENT ME!
\r
510 public void setDisplayText(boolean state)
\r
512 displayText = state;
\r
518 * @return DOCUMENT ME!
\r
520 public boolean getDisplayText()
\r
522 return displayText;
\r
528 * @param state DOCUMENT ME!
\r
530 public void setDisplayBoxes(boolean state)
\r
532 displayBoxes = state;
\r
538 * @return DOCUMENT ME!
\r
540 public boolean getDisplayBoxes()
\r
542 return displayBoxes;
\r
548 * @return DOCUMENT ME!
\r
550 public int getWidth()
\r
552 // MC This needs to get reset when characters are inserted and deleted
\r
553 if (sequences.size() > 0)
\r
555 width = ((SequenceI) sequences.elementAt(0)).getLength();
\r
558 for (int i = 1; i < sequences.size(); i++)
\r
560 SequenceI seq = (SequenceI) sequences.elementAt(i);
\r
562 if (seq.getLength() > width)
\r
564 width = seq.getLength();
\r
574 * @param c DOCUMENT ME!
\r
576 public void setOutlineColour(Color c)
\r
584 * @return DOCUMENT ME!
\r
586 public Color getOutlineColour()
\r
588 return outlineColour;
\r
593 * returns the sequences in the group ordered by the ordering given by al
\r
595 * @param al Alignment
\r
596 * @return SequenceI[]
\r
598 public SequenceI[] getSequencesInOrder(AlignmentI al)
\r
600 int sSize = sequences.size();
\r
601 int alHeight = al.getHeight();
\r
603 SequenceI[] seqs = new SequenceI[sSize];
\r
606 for (int i = 0; i < alHeight && index<sSize; i++)
\r
608 if(sequences.contains( al.getSequenceAt(i) ) )
\r
609 seqs[index++] = al.getSequenceAt(i);
\r