added help and documentation for annotation editing.
[jalview.git] / src / jalview / binding / JalviewModel.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 import java.util.Date;\r
25 \r
26 \r
27 /**\r
28  * Class JalviewModel.\r
29  *\r
30  * @version $Revision$ $Date$\r
31  */\r
32 public class JalviewModel implements java.io.Serializable\r
33 {\r
34     //--------------------------/\r
35     //- Class/Member Variables -/\r
36     //--------------------------/\r
37 \r
38     /**\r
39      * Field _creationDate\r
40      */\r
41     private java.util.Date _creationDate;\r
42 \r
43     /**\r
44      * Field _version\r
45      */\r
46     private java.lang.String _version;\r
47 \r
48     /**\r
49      * Field _vamsasModel\r
50      */\r
51     private jalview.binding.VamsasModel _vamsasModel;\r
52 \r
53     /**\r
54      * Field _jalviewModelSequence\r
55      */\r
56     private jalview.binding.JalviewModelSequence _jalviewModelSequence;\r
57 \r
58     //----------------/\r
59     //- Constructors -/\r
60     //----------------/\r
61     public JalviewModel()\r
62     {\r
63         super();\r
64     }\r
65 \r
66     //-- jalview.binding.JalviewModel()\r
67     //-----------/\r
68 \r
69     /**\r
70      * DOCUMENT ME!\r
71      *\r
72      * @return DOCUMENT ME!\r
73      */\r
74     public java.util.Date getCreationDate()\r
75     {\r
76         return this._creationDate;\r
77     }\r
78 \r
79     //-- java.util.Date getCreationDate() \r
80 \r
81     /**\r
82      * Returns the value of field 'jalviewModelSequence'.\r
83      *\r
84      * @return JalviewModelSequence\r
85      * @return the value of field 'jalviewModelSequence'.\r
86      */\r
87     public jalview.binding.JalviewModelSequence getJalviewModelSequence()\r
88     {\r
89         return this._jalviewModelSequence;\r
90     }\r
91 \r
92     //-- jalview.binding.JalviewModelSequence getJalviewModelSequence() \r
93 \r
94     /**\r
95      * Returns the value of field 'vamsasModel'.\r
96      *\r
97      * @return VamsasModel\r
98      * @return the value of field 'vamsasModel'.\r
99      */\r
100     public jalview.binding.VamsasModel getVamsasModel()\r
101     {\r
102         return this._vamsasModel;\r
103     }\r
104 \r
105     //-- jalview.binding.VamsasModel getVamsasModel() \r
106 \r
107     /**\r
108      * Returns the value of field 'version'.\r
109      *\r
110      * @return String\r
111      * @return the value of field 'version'.\r
112      */\r
113     public java.lang.String getVersion()\r
114     {\r
115         return this._version;\r
116     }\r
117 \r
118     //-- java.lang.String getVersion() \r
119 \r
120     /**\r
121      * Method isValid\r
122      *\r
123      *\r
124      *\r
125      * @return boolean\r
126      */\r
127     public boolean isValid()\r
128     {\r
129         try\r
130         {\r
131             validate();\r
132         }\r
133         catch (org.exolab.castor.xml.ValidationException vex)\r
134         {\r
135             return false;\r
136         }\r
137 \r
138         return true;\r
139     }\r
140 \r
141     //-- boolean isValid() \r
142 \r
143     /**\r
144      * Method marshal\r
145      *\r
146      *\r
147      *\r
148      * @param out\r
149      */\r
150     public void marshal(java.io.Writer out)\r
151         throws org.exolab.castor.xml.MarshalException, \r
152             org.exolab.castor.xml.ValidationException\r
153     {\r
154         Marshaller.marshal(this, out);\r
155     }\r
156 \r
157     //-- void marshal(java.io.Writer) \r
158 \r
159     /**\r
160      * Method marshal\r
161      *\r
162      *\r
163      *\r
164      * @param handler\r
165      */\r
166     public void marshal(org.xml.sax.ContentHandler handler)\r
167         throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
168             org.exolab.castor.xml.ValidationException\r
169     {\r
170         Marshaller.marshal(this, handler);\r
171     }\r
172 \r
173     //-- void marshal(org.xml.sax.ContentHandler) \r
174 \r
175     /**\r
176      * Sets the value of field 'creationDate'.\r
177      *\r
178      * @param creationDate the value of field 'creationDate'.\r
179      */\r
180     public void setCreationDate(java.util.Date creationDate)\r
181     {\r
182         this._creationDate = creationDate;\r
183     }\r
184 \r
185     //-- void setCreationDate(java.util.Date) \r
186 \r
187     /**\r
188      * Sets the value of field 'jalviewModelSequence'.\r
189      *\r
190      * @param jalviewModelSequence the value of field\r
191      * 'jalviewModelSequence'.\r
192      */\r
193     public void setJalviewModelSequence(\r
194         jalview.binding.JalviewModelSequence jalviewModelSequence)\r
195     {\r
196         this._jalviewModelSequence = jalviewModelSequence;\r
197     }\r
198 \r
199     //-- void setJalviewModelSequence(jalview.binding.JalviewModelSequence) \r
200 \r
201     /**\r
202      * Sets the value of field 'vamsasModel'.\r
203      *\r
204      * @param vamsasModel the value of field 'vamsasModel'.\r
205      */\r
206     public void setVamsasModel(jalview.binding.VamsasModel vamsasModel)\r
207     {\r
208         this._vamsasModel = vamsasModel;\r
209     }\r
210 \r
211     //-- void setVamsasModel(jalview.binding.VamsasModel) \r
212 \r
213     /**\r
214      * Sets the value of field 'version'.\r
215      *\r
216      * @param version the value of field 'version'.\r
217      */\r
218     public void setVersion(java.lang.String version)\r
219     {\r
220         this._version = version;\r
221     }\r
222 \r
223     //-- void setVersion(java.lang.String) \r
224 \r
225     /**\r
226      * Method unmarshal\r
227      *\r
228      *\r
229      *\r
230      * @param reader\r
231      * @return Object\r
232      */\r
233     public static java.lang.Object unmarshal(java.io.Reader reader)\r
234         throws org.exolab.castor.xml.MarshalException, \r
235             org.exolab.castor.xml.ValidationException\r
236     {\r
237         return (jalview.binding.JalviewModel) Unmarshaller.unmarshal(jalview.binding.JalviewModel.class,\r
238             reader);\r
239     }\r
240 \r
241     //-- java.lang.Object unmarshal(java.io.Reader) \r
242 \r
243     /**\r
244      * Method validate\r
245      *\r
246      */\r
247     public void validate() throws org.exolab.castor.xml.ValidationException\r
248     {\r
249         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
250         validator.validate(this);\r
251     }\r
252 \r
253     //-- void validate() \r
254 }\r