src/jalview/binding/Feature.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4)
   3  * Copyright (C) 2008 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.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 Feature.
  30  *
  31  * @version $Revision$ $Date$
  32  */
  33 public class Feature implements java.io.Serializable
  34 {
  35
  36   // --------------------------/
  37   // - Class/Member Variables -/
  38   // --------------------------/
  39
  40   /**
  41    * Field _begin.
  42    */
  43   private int _begin;
  44
  45   /**
  46    * keeps track of state for field: _begin
  47    */
  48   private boolean _has_begin;
  49
  50   /**
  51    * Field _end.
  52    */
  53   private int _end;
  54
  55   /**
  56    * keeps track of state for field: _end
  57    */
  58   private boolean _has_end;
  59
  60   /**
  61    * Field _type.
  62    */
  63   private java.lang.String _type;
  64
  65   /**
  66    * Field _description.
  67    */
  68   private java.lang.String _description;
  69
  70   /**
  71    * Field _status.
  72    */
  73   private java.lang.String _status;
  74
  75   // ----------------/
  76   // - Constructors -/
  77   // ----------------/
  78
  79   public Feature()
  80   {
  81     super();
  82   }
  83
  84   // -----------/
  85   // - Methods -/
  86   // -----------/
  87
  88   /**
  89    */
  90   public void deleteBegin()
  91   {
  92     this._has_begin = false;
  93   }
  94
  95   /**
  96    */
  97   public void deleteEnd()
  98   {
  99     this._has_end = false;
 100   }
 101
 102   /**
 103    * Returns the value of field 'begin'.
 104    *
 105    * @return the value of field 'Begin'.
 106    */
 107   public int getBegin()
 108   {
 109     return this._begin;
 110   }
 111
 112   /**
 113    * Returns the value of field 'description'.
 114    *
 115    * @return the value of field 'Description'.
 116    */
 117   public java.lang.String getDescription()
 118   {
 119     return this._description;
 120   }
 121
 122   /**
 123    * Returns the value of field 'end'.
 124    *
 125    * @return the value of field 'End'.
 126    */
 127   public int getEnd()
 128   {
 129     return this._end;
 130   }
 131
 132   /**
 133    * Returns the value of field 'status'.
 134    *
 135    * @return the value of field 'Status'.
 136    */
 137   public java.lang.String getStatus()
 138   {
 139     return this._status;
 140   }
 141
 142   /**
 143    * Returns the value of field 'type'.
 144    *
 145    * @return the value of field 'Type'.
 146    */
 147   public java.lang.String getType()
 148   {
 149     return this._type;
 150   }
 151
 152   /**
 153    * Method hasBegin.
 154    *
 155    * @return true if at least one Begin has been added
 156    */
 157   public boolean hasBegin()
 158   {
 159     return this._has_begin;
 160   }
 161
 162   /**
 163    * Method hasEnd.
 164    *
 165    * @return true if at least one End has been added
 166    */
 167   public boolean hasEnd()
 168   {
 169     return this._has_end;
 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
 198    *                 schema
 199    */
 200   public void marshal(final java.io.Writer out)
 201           throws org.exolab.castor.xml.MarshalException,
 202           org.exolab.castor.xml.ValidationException
 203   {
 204     Marshaller.marshal(this, out);
 205   }
 206
 207   /**
 208    *
 209    *
 210    * @param handler
 211    * @throws java.io.IOException
 212    *                 if an IOException occurs during marshaling
 213    * @throws org.exolab.castor.xml.ValidationException
 214    *                 if this object is an invalid instance according to the
 215    *                 schema
 216    * @throws org.exolab.castor.xml.MarshalException
 217    *                 if object is null or if any SAXException is thrown during
 218    *                 marshaling
 219    */
 220   public void marshal(final org.xml.sax.ContentHandler handler)
 221           throws java.io.IOException,
 222           org.exolab.castor.xml.MarshalException,
 223           org.exolab.castor.xml.ValidationException
 224   {
 225     Marshaller.marshal(this, handler);
 226   }
 227
 228   /**
 229    * Sets the value of field 'begin'.
 230    *
 231    * @param begin
 232    *                the value of field 'begin'.
 233    */
 234   public void setBegin(final int begin)
 235   {
 236     this._begin = begin;
 237     this._has_begin = true;
 238   }
 239
 240   /**
 241    * Sets the value of field 'description'.
 242    *
 243    * @param description
 244    *                the value of field 'description'.
 245    */
 246   public void setDescription(final java.lang.String description)
 247   {
 248     this._description = description;
 249   }
 250
 251   /**
 252    * Sets the value of field 'end'.
 253    *
 254    * @param end
 255    *                the value of field 'end'.
 256    */
 257   public void setEnd(final int end)
 258   {
 259     this._end = end;
 260     this._has_end = true;
 261   }
 262
 263   /**
 264    * Sets the value of field 'status'.
 265    *
 266    * @param status
 267    *                the value of field 'status'.
 268    */
 269   public void setStatus(final java.lang.String status)
 270   {
 271     this._status = status;
 272   }
 273
 274   /**
 275    * Sets the value of field 'type'.
 276    *
 277    * @param type
 278    *                the value of field 'type'.
 279    */
 280   public void setType(final java.lang.String type)
 281   {
 282     this._type = type;
 283   }
 284
 285   /**
 286    * Method unmarshal.
 287    *
 288    * @param reader
 289    * @throws org.exolab.castor.xml.MarshalException
 290    *                 if object is null or if any SAXException is thrown during
 291    *                 marshaling
 292    * @throws org.exolab.castor.xml.ValidationException
 293    *                 if this object is an invalid instance according to the
 294    *                 schema
 295    * @return the unmarshaled jalview.binding.Feature
 296    */
 297   public static jalview.binding.Feature unmarshal(
 298           final java.io.Reader reader)
 299           throws org.exolab.castor.xml.MarshalException,
 300           org.exolab.castor.xml.ValidationException
 301   {
 302     return (jalview.binding.Feature) Unmarshaller.unmarshal(
 303             jalview.binding.Feature.class, reader);
 304   }
 305
 306   /**
 307    *
 308    *
 309    * @throws org.exolab.castor.xml.ValidationException
 310    *                 if this object is an invalid instance according to the
 311    *                 schema
 312    */
 313   public void validate() throws org.exolab.castor.xml.ValidationException
 314   {
 315     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 316     validator.validate(this);
 317   }
 318
 319 }