/*
-* Jalview - A Sequence Alignment Editor and Viewer
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
-*
-* This program is free software; you can redistribute it and/or
-* modify it under the terms of the GNU General Public License
-* as published by the Free Software Foundation; either version 2
-* of the License, or (at your option) any later version.
-*
-* This program is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-* GNU General Public License for more details.
-*
-* You should have received a copy of the GNU General Public License
-* along with this program; if not, write to the Free Software
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
-*/
+ * Jalview - A Sequence Alignment Editor and Viewer
+ * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ */
package jalview.datamodel;
-
/**
* DOCUMENT ME!
*
*/
public class AlignmentAnnotation
{
- public SequenceI sequenceRef;
+ /** If true, this annotations is calculated every edit,
+ * eg consensus, quality or conservation graphs */
+ public boolean autoCalculated = false;
- /** DOCUMENT ME!! */
- public String label;
+ public String annotationId;
- /** DOCUMENT ME!! */
- public String description;
+ public SequenceI sequenceRef;
- /** DOCUMENT ME!! */
- public Annotation[] annotations;
+ /** DOCUMENT ME!! */
+ public String label;
- public java.util.Hashtable sequenceMapping;
+ /** DOCUMENT ME!! */
+ public String description;
- /** DOCUMENT ME!! */
- public float graphMin;
+ /** DOCUMENT ME!! */
+ public Annotation[] annotations;
- /** DOCUMENT ME!! */
- public float graphMax;
+ public java.util.Hashtable sequenceMapping;
- public GraphLine threshold;
+ /** DOCUMENT ME!! */
+ public float graphMin;
- // Graphical hints and tips
+ /** DOCUMENT ME!! */
+ public float graphMax;
- /** DOCUMENT ME!! */
- public boolean editable = false;
+ public GraphLine threshold;
- /** DOCUMENT ME!! */
- public boolean hasIcons; //
+ // Graphical hints and tips
- /** DOCUMENT ME!! */
- public boolean hasText;
+ /** DOCUMENT ME!! */
+ public boolean editable = false;
- /** DOCUMENT ME!! */
- public boolean visible = true;
+ /** DOCUMENT ME!! */
+ public boolean hasIcons; //
- public int graphGroup = -1;
+ /** DOCUMENT ME!! */
+ public boolean hasText;
- /** DOCUMENT ME!! */
- public int height = 0;
+ /** DOCUMENT ME!! */
+ public boolean visible = true;
- public int graph = 0;
+ public int graphGroup = -1;
- public int graphHeight = 40;
+ /** DOCUMENT ME!! */
+ public int height = 0;
- public static final int NO_GRAPH = 0;
+ public int graph = 0;
- public static final int BAR_GRAPH = 1;
+ public int graphHeight = 40;
- public static final int LINE_GRAPH = 2;
+ public static final int NO_GRAPH = 0;
- public static int getGraphValueFromString(String string)
+ public static final int BAR_GRAPH = 1;
+
+ public static final int LINE_GRAPH = 2;
+
+ public static int getGraphValueFromString(String string)
+ {
+ if (string.equalsIgnoreCase("BAR_GRAPH"))
{
- if(string.equalsIgnoreCase("BAR_GRAPH"))
- return BAR_GRAPH;
- else if(string.equalsIgnoreCase("LINE_GRAPH"))
- return LINE_GRAPH;
- else
- return NO_GRAPH;
+ return BAR_GRAPH;
}
-
- /**
- * Creates a new AlignmentAnnotation object.
- *
- * @param label DOCUMENT ME!
- * @param description DOCUMENT ME!
- * @param annotations DOCUMENT ME!
- */
- public AlignmentAnnotation(String label, String description,
- Annotation[] annotations)
+ else if (string.equalsIgnoreCase("LINE_GRAPH"))
{
- // always editable?
- editable = true;
- this.label = label;
- this.description = description;
- this.annotations = annotations;
-
- for (int i = 0; i < annotations.length; i++)
- {
- if ((annotations[i] != null) &&
- ((annotations[i].secondaryStructure == 'H') ||
- (annotations[i].secondaryStructure == 'E')))
- {
- hasIcons = true;
- }
-
- if ((annotations[i] != null) &&
- (annotations[i].displayCharacter.length() > 0))
- {
- hasText = true;
- }
- }
+ return LINE_GRAPH;
}
-
- /**
- * Creates a new AlignmentAnnotation object.
- *
- * @param label DOCUMENT ME!
- * @param description DOCUMENT ME!
- * @param annotations DOCUMENT ME!
- * @param min DOCUMENT ME!
- * @param max DOCUMENT ME!
- * @param winLength DOCUMENT ME!
- */
- public AlignmentAnnotation(String label, String description,
- Annotation[] annotations, float min, float max, int graphType)
+ else
{
- // graphs are not editable
- this.label = label;
- this.description = description;
- this.annotations = annotations;
- graph = graphType;
+ return NO_GRAPH;
+ }
+ }
+
+ /**
+ * Creates a new AlignmentAnnotation object.
+ *
+ * @param label DOCUMENT ME!
+ * @param description DOCUMENT ME!
+ * @param annotations DOCUMENT ME!
+ */
+ public AlignmentAnnotation(String label, String description,
+ Annotation[] annotations)
+ {
+ // always editable?
+ editable = true;
+ this.label = label;
+ this.description = description;
+ this.annotations = annotations;
+
+ areLabelsSecondaryStructure();
+ }
+
+ void areLabelsSecondaryStructure()
+ {
+ boolean nonSSLabel = false;
+ for (int i = 0; i < annotations.length; i++)
+ {
+ if (annotations[i] == null)
+ {
+ continue;
+ }
- boolean drawValues = true;
+ if (annotations[i].secondaryStructure == 'H' ||
+ annotations[i].secondaryStructure == 'E')
+ {
+ hasIcons = true;
+ }
- if (min == max)
+ if (annotations[i].displayCharacter.length() == 1
+ && !annotations[i].displayCharacter.equals("H")
+ && !annotations[i].displayCharacter.equals("E")
+ && !annotations[i].displayCharacter.equals("-")
+ && !annotations[i].displayCharacter.equals("."))
+ {
+ if (jalview.schemes.ResidueProperties.aaIndex
+ [annotations[i].displayCharacter.charAt(0)] < 23)
{
- min = 999999999;
- for (int i = 0; i < annotations.length; i++)
- {
- if (annotations[i] == null)
- {
- continue;
- }
-
- if(drawValues && annotations[i].displayCharacter.length() > 1 )
- {
- drawValues = false;
- }
-
- if (annotations[i].value > max)
- {
- max = annotations[i].value;
- }
-
- if (annotations[i].value < min)
- {
- min = annotations[i].value;
- }
- }
+ nonSSLabel = true;
}
+ }
- graphMin = min;
- graphMax = max;
+ if (annotations[i].displayCharacter.length() > 0)
+ {
+ hasText = true;
+ }
+ }
- for (int i = 0; i < annotations.length; i++)
+ if (nonSSLabel)
+ {
+ hasIcons = false;
+ for (int j = 0; j < annotations.length; j++)
+ {
+ if (annotations[j] != null && annotations[j].secondaryStructure != ' ')
{
- if (!hasIcons
- && annotations[i] != null
- && ((annotations[i].secondaryStructure == 'H') ||
- (annotations[i].secondaryStructure == 'E')))
- {
- hasIcons = true;
- }
-
- if (!hasText
- && annotations[i]!=null
- && annotations[i].displayCharacter.length() > 0)
- {
- hasText = true;
- }
+ annotations[j].displayCharacter
+ = String.valueOf(annotations[j].secondaryStructure);
+ annotations[j].secondaryStructure = ' ';
}
- if(!drawValues && graphType!=NO_GRAPH)
- {
- for (int i = 0; i < annotations.length; i++)
- {
- if (annotations[i] != null)
- annotations[i].displayCharacter = "";
- }
- }
+ }
+
}
- /**
- * DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- */
- public String toString()
+ annotationId = this.hashCode() + "";
+ }
+
+ /**
+ * Creates a new AlignmentAnnotation object.
+ *
+ * @param label DOCUMENT ME!
+ * @param description DOCUMENT ME!
+ * @param annotations DOCUMENT ME!
+ * @param min DOCUMENT ME!
+ * @param max DOCUMENT ME!
+ * @param winLength DOCUMENT ME!
+ */
+ public AlignmentAnnotation(String label, String description,
+ Annotation[] annotations, float min, float max,
+ int graphType)
+ {
+ // graphs are not editable
+ this.label = label;
+ this.description = description;
+ this.annotations = annotations;
+ graph = graphType;
+
+ boolean drawValues = true;
+
+ if (min == max)
{
- StringBuffer buffer = new StringBuffer();
-
- for (int i = 0; i < annotations.length; i++)
+ min = 999999999;
+ for (int i = 0; i < annotations.length; i++)
+ {
+ if (annotations[i] == null)
{
- if (annotations[i] != null)
- {
- if (graph!=0)
- {
- buffer.append(annotations[i].value);
- }
- else if (hasIcons)
- {
- buffer.append(annotations[i].secondaryStructure);
- }
- else
- {
- buffer.append(annotations[i].displayCharacter);
- }
- }
-
- buffer.append(", ");
+ continue;
}
- if (label.equals("Consensus"))
+ if (drawValues && annotations[i].displayCharacter.length() > 1)
{
- buffer.append("\n");
-
- for (int i = 0; i < annotations.length; i++)
- {
- if (annotations[i] != null)
- {
- buffer.append(annotations[i].description);
- }
+ drawValues = false;
+ }
- buffer.append(", ");
- }
+ if (annotations[i].value > max)
+ {
+ max = annotations[i].value;
}
- return buffer.toString();
+ if (annotations[i].value < min)
+ {
+ min = annotations[i].value;
+ }
}
+ }
+
+ graphMin = min;
+ graphMax = max;
+
+ areLabelsSecondaryStructure();
- public void setThreshold(GraphLine line)
+ if (!drawValues && graphType != NO_GRAPH)
+ {
+ for (int i = 0; i < annotations.length; i++)
{
- threshold = line;
+ if (annotations[i] != null)
+ {
+ annotations[i].displayCharacter = "";
+ }
}
-
- public GraphLine getThreshold()
+ }
+ }
+
+ /**
+ * DOCUMENT ME!
+ *
+ * @return DOCUMENT ME!
+ */
+ public String toString()
+ {
+ StringBuffer buffer = new StringBuffer();
+
+ for (int i = 0; i < annotations.length; i++)
+ {
+ if (annotations[i] != null)
{
- return threshold;
+ if (graph != 0)
+ {
+ buffer.append(annotations[i].value);
+ }
+ else if (hasIcons)
+ {
+ buffer.append(annotations[i].secondaryStructure);
+ }
+ else
+ {
+ buffer.append(annotations[i].displayCharacter);
+ }
}
- /**
- * Attach the annotation to seqRef, starting from startRes position.
- * @param seqRef
- * @param startRes
- */
- public void createSequenceMapping(SequenceI seqRef, int startRes)
+ buffer.append(", ");
+ }
+
+ if (label.equals("Consensus"))
+ {
+ buffer.append("\n");
+
+ for (int i = 0; i < annotations.length; i++)
{
- if(seqRef == null)
- return;
+ if (annotations[i] != null)
+ {
+ buffer.append(annotations[i].description);
+ }
- sequenceMapping = new java.util.Hashtable();
+ buffer.append(", ");
+ }
+ }
- sequenceRef = seqRef;
+ return buffer.toString();
+ }
+
+ public void setThreshold(GraphLine line)
+ {
+ threshold = line;
+ }
+
+ public GraphLine getThreshold()
+ {
+ return threshold;
+ }
+
+ /**
+ * Attach the annotation to seqRef, starting from startRes position. If alreadyMapped is true then the indices of the annotation[] array are sequence positions rather than alignment column positions.
+ * @param seqRef
+ * @param startRes
+ * @param alreadyMapped
+ */
+ public void createSequenceMapping(SequenceI seqRef,
+ int startRes,
+ boolean alreadyMapped)
+ {
+
+ if (seqRef == null)
+ {
+ return;
+ }
- if(startRes < sequenceRef.getStart())
- startRes = sequenceRef.getStart();
+ sequenceMapping = new java.util.Hashtable();
- int seqPos;
+ sequenceRef = seqRef;
+ int seqPos;
- int fileOffset = 0;
- if(startRes > sequenceRef.getStart())
+ for (int i = 0; i < annotations.length; i++)
+ {
+ if (annotations[i] != null)
+ {
+ if (alreadyMapped)
{
- fileOffset = startRes - sequenceRef.getStart();
+ seqPos = seqRef.findPosition(i);
}
-
- for(int i = 0; i < annotations.length; i++)
+ else
{
- seqPos = sequenceRef.findPosition(i + fileOffset);
- if(seqPos<annotations.length)
- {
- if (annotations[i] != null)
- {
- sequenceMapping.put(new Integer(seqPos),
- annotations[i]);
- }
- }
- }
-
- adjustForAlignment();
+ seqPos = i + startRes;
+ }
+ sequenceMapping.put(new Integer(seqPos), annotations[i]);
}
+ }
+
+ }
- public void adjustForAlignment()
+ public void adjustForAlignment()
+ {
+ int a = 0, aSize = sequenceRef.getLength();
+
+ if (aSize == 0)
+ {
+ //Its been deleted
+ return;
+ }
+
+ int position;
+ Annotation[] temp = new Annotation[aSize];
+ Integer index;
+
+ for (a = sequenceRef.getStart(); a <= sequenceRef.getEnd(); a++)
+ {
+ index = new Integer(a);
+ if (sequenceMapping.containsKey(index))
{
- int a=0, aSize = sequenceRef.getLength();
-
- if(aSize == 0)
- {
- //Its been deleted
- return;
- }
-
- int position;
- Annotation[] temp = new Annotation[aSize];
- Integer index;
-
- for (a = sequenceRef.getStart(); a <= sequenceRef.getEnd(); a++)
- {
- index = new Integer(a);
- if(sequenceMapping.containsKey(index))
- {
- position = sequenceRef.findIndex(a)-1;
-
- temp[position] = (Annotation)sequenceMapping.get(index);
- }
- }
-
- annotations = temp;
- }
-}
+ position = sequenceRef.findIndex(a) - 1;
+ temp[position] = (Annotation) sequenceMapping.get(index);
+ }
+ }
+ annotations = temp;
+ }
+}