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