src/jalview/binding/AnnotationElement.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.binding;
  20
  21 //---------------------------------/
  22 //- Imported classes and packages -/
  23 //---------------------------------/
  24
  25 import org.exolab.castor.xml.Marshaller;
  26 import org.exolab.castor.xml.Unmarshaller;
  27
  28 /**
  29  * Class AnnotationElement.
  30  *
  31  * @version $Revision$ $Date$
  32  */
  33 public class AnnotationElement implements java.io.Serializable
  34 {
  35
  36   // --------------------------/
  37   // - Class/Member Variables -/
  38   // --------------------------/
  39
  40   /**
  41    * Field _position.
  42    */
  43   private int _position;
  44
  45   /**
  46    * keeps track of state for field: _position
  47    */
  48   private boolean _has_position;
  49
  50   /**
  51    * Field _displayCharacter.
  52    */
  53   private java.lang.String _displayCharacter;
  54
  55   /**
  56    * Field _description.
  57    */
  58   private java.lang.String _description;
  59
  60   /**
  61    * Field _secondaryStructure.
  62    */
  63   private java.lang.String _secondaryStructure;
  64
  65   /**
  66    * Field _value.
  67    */
  68   private float _value;
  69
  70   /**
  71    * keeps track of state for field: _value
  72    */
  73   private boolean _has_value;
  74
  75   // ----------------/
  76   // - Constructors -/
  77   // ----------------/
  78
  79   public AnnotationElement()
  80   {
  81     super();
  82   }
  83
  84   // -----------/
  85   // - Methods -/
  86   // -----------/
  87
  88   /**
  89      */
  90   public void deletePosition()
  91   {
  92     this._has_position = false;
  93   }
  94
  95   /**
  96      */
  97   public void deleteValue()
  98   {
  99     this._has_value = false;
 100   }
 101
 102   /**
 103    * Returns the value of field 'description'.
 104    *
 105    * @return the value of field 'Description'.
 106    */
 107   public java.lang.String getDescription()
 108   {
 109     return this._description;
 110   }
 111
 112   /**
 113    * Returns the value of field 'displayCharacter'.
 114    *
 115    * @return the value of field 'DisplayCharacter'.
 116    */
 117   public java.lang.String getDisplayCharacter()
 118   {
 119     return this._displayCharacter;
 120   }
 121
 122   /**
 123    * Returns the value of field 'position'.
 124    *
 125    * @return the value of field 'Position'.
 126    */
 127   public int getPosition()
 128   {
 129     return this._position;
 130   }
 131
 132   /**
 133    * Returns the value of field 'secondaryStructure'.
 134    *
 135    * @return the value of field 'SecondaryStructure'.
 136    */
 137   public java.lang.String getSecondaryStructure()
 138   {
 139     return this._secondaryStructure;
 140   }
 141
 142   /**
 143    * Returns the value of field 'value'.
 144    *
 145    * @return the value of field 'Value'.
 146    */
 147   public float getValue()
 148   {
 149     return this._value;
 150   }
 151
 152   /**
 153    * Method hasPosition.
 154    *
 155    * @return true if at least one Position has been added
 156    */
 157   public boolean hasPosition()
 158   {
 159     return this._has_position;
 160   }
 161
 162   /**
 163    * Method hasValue.
 164    *
 165    * @return true if at least one Value has been added
 166    */
 167   public boolean hasValue()
 168   {
 169     return this._has_value;
 170   }
 171
 172   /**
 173    * Method isValid.
 174    *
 175    * @return true if this object is valid according to the schema
 176    */
 177   public boolean isValid()
 178   {
 179     try
 180     {
 181       validate();
 182     } catch (org.exolab.castor.xml.ValidationException vex)
 183     {
 184       return false;
 185     }
 186     return true;
 187   }
 188
 189   /**
 190    *
 191    *
 192    * @param out
 193    * @throws org.exolab.castor.xml.MarshalException
 194    *           if object is null or if any SAXException is thrown during
 195    *           marshaling
 196    * @throws org.exolab.castor.xml.ValidationException
 197    *           if this object is an invalid instance according to the schema
 198    */
 199   public void marshal(final java.io.Writer out)
 200           throws org.exolab.castor.xml.MarshalException,
 201           org.exolab.castor.xml.ValidationException
 202   {
 203     Marshaller.marshal(this, out);
 204   }
 205
 206   /**
 207    *
 208    *
 209    * @param handler
 210    * @throws java.io.IOException
 211    *           if an IOException occurs during marshaling
 212    * @throws org.exolab.castor.xml.ValidationException
 213    *           if this object is an invalid instance according to the schema
 214    * @throws org.exolab.castor.xml.MarshalException
 215    *           if object is null or if any SAXException is thrown during
 216    *           marshaling
 217    */
 218   public void marshal(final org.xml.sax.ContentHandler handler)
 219           throws java.io.IOException,
 220           org.exolab.castor.xml.MarshalException,
 221           org.exolab.castor.xml.ValidationException
 222   {
 223     Marshaller.marshal(this, handler);
 224   }
 225
 226   /**
 227    * Sets the value of field 'description'.
 228    *
 229    * @param description
 230    *          the value of field 'description'.
 231    */
 232   public void setDescription(final java.lang.String description)
 233   {
 234     this._description = description;
 235   }
 236
 237   /**
 238    * Sets the value of field 'displayCharacter'.
 239    *
 240    * @param displayCharacter
 241    *          the value of field 'displayCharacter'
 242    */
 243   public void setDisplayCharacter(final java.lang.String displayCharacter)
 244   {
 245     this._displayCharacter = displayCharacter;
 246   }
 247
 248   /**
 249    * Sets the value of field 'position'.
 250    *
 251    * @param position
 252    *          the value of field 'position'.
 253    */
 254   public void setPosition(final int position)
 255   {
 256     this._position = position;
 257     this._has_position = true;
 258   }
 259
 260   /**
 261    * Sets the value of field 'secondaryStructure'.
 262    *
 263    * @param secondaryStructure
 264    *          the value of field 'secondaryStructure'.
 265    */
 266   public void setSecondaryStructure(
 267           final java.lang.String secondaryStructure)
 268   {
 269     this._secondaryStructure = secondaryStructure;
 270   }
 271
 272   /**
 273    * Sets the value of field 'value'.
 274    *
 275    * @param value
 276    *          the value of field 'value'.
 277    */
 278   public void setValue(final float value)
 279   {
 280     this._value = value;
 281     this._has_value = true;
 282   }
 283
 284   /**
 285    * Method unmarshal.
 286    *
 287    * @param reader
 288    * @throws org.exolab.castor.xml.MarshalException
 289    *           if object is null or if any SAXException is thrown during
 290    *           marshaling
 291    * @throws org.exolab.castor.xml.ValidationException
 292    *           if this object is an invalid instance according to the schema
 293    * @return the unmarshaled jalview.binding.AnnotationElement
 294    */
 295   public static jalview.binding.AnnotationElement unmarshal(
 296           final java.io.Reader reader)
 297           throws org.exolab.castor.xml.MarshalException,
 298           org.exolab.castor.xml.ValidationException
 299   {
 300     return (jalview.binding.AnnotationElement) Unmarshaller.unmarshal(
 301             jalview.binding.AnnotationElement.class, reader);
 302   }
 303
 304   /**
 305    *
 306    *
 307    * @throws org.exolab.castor.xml.ValidationException
 308    *           if this object is an invalid instance according to the schema
 309    */
 310   public void validate() throws org.exolab.castor.xml.ValidationException
 311   {
 312     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 313     validator.validate(this);
 314   }
 315
 316 }