src/jalview/schemabinding/version2/SequenceType.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.4.1)\r
   3  * Copyright (C) 2009 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       //----------------/\r
  62      //- Constructors -/\r
  63     //----------------/\r
  64 \r
  65     public SequenceType() {\r
  66         super();\r
  67     }\r
  68 \r
  69 \r
  70       //-----------/\r
  71      //- Methods -/\r
  72     //-----------/\r
  73 \r
  74     /**\r
  75      * Returns the value of field 'description'.\r
  76      * \r
  77      * @return the value of field 'Description'.\r
  78      */\r
  79     public java.lang.String getDescription(\r
  80     ) {\r
  81         return this._description;\r
  82     }\r
  83 \r
  84     /**\r
  85      * Returns the value of field 'id'.\r
  86      * \r
  87      * @return the value of field 'Id'.\r
  88      */\r
  89     public java.lang.String getId(\r
  90     ) {\r
  91         return this._id;\r
  92     }\r
  93 \r
  94     /**\r
  95      * Returns the value of field 'name'.\r
  96      * \r
  97      * @return the value of field 'Name'.\r
  98      */\r
  99     public java.lang.String getName(\r
 100     ) {\r
 101         return this._name;\r
 102     }\r
 103 \r
 104     /**\r
 105      * Returns the value of field 'sequence'.\r
 106      * \r
 107      * @return the value of field 'Sequence'.\r
 108      */\r
 109     public java.lang.String getSequence(\r
 110     ) {\r
 111         return this._sequence;\r
 112     }\r
 113 \r
 114     /**\r
 115      * Method isValid.\r
 116      * \r
 117      * @return true if this object is valid according to the schema\r
 118      */\r
 119     public boolean isValid(\r
 120     ) {\r
 121         try {\r
 122             validate();\r
 123         } catch (org.exolab.castor.xml.ValidationException vex) {\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 if object is\r
 134      * null or if any SAXException is thrown during marshaling\r
 135      * @throws org.exolab.castor.xml.ValidationException if this\r
 136      * object is an invalid instance according to the schema\r
 137      */\r
 138     public void marshal(\r
 139             final java.io.Writer out)\r
 140     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 141         Marshaller.marshal(this, out);\r
 142     }\r
 143 \r
 144     /**\r
 145      * \r
 146      * \r
 147      * @param handler\r
 148      * @throws java.io.IOException if an IOException occurs during\r
 149      * marshaling\r
 150      * @throws org.exolab.castor.xml.ValidationException if this\r
 151      * object is an invalid instance according to the schema\r
 152      * @throws org.exolab.castor.xml.MarshalException if object is\r
 153      * null or if any SAXException is thrown during marshaling\r
 154      */\r
 155     public void marshal(\r
 156             final org.xml.sax.ContentHandler handler)\r
 157     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 158         Marshaller.marshal(this, handler);\r
 159     }\r
 160 \r
 161     /**\r
 162      * Sets the value of field 'description'.\r
 163      * \r
 164      * @param description the value of field 'description'.\r
 165      */\r
 166     public void setDescription(\r
 167             final java.lang.String description) {\r
 168         this._description = description;\r
 169     }\r
 170 \r
 171     /**\r
 172      * Sets the value of field 'id'.\r
 173      * \r
 174      * @param id the value of field 'id'.\r
 175      */\r
 176     public void setId(\r
 177             final java.lang.String id) {\r
 178         this._id = id;\r
 179     }\r
 180 \r
 181     /**\r
 182      * Sets the value of field 'name'.\r
 183      * \r
 184      * @param name the value of field 'name'.\r
 185      */\r
 186     public void setName(\r
 187             final java.lang.String name) {\r
 188         this._name = name;\r
 189     }\r
 190 \r
 191     /**\r
 192      * Sets the value of field 'sequence'.\r
 193      * \r
 194      * @param sequence the value of field 'sequence'.\r
 195      */\r
 196     public void setSequence(\r
 197             final java.lang.String sequence) {\r
 198         this._sequence = sequence;\r
 199     }\r
 200 \r
 201     /**\r
 202      * Method unmarshal.\r
 203      * \r
 204      * @param reader\r
 205      * @throws org.exolab.castor.xml.MarshalException if object is\r
 206      * null or if any SAXException is thrown during marshaling\r
 207      * @throws org.exolab.castor.xml.ValidationException if this\r
 208      * object is an invalid instance according to the schema\r
 209      * @return the unmarshaled\r
 210      * jalview.schemabinding.version2.SequenceType\r
 211      */\r
 212     public static jalview.schemabinding.version2.SequenceType unmarshal(\r
 213             final java.io.Reader reader)\r
 214     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {\r
 215         return (jalview.schemabinding.version2.SequenceType) Unmarshaller.unmarshal(jalview.schemabinding.version2.SequenceType.class, reader);\r
 216     }\r
 217 \r
 218     /**\r
 219      * \r
 220      * \r
 221      * @throws org.exolab.castor.xml.ValidationException if this\r
 222      * object is an invalid instance according to the schema\r
 223      */\r
 224     public void validate(\r
 225     )\r
 226     throws org.exolab.castor.xml.ValidationException {\r
 227         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 228         validator.validate(this);\r
 229     }\r
 230 \r
 231 }\r