src/jalview/schemabinding/version2/SequenceType.java

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