src/jalview/schemabinding/version2/SequenceType.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This file is part of Jalview.\r
   6  * \r
   7  * Jalview is free software: you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License \r
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10  * \r
  11  * Jalview is distributed in the hope that it will be useful, but \r
  12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14  * PURPOSE.  See the GNU General Public License for more details.\r
  15  * \r
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17  */\r
  18 package jalview.schemabinding.version2;\r
  19 \r
  20 //---------------------------------/\r
  21 //- Imported classes and packages -/\r
  22 //---------------------------------/\r
  23 \r
  24 import org.exolab.castor.xml.Marshaller;\r
  25 import org.exolab.castor.xml.Unmarshaller;\r
  26 \r
  27 /**\r
  28  * Class SequenceType.\r
  29  * \r
  30  * @version $Revision$ $Date$\r
  31  */\r
  32 public class SequenceType implements java.io.Serializable\r
  33 {\r
  34 \r
  35   // --------------------------/\r
  36   // - Class/Member Variables -/\r
  37   // --------------------------/\r
  38 \r
  39   /**\r
  40    * Field _id.\r
  41    */\r
  42   private java.lang.String _id;\r
  43 \r
  44   /**\r
  45    * Field _description.\r
  46    */\r
  47   private java.lang.String _description;\r
  48 \r
  49   /**\r
  50    * Field _sequence.\r
  51    */\r
  52   private java.lang.String _sequence;\r
  53 \r
  54   /**\r
  55    * Field _name.\r
  56    */\r
  57   private java.lang.String _name;\r
  58 \r
  59   // ----------------/\r
  60   // - Constructors -/\r
  61   // ----------------/\r
  62 \r
  63   public SequenceType()\r
  64   {\r
  65     super();\r
  66   }\r
  67 \r
  68   // -----------/\r
  69   // - Methods -/\r
  70   // -----------/\r
  71 \r
  72   /**\r
  73    * Returns the value of field 'description'.\r
  74    * \r
  75    * @return the value of field 'Description'.\r
  76    */\r
  77   public java.lang.String getDescription()\r
  78   {\r
  79     return this._description;\r
  80   }\r
  81 \r
  82   /**\r
  83    * Returns the value of field 'id'.\r
  84    * \r
  85    * @return the value of field 'Id'.\r
  86    */\r
  87   public java.lang.String getId()\r
  88   {\r
  89     return this._id;\r
  90   }\r
  91 \r
  92   /**\r
  93    * Returns the value of field 'name'.\r
  94    * \r
  95    * @return the value of field 'Name'.\r
  96    */\r
  97   public java.lang.String getName()\r
  98   {\r
  99     return this._name;\r
 100   }\r
 101 \r
 102   /**\r
 103    * Returns the value of field 'sequence'.\r
 104    * \r
 105    * @return the value of field 'Sequence'.\r
 106    */\r
 107   public java.lang.String getSequence()\r
 108   {\r
 109     return this._sequence;\r
 110   }\r
 111 \r
 112   /**\r
 113    * Method isValid.\r
 114    * \r
 115    * @return true if this object is valid according to the schema\r
 116    */\r
 117   public boolean isValid()\r
 118   {\r
 119     try\r
 120     {\r
 121       validate();\r
 122     } catch (org.exolab.castor.xml.ValidationException vex)\r
 123     {\r
 124       return false;\r
 125     }\r
 126     return true;\r
 127   }\r
 128 \r
 129   /**\r
 130    * \r
 131    * \r
 132    * @param out\r
 133    * @throws org.exolab.castor.xml.MarshalException\r
 134    *           if object is null or if any SAXException is thrown during\r
 135    *           marshaling\r
 136    * @throws org.exolab.castor.xml.ValidationException\r
 137    *           if this object is an invalid instance according to the schema\r
 138    */\r
 139   public void marshal(final java.io.Writer out)\r
 140           throws org.exolab.castor.xml.MarshalException,\r
 141           org.exolab.castor.xml.ValidationException\r
 142   {\r
 143     Marshaller.marshal(this, out);\r
 144   }\r
 145 \r
 146   /**\r
 147    * \r
 148    * \r
 149    * @param handler\r
 150    * @throws java.io.IOException\r
 151    *           if an IOException occurs during marshaling\r
 152    * @throws org.exolab.castor.xml.ValidationException\r
 153    *           if this object is an invalid instance according to the schema\r
 154    * @throws org.exolab.castor.xml.MarshalException\r
 155    *           if object is null or if any SAXException is thrown during\r
 156    *           marshaling\r
 157    */\r
 158   public void marshal(final org.xml.sax.ContentHandler handler)\r
 159           throws java.io.IOException,\r
 160           org.exolab.castor.xml.MarshalException,\r
 161           org.exolab.castor.xml.ValidationException\r
 162   {\r
 163     Marshaller.marshal(this, handler);\r
 164   }\r
 165 \r
 166   /**\r
 167    * Sets the value of field 'description'.\r
 168    * \r
 169    * @param description\r
 170    *          the value of field 'description'.\r
 171    */\r
 172   public void setDescription(final java.lang.String description)\r
 173   {\r
 174     this._description = description;\r
 175   }\r
 176 \r
 177   /**\r
 178    * Sets the value of field 'id'.\r
 179    * \r
 180    * @param id\r
 181    *          the value of field 'id'.\r
 182    */\r
 183   public void setId(final java.lang.String id)\r
 184   {\r
 185     this._id = id;\r
 186   }\r
 187 \r
 188   /**\r
 189    * Sets the value of field 'name'.\r
 190    * \r
 191    * @param name\r
 192    *          the value of field 'name'.\r
 193    */\r
 194   public void setName(final java.lang.String name)\r
 195   {\r
 196     this._name = name;\r
 197   }\r
 198 \r
 199   /**\r
 200    * Sets the value of field 'sequence'.\r
 201    * \r
 202    * @param sequence\r
 203    *          the value of field 'sequence'.\r
 204    */\r
 205   public void setSequence(final java.lang.String sequence)\r
 206   {\r
 207     this._sequence = sequence;\r
 208   }\r
 209 \r
 210   /**\r
 211    * Method unmarshal.\r
 212    * \r
 213    * @param reader\r
 214    * @throws org.exolab.castor.xml.MarshalException\r
 215    *           if object is null or if any SAXException is thrown during\r
 216    *           marshaling\r
 217    * @throws org.exolab.castor.xml.ValidationException\r
 218    *           if this object is an invalid instance according to the schema\r
 219    * @return the unmarshaled jalview.schemabinding.version2.SequenceType\r
 220    */\r
 221   public static jalview.schemabinding.version2.SequenceType unmarshal(\r
 222           final java.io.Reader reader)\r
 223           throws org.exolab.castor.xml.MarshalException,\r
 224           org.exolab.castor.xml.ValidationException\r
 225   {\r
 226     return (jalview.schemabinding.version2.SequenceType) Unmarshaller\r
 227             .unmarshal(jalview.schemabinding.version2.SequenceType.class,\r
 228                     reader);\r
 229   }\r
 230 \r
 231   /**\r
 232    * \r
 233    * \r
 234    * @throws org.exolab.castor.xml.ValidationException\r
 235    *           if this object is an invalid instance according to the schema\r
 236    */\r
 237   public void validate() throws org.exolab.castor.xml.ValidationException\r
 238   {\r
 239     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 240     validator.validate(this);\r
 241   }\r
 242 \r
 243 }\r