JAL-1620 version bump and release notes
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / SequenceTypeDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
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.descriptors;
22
23 //---------------------------------/
24 //- Imported classes and packages -/
25 //---------------------------------/
26
27 import jalview.schemabinding.version2.SequenceType;
28
29 /**
30  * Class SequenceTypeDescriptor.
31  * 
32  * @version $Revision$ $Date$
33  */
34 public class SequenceTypeDescriptor extends
35         org.exolab.castor.xml.util.XMLClassDescriptorImpl
36 {
37
38   // --------------------------/
39   // - Class/Member Variables -/
40   // --------------------------/
41
42   /**
43    * Field _elementDefinition.
44    */
45   private boolean _elementDefinition;
46
47   /**
48    * Field _nsPrefix.
49    */
50   private java.lang.String _nsPrefix;
51
52   /**
53    * Field _nsURI.
54    */
55   private java.lang.String _nsURI;
56
57   /**
58    * Field _xmlName.
59    */
60   private java.lang.String _xmlName;
61
62   // ----------------/
63   // - Constructors -/
64   // ----------------/
65
66   public SequenceTypeDescriptor()
67   {
68     super();
69     _nsURI = "www.vamsas.ac.uk/jalview/version2";
70     _xmlName = "SequenceType";
71     _elementDefinition = false;
72
73     // -- set grouping compositor
74     setCompositorAsSequence();
75     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
76     org.exolab.castor.mapping.FieldHandler handler = null;
77     org.exolab.castor.xml.FieldValidator fieldValidator = null;
78     // -- initialize attribute descriptors
79
80     // -- _id
81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
82             java.lang.String.class, "_id", "id",
83             org.exolab.castor.xml.NodeType.Attribute);
84     desc.setImmutable(true);
85     handler = new org.exolab.castor.xml.XMLFieldHandler()
86     {
87       public java.lang.Object getValue(java.lang.Object object)
88               throws IllegalStateException
89       {
90         SequenceType target = (SequenceType) object;
91         return target.getId();
92       }
93
94       public void setValue(java.lang.Object object, java.lang.Object value)
95               throws IllegalStateException, IllegalArgumentException
96       {
97         try
98         {
99           SequenceType target = (SequenceType) object;
100           target.setId((java.lang.String) value);
101         } catch (java.lang.Exception ex)
102         {
103           throw new IllegalStateException(ex.toString());
104         }
105       }
106
107       public java.lang.Object newInstance(java.lang.Object parent)
108       {
109         return null;
110       }
111     };
112     desc.setHandler(handler);
113     desc.setMultivalued(false);
114     addFieldDescriptor(desc);
115
116     // -- validation code for: _id
117     fieldValidator = new org.exolab.castor.xml.FieldValidator();
118     { // -- local scope
119       org.exolab.castor.xml.validators.StringValidator typeValidator;
120       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
121       fieldValidator.setValidator(typeValidator);
122       typeValidator.setWhiteSpace("preserve");
123     }
124     desc.setValidator(fieldValidator);
125     // -- _description
126     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
127             java.lang.String.class, "_description", "description",
128             org.exolab.castor.xml.NodeType.Attribute);
129     desc.setImmutable(true);
130     handler = new org.exolab.castor.xml.XMLFieldHandler()
131     {
132       public java.lang.Object getValue(java.lang.Object object)
133               throws IllegalStateException
134       {
135         SequenceType target = (SequenceType) object;
136         return target.getDescription();
137       }
138
139       public void setValue(java.lang.Object object, java.lang.Object value)
140               throws IllegalStateException, IllegalArgumentException
141       {
142         try
143         {
144           SequenceType target = (SequenceType) object;
145           target.setDescription((java.lang.String) value);
146         } catch (java.lang.Exception ex)
147         {
148           throw new IllegalStateException(ex.toString());
149         }
150       }
151
152       public java.lang.Object newInstance(java.lang.Object parent)
153       {
154         return null;
155       }
156     };
157     desc.setHandler(handler);
158     desc.setMultivalued(false);
159     addFieldDescriptor(desc);
160
161     // -- validation code for: _description
162     fieldValidator = new org.exolab.castor.xml.FieldValidator();
163     { // -- local scope
164       org.exolab.castor.xml.validators.StringValidator typeValidator;
165       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
166       fieldValidator.setValidator(typeValidator);
167       typeValidator.setWhiteSpace("preserve");
168     }
169     desc.setValidator(fieldValidator);
170     // -- initialize element descriptors
171
172     // -- _sequence
173     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
174             java.lang.String.class, "_sequence", "sequence",
175             org.exolab.castor.xml.NodeType.Element);
176     desc.setImmutable(true);
177     handler = new org.exolab.castor.xml.XMLFieldHandler()
178     {
179       public java.lang.Object getValue(java.lang.Object object)
180               throws IllegalStateException
181       {
182         SequenceType target = (SequenceType) object;
183         return target.getSequence();
184       }
185
186       public void setValue(java.lang.Object object, java.lang.Object value)
187               throws IllegalStateException, IllegalArgumentException
188       {
189         try
190         {
191           SequenceType target = (SequenceType) object;
192           target.setSequence((java.lang.String) value);
193         } catch (java.lang.Exception ex)
194         {
195           throw new IllegalStateException(ex.toString());
196         }
197       }
198
199       public java.lang.Object newInstance(java.lang.Object parent)
200       {
201         return null;
202       }
203     };
204     desc.setHandler(handler);
205     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
206     desc.setMultivalued(false);
207     addFieldDescriptor(desc);
208
209     // -- validation code for: _sequence
210     fieldValidator = new org.exolab.castor.xml.FieldValidator();
211     { // -- local scope
212       org.exolab.castor.xml.validators.StringValidator typeValidator;
213       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
214       fieldValidator.setValidator(typeValidator);
215       typeValidator.setWhiteSpace("preserve");
216     }
217     desc.setValidator(fieldValidator);
218     // -- _name
219     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
220             java.lang.String.class, "_name", "name",
221             org.exolab.castor.xml.NodeType.Element);
222     desc.setImmutable(true);
223     handler = new org.exolab.castor.xml.XMLFieldHandler()
224     {
225       public java.lang.Object getValue(java.lang.Object object)
226               throws IllegalStateException
227       {
228         SequenceType target = (SequenceType) object;
229         return target.getName();
230       }
231
232       public void setValue(java.lang.Object object, java.lang.Object value)
233               throws IllegalStateException, IllegalArgumentException
234       {
235         try
236         {
237           SequenceType target = (SequenceType) object;
238           target.setName((java.lang.String) value);
239         } catch (java.lang.Exception ex)
240         {
241           throw new IllegalStateException(ex.toString());
242         }
243       }
244
245       public java.lang.Object newInstance(java.lang.Object parent)
246       {
247         return null;
248       }
249     };
250     desc.setHandler(handler);
251     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
252     desc.setMultivalued(false);
253     addFieldDescriptor(desc);
254
255     // -- validation code for: _name
256     fieldValidator = new org.exolab.castor.xml.FieldValidator();
257     { // -- local scope
258       org.exolab.castor.xml.validators.StringValidator typeValidator;
259       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
260       fieldValidator.setValidator(typeValidator);
261       typeValidator.setWhiteSpace("preserve");
262     }
263     desc.setValidator(fieldValidator);
264   }
265
266   // -----------/
267   // - Methods -/
268   // -----------/
269
270   /**
271    * Method getAccessMode.
272    * 
273    * @return the access mode specified for this class.
274    */
275   public org.exolab.castor.mapping.AccessMode getAccessMode()
276   {
277     return null;
278   }
279
280   /**
281    * Method getIdentity.
282    * 
283    * @return the identity field, null if this class has no identity.
284    */
285   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
286   {
287     return super.getIdentity();
288   }
289
290   /**
291    * Method getJavaClass.
292    * 
293    * @return the Java class represented by this descriptor.
294    */
295   public java.lang.Class getJavaClass()
296   {
297     return jalview.schemabinding.version2.SequenceType.class;
298   }
299
300   /**
301    * Method getNameSpacePrefix.
302    * 
303    * @return the namespace prefix to use when marshaling as XML.
304    */
305   public java.lang.String getNameSpacePrefix()
306   {
307     return _nsPrefix;
308   }
309
310   /**
311    * Method getNameSpaceURI.
312    * 
313    * @return the namespace URI used when marshaling and unmarshaling as XML.
314    */
315   public java.lang.String getNameSpaceURI()
316   {
317     return _nsURI;
318   }
319
320   /**
321    * Method getValidator.
322    * 
323    * @return a specific validator for the class described by this
324    *         ClassDescriptor.
325    */
326   public org.exolab.castor.xml.TypeValidator getValidator()
327   {
328     return this;
329   }
330
331   /**
332    * Method getXMLName.
333    * 
334    * @return the XML Name for the Class being described.
335    */
336   public java.lang.String getXMLName()
337   {
338     return _xmlName;
339   }
340
341   /**
342    * Method isElementDefinition.
343    * 
344    * @return true if XML schema definition of this Class is that of a global
345    *         element or element with anonymous type definition.
346    */
347   public boolean isElementDefinition()
348   {
349     return _elementDefinition;
350   }
351
352 }