src/jalview/datamodel/Annotation.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer
   3  * Copyright (C) 2007 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  18  */
  19 package jalview.datamodel;
  20
  21 import java.awt.*;
  22
  23 /**
  24  * DOCUMENT ME!
  25  *
  26  * @author $author$
  27  * @version $Revision$
  28  */
  29 public class Annotation
  30 {
  31   /** DOCUMENT ME!! */
  32   public String displayCharacter = "";
  33
  34   /** DOCUMENT ME!! */
  35   public String description = ""; // currently used as mouse over
  36
  37   /** DOCUMENT ME!! */
  38   public char secondaryStructure = ' '; // recognises H and E
  39
  40   /** DOCUMENT ME!! */
  41   public float value;
  42
  43   // add visual cues here
  44
  45   /** DOCUMENT ME!! */
  46   public Color colour = Color.black;
  47
  48   /**
  49    * Creates a new Annotation object.
  50    *
  51    * @param displayChar DOCUMENT ME!
  52    * @param desc DOCUMENT ME!
  53    * @param ss DOCUMENT ME!
  54    * @param val DOCUMENT ME!
  55    */
  56   public Annotation(String displayChar, String desc, char ss, float val)
  57   {
  58     displayCharacter = displayChar;
  59     description = desc;
  60     secondaryStructure = ss;
  61     value = val;
  62   }
  63
  64   /**
  65    * Creates a new Annotation object.
  66    *
  67    * @param displayChar DOCUMENT ME!
  68    * @param desc DOCUMENT ME!
  69    * @param ss DOCUMENT ME!
  70    * @param val DOCUMENT ME!
  71    * @param colour DOCUMENT ME!
  72    */
  73   public Annotation(String displayChar, String desc, char ss, float val,
  74                     Color colour)
  75   {
  76     this(displayChar, desc, ss, val);
  77     this.colour = colour;
  78   }
  79   /**
  80    * Copy constructor
  81    * New annotation takes on the same (or duplicated) attributes as the given template
  82    * @param that template annotation
  83    */
  84   public Annotation(Annotation that) {
  85     if (that==null || this==that)
  86     {
  87       return;
  88     }
  89     if (that.displayCharacter!=null)
  90       displayCharacter = new String(that.displayCharacter);
  91     if (that.description!=null)
  92       description = new String(that.description);
  93     secondaryStructure = that.secondaryStructure;
  94     value = that.value;
  95     colour = that.colour;
  96   }
  97
  98   /**
  99    * Value only annotation.
 100    * @param val value at this annotation position
 101    */
 102   public Annotation(float val)
 103   {
 104     this(null, null, '\0', val);
 105   }
 106 }