added help and documentation for annotation editing.
[jalview.git] / src / jalview / binding / JSeq.java
1 /*\r
2  * This class was automatically generated with\r
3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 package jalview.binding;\r
8 \r
9 import org.exolab.castor.xml.MarshalException;\r
10 import org.exolab.castor.xml.Marshaller;\r
11 import org.exolab.castor.xml.Unmarshaller;\r
12 import org.exolab.castor.xml.ValidationException;\r
13 \r
14 import org.xml.sax.ContentHandler;\r
15 \r
16 //---------------------------------/\r
17 //- Imported classes and packages -/\r
18 //---------------------------------/\r
19 import java.io.IOException;\r
20 import java.io.Reader;\r
21 import java.io.Serializable;\r
22 import java.io.Writer;\r
23 \r
24 \r
25 /**\r
26  * Class JSeq.\r
27  *\r
28  * @version $Revision$ $Date$\r
29  */\r
30 public class JSeq implements java.io.Serializable\r
31 {\r
32     //--------------------------/\r
33     //- Class/Member Variables -/\r
34     //--------------------------/\r
35 \r
36     /**\r
37      * Field _colour\r
38      */\r
39     private int _colour;\r
40 \r
41     /**\r
42      * keeps track of state for field: _colour\r
43      */\r
44     private boolean _has_colour;\r
45 \r
46     /**\r
47      * Field _start\r
48      */\r
49     private int _start;\r
50 \r
51     /**\r
52      * keeps track of state for field: _start\r
53      */\r
54     private boolean _has_start;\r
55 \r
56     /**\r
57      * Field _end\r
58      */\r
59     private int _end;\r
60 \r
61     /**\r
62      * keeps track of state for field: _end\r
63      */\r
64     private boolean _has_end;\r
65 \r
66     /**\r
67      * Field _id\r
68      */\r
69     private int _id;\r
70 \r
71     /**\r
72      * keeps track of state for field: _id\r
73      */\r
74     private boolean _has_id;\r
75 \r
76     //----------------/\r
77     //- Constructors -/\r
78     //----------------/\r
79     public JSeq()\r
80     {\r
81         super();\r
82     }\r
83 \r
84     //-- jalview.binding.JSeq()\r
85     //-----------/\r
86 \r
87     /**\r
88      * DOCUMENT ME!\r
89      */\r
90     public void deleteColour()\r
91     {\r
92         this._has_colour = false;\r
93     }\r
94 \r
95     //-- void deleteColour() \r
96 \r
97     /**\r
98      * Method deleteEnd\r
99      *\r
100      */\r
101     public void deleteEnd()\r
102     {\r
103         this._has_end = false;\r
104     }\r
105 \r
106     //-- void deleteEnd() \r
107 \r
108     /**\r
109      * Method deleteId\r
110      *\r
111      */\r
112     public void deleteId()\r
113     {\r
114         this._has_id = false;\r
115     }\r
116 \r
117     //-- void deleteId() \r
118 \r
119     /**\r
120      * Method deleteStart\r
121      *\r
122      */\r
123     public void deleteStart()\r
124     {\r
125         this._has_start = false;\r
126     }\r
127 \r
128     //-- void deleteStart() \r
129 \r
130     /**\r
131      * Returns the value of field 'colour'.\r
132      *\r
133      * @return int\r
134      * @return the value of field 'colour'.\r
135      */\r
136     public int getColour()\r
137     {\r
138         return this._colour;\r
139     }\r
140 \r
141     //-- int getColour() \r
142 \r
143     /**\r
144      * Returns the value of field 'end'.\r
145      *\r
146      * @return int\r
147      * @return the value of field 'end'.\r
148      */\r
149     public int getEnd()\r
150     {\r
151         return this._end;\r
152     }\r
153 \r
154     //-- int getEnd() \r
155 \r
156     /**\r
157      * Returns the value of field 'id'.\r
158      *\r
159      * @return int\r
160      * @return the value of field 'id'.\r
161      */\r
162     public int getId()\r
163     {\r
164         return this._id;\r
165     }\r
166 \r
167     //-- int getId() \r
168 \r
169     /**\r
170      * Returns the value of field 'start'.\r
171      *\r
172      * @return int\r
173      * @return the value of field 'start'.\r
174      */\r
175     public int getStart()\r
176     {\r
177         return this._start;\r
178     }\r
179 \r
180     //-- int getStart() \r
181 \r
182     /**\r
183      * Method hasColour\r
184      *\r
185      *\r
186      *\r
187      * @return boolean\r
188      */\r
189     public boolean hasColour()\r
190     {\r
191         return this._has_colour;\r
192     }\r
193 \r
194     //-- boolean hasColour() \r
195 \r
196     /**\r
197      * Method hasEnd\r
198      *\r
199      *\r
200      *\r
201      * @return boolean\r
202      */\r
203     public boolean hasEnd()\r
204     {\r
205         return this._has_end;\r
206     }\r
207 \r
208     //-- boolean hasEnd() \r
209 \r
210     /**\r
211      * Method hasId\r
212      *\r
213      *\r
214      *\r
215      * @return boolean\r
216      */\r
217     public boolean hasId()\r
218     {\r
219         return this._has_id;\r
220     }\r
221 \r
222     //-- boolean hasId() \r
223 \r
224     /**\r
225      * Method hasStart\r
226      *\r
227      *\r
228      *\r
229      * @return boolean\r
230      */\r
231     public boolean hasStart()\r
232     {\r
233         return this._has_start;\r
234     }\r
235 \r
236     //-- boolean hasStart() \r
237 \r
238     /**\r
239      * Method isValid\r
240      *\r
241      *\r
242      *\r
243      * @return boolean\r
244      */\r
245     public boolean isValid()\r
246     {\r
247         try\r
248         {\r
249             validate();\r
250         }\r
251         catch (org.exolab.castor.xml.ValidationException vex)\r
252         {\r
253             return false;\r
254         }\r
255 \r
256         return true;\r
257     }\r
258 \r
259     //-- boolean isValid() \r
260 \r
261     /**\r
262      * Method marshal\r
263      *\r
264      *\r
265      *\r
266      * @param out\r
267      */\r
268     public void marshal(java.io.Writer out)\r
269         throws org.exolab.castor.xml.MarshalException, \r
270             org.exolab.castor.xml.ValidationException\r
271     {\r
272         Marshaller.marshal(this, out);\r
273     }\r
274 \r
275     //-- void marshal(java.io.Writer) \r
276 \r
277     /**\r
278      * Method marshal\r
279      *\r
280      *\r
281      *\r
282      * @param handler\r
283      */\r
284     public void marshal(org.xml.sax.ContentHandler handler)\r
285         throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
286             org.exolab.castor.xml.ValidationException\r
287     {\r
288         Marshaller.marshal(this, handler);\r
289     }\r
290 \r
291     //-- void marshal(org.xml.sax.ContentHandler) \r
292 \r
293     /**\r
294      * Sets the value of field 'colour'.\r
295      *\r
296      * @param colour the value of field 'colour'.\r
297      */\r
298     public void setColour(int colour)\r
299     {\r
300         this._colour = colour;\r
301         this._has_colour = true;\r
302     }\r
303 \r
304     //-- void setColour(int) \r
305 \r
306     /**\r
307      * Sets the value of field 'end'.\r
308      *\r
309      * @param end the value of field 'end'.\r
310      */\r
311     public void setEnd(int end)\r
312     {\r
313         this._end = end;\r
314         this._has_end = true;\r
315     }\r
316 \r
317     //-- void setEnd(int) \r
318 \r
319     /**\r
320      * Sets the value of field 'id'.\r
321      *\r
322      * @param id the value of field 'id'.\r
323      */\r
324     public void setId(int id)\r
325     {\r
326         this._id = id;\r
327         this._has_id = true;\r
328     }\r
329 \r
330     //-- void setId(int) \r
331 \r
332     /**\r
333      * Sets the value of field 'start'.\r
334      *\r
335      * @param start the value of field 'start'.\r
336      */\r
337     public void setStart(int start)\r
338     {\r
339         this._start = start;\r
340         this._has_start = true;\r
341     }\r
342 \r
343     //-- void setStart(int) \r
344 \r
345     /**\r
346      * Method unmarshal\r
347      *\r
348      *\r
349      *\r
350      * @param reader\r
351      * @return Object\r
352      */\r
353     public static java.lang.Object unmarshal(java.io.Reader reader)\r
354         throws org.exolab.castor.xml.MarshalException, \r
355             org.exolab.castor.xml.ValidationException\r
356     {\r
357         return (jalview.binding.JSeq) Unmarshaller.unmarshal(jalview.binding.JSeq.class,\r
358             reader);\r
359     }\r
360 \r
361     //-- java.lang.Object unmarshal(java.io.Reader) \r
362 \r
363     /**\r
364      * Method validate\r
365      *\r
366      */\r
367     public void validate() throws org.exolab.castor.xml.ValidationException\r
368     {\r
369         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
370         validator.validate(this);\r
371     }\r
372 \r
373     //-- void validate() \r
374 }\r