/*
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8)
- * Copyright (C) 2012 J Procter, AM Waterhouse, LM Lui, J Engelhardt, G Barton, M Clamp, S Searle
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
*
* This file is part of Jalview.
*
* Jalview 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 3 of the License, or (at your option) any later version.
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
*
* Jalview 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 Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
*/
package jalview.datamodel;
*/
public class Annotation
{
+ /**
+ * the empty annotation - proxy for null entries in annotation row
+ */
+ public static final Annotation EMPTY_ANNOTATION = new Annotation("", "",
+ ' ', 0f);
+
/** Character label - also shown below histogram */
public String displayCharacter = "";
*/
public char secondaryStructure = ' ';
- /** Score for the position - used in histograms, line graphs and for shading */
+ /**
+ * Score for the position - used in histograms, line graphs and for shading
+ */
public float value;
-
+
/** Colour for position */
public Color colour;
description = desc;
secondaryStructure = ss;
value = val;
-
+
}
/**
return;
}
if (that.displayCharacter != null)
+ {
displayCharacter = new String(that.displayCharacter);
+ }
if (that.description != null)
+ {
description = new String(that.description);
+ }
secondaryStructure = that.secondaryStructure;
value = that.value;
colour = that.colour;
*/
public Annotation(float val)
{
- this(null, null, ' ', val,null);
+ this(null, null, ' ', val, null);
}
/**
* human readable representation of an annotation row element.
- *
+ *
* Format is 'display Char','secondary Structure
* Char',"description",score,[colourstring]
- *
+ *
* fields may be missing if they are null, whitespace, or equivalent to
* Float.NaN
*/
{
sb.append(",");
}
- if (value != Float.NaN)
+ if (!Float.isNaN(value))
{
sb.append(value);
}
}
return sb.toString();
}
+
+ /**
+ * @return true if annot is 'whitespace' annotation (zero score, whitespace or
+ * zero length display character, label, description
+ */
+ public boolean isWhitespace()
+ {
+ return ((value == 0f)
+ && ((description == null) || (description.trim().length() == 0))
+ && ((displayCharacter == null)
+ || (displayCharacter.trim().length() == 0)
+ || (displayCharacter.equals(" ."))) // RNA Stockholm blank
+ // displayCharacter can
+ // end up like this
+ && (secondaryStructure == '\0' || (secondaryStructure == ' '))
+ && colour == null);
+ }
}