update author list in license for (JAL-826)
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / JSeqDescriptor.java
1 /*******************************************************************************
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
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 of the License, or (at your option) any later version.
10  *
11  * Jalview is distributed in the hope that it will be useful, but 
12  * WITHOUT ANY WARRANTY; without even the implied warranty 
13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
14  * PURPOSE.  See the GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
17  *******************************************************************************/
18 /*
19  * This class was automatically generated with 
20  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
21  * Schema.
22  * $Id$
23  */
24
25 package jalview.schemabinding.version2.descriptors;
26
27   //---------------------------------/
28  //- Imported classes and packages -/
29 //---------------------------------/
30
31 import jalview.schemabinding.version2.JSeq;
32
33 /**
34  * Class JSeqDescriptor.
35  * 
36  * @version $Revision$ $Date$
37  */
38 public class JSeqDescriptor extends org.exolab.castor.xml.util.XMLClassDescriptorImpl {
39
40
41       //--------------------------/
42      //- Class/Member Variables -/
43     //--------------------------/
44
45     /**
46      * Field _elementDefinition.
47      */
48     private boolean _elementDefinition;
49
50     /**
51      * Field _nsPrefix.
52      */
53     private java.lang.String _nsPrefix;
54
55     /**
56      * Field _nsURI.
57      */
58     private java.lang.String _nsURI;
59
60     /**
61      * Field _xmlName.
62      */
63     private java.lang.String _xmlName;
64
65
66       //----------------/
67      //- Constructors -/
68     //----------------/
69
70     public JSeqDescriptor() {
71         super();
72         _nsURI = "www.jalview.org";
73         _xmlName = "JSeq";
74         _elementDefinition = true;
75         
76         //-- set grouping compositor
77         setCompositorAsSequence();
78         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;
79         org.exolab.castor.mapping.FieldHandler             handler        = null;
80         org.exolab.castor.xml.FieldValidator               fieldValidator = null;
81         //-- initialize attribute descriptors
82         
83         //-- _colour
84         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Integer.TYPE, "_colour", "colour", org.exolab.castor.xml.NodeType.Attribute);
85         handler = new org.exolab.castor.xml.XMLFieldHandler() {
86             public java.lang.Object getValue( java.lang.Object object ) 
87                 throws IllegalStateException
88             {
89                 JSeq target = (JSeq) object;
90                 if (!target.hasColour()) { return null; }
91                 return new java.lang.Integer(target.getColour());
92             }
93             public void setValue( java.lang.Object object, java.lang.Object value) 
94                 throws IllegalStateException, IllegalArgumentException
95             {
96                 try {
97                     JSeq target = (JSeq) object;
98                     // if null, use delete method for optional primitives 
99                     if (value == null) {
100                         target.deleteColour();
101                         return;
102                     }
103                     target.setColour( ((java.lang.Integer) value).intValue());
104                 } catch (java.lang.Exception ex) {
105                     throw new IllegalStateException(ex.toString());
106                 }
107             }
108             public java.lang.Object newInstance(java.lang.Object parent) {
109                 return null;
110             }
111         };
112         desc.setHandler(handler);
113         desc.setMultivalued(false);
114         addFieldDescriptor(desc);
115         
116         //-- validation code for: _colour
117         fieldValidator = new org.exolab.castor.xml.FieldValidator();
118         { //-- local scope
119             org.exolab.castor.xml.validators.IntValidator typeValidator;
120             typeValidator = new org.exolab.castor.xml.validators.IntValidator();
121             fieldValidator.setValidator(typeValidator);
122             typeValidator.setMinInclusive(-2147483648);
123             typeValidator.setMaxInclusive(2147483647);
124         }
125         desc.setValidator(fieldValidator);
126         //-- _start
127         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Integer.TYPE, "_start", "start", org.exolab.castor.xml.NodeType.Attribute);
128         handler = new org.exolab.castor.xml.XMLFieldHandler() {
129             public java.lang.Object getValue( java.lang.Object object ) 
130                 throws IllegalStateException
131             {
132                 JSeq target = (JSeq) object;
133                 if (!target.hasStart()) { return null; }
134                 return new java.lang.Integer(target.getStart());
135             }
136             public void setValue( java.lang.Object object, java.lang.Object value) 
137                 throws IllegalStateException, IllegalArgumentException
138             {
139                 try {
140                     JSeq target = (JSeq) object;
141                     // ignore null values for non optional primitives
142                     if (value == null) { return; }
143                     
144                     target.setStart( ((java.lang.Integer) value).intValue());
145                 } catch (java.lang.Exception ex) {
146                     throw new IllegalStateException(ex.toString());
147                 }
148             }
149             public java.lang.Object newInstance(java.lang.Object parent) {
150                 return null;
151             }
152         };
153         desc.setHandler(handler);
154         desc.setRequired(true);
155         desc.setMultivalued(false);
156         addFieldDescriptor(desc);
157         
158         //-- validation code for: _start
159         fieldValidator = new org.exolab.castor.xml.FieldValidator();
160         fieldValidator.setMinOccurs(1);
161         { //-- local scope
162             org.exolab.castor.xml.validators.IntValidator typeValidator;
163             typeValidator = new org.exolab.castor.xml.validators.IntValidator();
164             fieldValidator.setValidator(typeValidator);
165             typeValidator.setMinInclusive(-2147483648);
166             typeValidator.setMaxInclusive(2147483647);
167         }
168         desc.setValidator(fieldValidator);
169         //-- _end
170         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Integer.TYPE, "_end", "end", org.exolab.castor.xml.NodeType.Attribute);
171         handler = new org.exolab.castor.xml.XMLFieldHandler() {
172             public java.lang.Object getValue( java.lang.Object object ) 
173                 throws IllegalStateException
174             {
175                 JSeq target = (JSeq) object;
176                 if (!target.hasEnd()) { return null; }
177                 return new java.lang.Integer(target.getEnd());
178             }
179             public void setValue( java.lang.Object object, java.lang.Object value) 
180                 throws IllegalStateException, IllegalArgumentException
181             {
182                 try {
183                     JSeq target = (JSeq) object;
184                     // ignore null values for non optional primitives
185                     if (value == null) { return; }
186                     
187                     target.setEnd( ((java.lang.Integer) value).intValue());
188                 } catch (java.lang.Exception ex) {
189                     throw new IllegalStateException(ex.toString());
190                 }
191             }
192             public java.lang.Object newInstance(java.lang.Object parent) {
193                 return null;
194             }
195         };
196         desc.setHandler(handler);
197         desc.setRequired(true);
198         desc.setMultivalued(false);
199         addFieldDescriptor(desc);
200         
201         //-- validation code for: _end
202         fieldValidator = new org.exolab.castor.xml.FieldValidator();
203         fieldValidator.setMinOccurs(1);
204         { //-- local scope
205             org.exolab.castor.xml.validators.IntValidator typeValidator;
206             typeValidator = new org.exolab.castor.xml.validators.IntValidator();
207             fieldValidator.setValidator(typeValidator);
208             typeValidator.setMinInclusive(-2147483648);
209             typeValidator.setMaxInclusive(2147483647);
210         }
211         desc.setValidator(fieldValidator);
212         //-- _id
213         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_id", "id", org.exolab.castor.xml.NodeType.Attribute);
214         desc.setImmutable(true);
215         handler = new org.exolab.castor.xml.XMLFieldHandler() {
216             public java.lang.Object getValue( java.lang.Object object ) 
217                 throws IllegalStateException
218             {
219                 JSeq target = (JSeq) object;
220                 return target.getId();
221             }
222             public void setValue( java.lang.Object object, java.lang.Object value) 
223                 throws IllegalStateException, IllegalArgumentException
224             {
225                 try {
226                     JSeq target = (JSeq) object;
227                     target.setId( (java.lang.String) value);
228                 } catch (java.lang.Exception ex) {
229                     throw new IllegalStateException(ex.toString());
230                 }
231             }
232             public java.lang.Object newInstance(java.lang.Object parent) {
233                 return null;
234             }
235         };
236         desc.setHandler(handler);
237         desc.setRequired(true);
238         desc.setMultivalued(false);
239         addFieldDescriptor(desc);
240         
241         //-- validation code for: _id
242         fieldValidator = new org.exolab.castor.xml.FieldValidator();
243         fieldValidator.setMinOccurs(1);
244         { //-- local scope
245             org.exolab.castor.xml.validators.StringValidator typeValidator;
246             typeValidator = new org.exolab.castor.xml.validators.StringValidator();
247             fieldValidator.setValidator(typeValidator);
248             typeValidator.setWhiteSpace("preserve");
249         }
250         desc.setValidator(fieldValidator);
251         //-- _hidden
252         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Boolean.TYPE, "_hidden", "hidden", org.exolab.castor.xml.NodeType.Attribute);
253         handler = new org.exolab.castor.xml.XMLFieldHandler() {
254             public java.lang.Object getValue( java.lang.Object object ) 
255                 throws IllegalStateException
256             {
257                 JSeq target = (JSeq) object;
258                 if (!target.hasHidden()) { return null; }
259                 return (target.getHidden() ? java.lang.Boolean.TRUE : java.lang.Boolean.FALSE);
260             }
261             public void setValue( java.lang.Object object, java.lang.Object value) 
262                 throws IllegalStateException, IllegalArgumentException
263             {
264                 try {
265                     JSeq target = (JSeq) object;
266                     // if null, use delete method for optional primitives 
267                     if (value == null) {
268                         target.deleteHidden();
269                         return;
270                     }
271                     target.setHidden( ((java.lang.Boolean) value).booleanValue());
272                 } catch (java.lang.Exception ex) {
273                     throw new IllegalStateException(ex.toString());
274                 }
275             }
276             public java.lang.Object newInstance(java.lang.Object parent) {
277                 return null;
278             }
279         };
280         desc.setHandler(handler);
281         desc.setMultivalued(false);
282         addFieldDescriptor(desc);
283         
284         //-- validation code for: _hidden
285         fieldValidator = new org.exolab.castor.xml.FieldValidator();
286         { //-- local scope
287             org.exolab.castor.xml.validators.BooleanValidator typeValidator;
288             typeValidator = new org.exolab.castor.xml.validators.BooleanValidator();
289             fieldValidator.setValidator(typeValidator);
290         }
291         desc.setValidator(fieldValidator);
292         //-- initialize element descriptors
293         
294         //-- _featuresList
295         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(jalview.schemabinding.version2.Features.class, "_featuresList", "features", org.exolab.castor.xml.NodeType.Element);
296         handler = new org.exolab.castor.xml.XMLFieldHandler() {
297             public java.lang.Object getValue( java.lang.Object object ) 
298                 throws IllegalStateException
299             {
300                 JSeq target = (JSeq) object;
301                 return target.getFeatures();
302             }
303             public void setValue( java.lang.Object object, java.lang.Object value) 
304                 throws IllegalStateException, IllegalArgumentException
305             {
306                 try {
307                     JSeq target = (JSeq) object;
308                     target.addFeatures( (jalview.schemabinding.version2.Features) value);
309                 } catch (java.lang.Exception ex) {
310                     throw new IllegalStateException(ex.toString());
311                 }
312             }
313             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {
314                 try {
315                     JSeq target = (JSeq) object;
316                     target.removeAllFeatures();
317                 } catch (java.lang.Exception ex) {
318                     throw new IllegalStateException(ex.toString());
319                 }
320             }
321             public java.lang.Object newInstance(java.lang.Object parent) {
322                 return new jalview.schemabinding.version2.Features();
323             }
324         };
325         desc.setHandler(handler);
326         desc.setNameSpaceURI("www.jalview.org");
327         desc.setMultivalued(true);
328         addFieldDescriptor(desc);
329         
330         //-- validation code for: _featuresList
331         fieldValidator = new org.exolab.castor.xml.FieldValidator();
332         fieldValidator.setMinOccurs(0);
333         { //-- local scope
334         }
335         desc.setValidator(fieldValidator);
336         //-- _pdbidsList
337         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(jalview.schemabinding.version2.Pdbids.class, "_pdbidsList", "pdbids", org.exolab.castor.xml.NodeType.Element);
338         handler = new org.exolab.castor.xml.XMLFieldHandler() {
339             public java.lang.Object getValue( java.lang.Object object ) 
340                 throws IllegalStateException
341             {
342                 JSeq target = (JSeq) object;
343                 return target.getPdbids();
344             }
345             public void setValue( java.lang.Object object, java.lang.Object value) 
346                 throws IllegalStateException, IllegalArgumentException
347             {
348                 try {
349                     JSeq target = (JSeq) object;
350                     target.addPdbids( (jalview.schemabinding.version2.Pdbids) value);
351                 } catch (java.lang.Exception ex) {
352                     throw new IllegalStateException(ex.toString());
353                 }
354             }
355             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {
356                 try {
357                     JSeq target = (JSeq) object;
358                     target.removeAllPdbids();
359                 } catch (java.lang.Exception ex) {
360                     throw new IllegalStateException(ex.toString());
361                 }
362             }
363             public java.lang.Object newInstance(java.lang.Object parent) {
364                 return new jalview.schemabinding.version2.Pdbids();
365             }
366         };
367         desc.setHandler(handler);
368         desc.setNameSpaceURI("www.jalview.org");
369         desc.setMultivalued(true);
370         addFieldDescriptor(desc);
371         
372         //-- validation code for: _pdbidsList
373         fieldValidator = new org.exolab.castor.xml.FieldValidator();
374         fieldValidator.setMinOccurs(0);
375         { //-- local scope
376         }
377         desc.setValidator(fieldValidator);
378         //-- _hiddenSequencesList
379         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Integer.TYPE, "_hiddenSequencesList", "hiddenSequences", org.exolab.castor.xml.NodeType.Element);
380         handler = new org.exolab.castor.xml.XMLFieldHandler() {
381             public java.lang.Object getValue( java.lang.Object object ) 
382                 throws IllegalStateException
383             {
384                 JSeq target = (JSeq) object;
385                 return target.getHiddenSequences();
386             }
387             public void setValue( java.lang.Object object, java.lang.Object value) 
388                 throws IllegalStateException, IllegalArgumentException
389             {
390                 try {
391                     JSeq target = (JSeq) object;
392                     // ignore null values for non optional primitives
393                     if (value == null) { return; }
394                     
395                     target.addHiddenSequences( ((java.lang.Integer) value).intValue());
396                 } catch (java.lang.Exception ex) {
397                     throw new IllegalStateException(ex.toString());
398                 }
399             }
400             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {
401                 try {
402                     JSeq target = (JSeq) object;
403                     target.removeAllHiddenSequences();
404                 } catch (java.lang.Exception ex) {
405                     throw new IllegalStateException(ex.toString());
406                 }
407             }
408             public java.lang.Object newInstance(java.lang.Object parent) {
409                 return null;
410             }
411         };
412         desc.setHandler(handler);
413         desc.setNameSpaceURI("www.jalview.org");
414         desc.setMultivalued(true);
415         addFieldDescriptor(desc);
416         
417         //-- validation code for: _hiddenSequencesList
418         fieldValidator = new org.exolab.castor.xml.FieldValidator();
419         fieldValidator.setMinOccurs(0);
420         { //-- local scope
421             org.exolab.castor.xml.validators.IntValidator typeValidator;
422             typeValidator = new org.exolab.castor.xml.validators.IntValidator();
423             fieldValidator.setValidator(typeValidator);
424             typeValidator.setMinInclusive(-2147483648);
425             typeValidator.setMaxInclusive(2147483647);
426         }
427         desc.setValidator(fieldValidator);
428     }
429
430
431       //-----------/
432      //- Methods -/
433     //-----------/
434
435     /**
436      * Method getAccessMode.
437      * 
438      * @return the access mode specified for this class.
439      */
440     public org.exolab.castor.mapping.AccessMode getAccessMode(
441     ) {
442         return null;
443     }
444
445     /**
446      * Method getIdentity.
447      * 
448      * @return the identity field, null if this class has no
449      * identity.
450      */
451     public org.exolab.castor.mapping.FieldDescriptor getIdentity(
452     ) {
453         return super.getIdentity();
454     }
455
456     /**
457      * Method getJavaClass.
458      * 
459      * @return the Java class represented by this descriptor.
460      */
461     public java.lang.Class getJavaClass(
462     ) {
463         return jalview.schemabinding.version2.JSeq.class;
464     }
465
466     /**
467      * Method getNameSpacePrefix.
468      * 
469      * @return the namespace prefix to use when marshaling as XML.
470      */
471     public java.lang.String getNameSpacePrefix(
472     ) {
473         return _nsPrefix;
474     }
475
476     /**
477      * Method getNameSpaceURI.
478      * 
479      * @return the namespace URI used when marshaling and
480      * unmarshaling as XML.
481      */
482     public java.lang.String getNameSpaceURI(
483     ) {
484         return _nsURI;
485     }
486
487     /**
488      * Method getValidator.
489      * 
490      * @return a specific validator for the class described by this
491      * ClassDescriptor.
492      */
493     public org.exolab.castor.xml.TypeValidator getValidator(
494     ) {
495         return this;
496     }
497
498     /**
499      * Method getXMLName.
500      * 
501      * @return the XML Name for the Class being described.
502      */
503     public java.lang.String getXMLName(
504     ) {
505         return _xmlName;
506     }
507
508     /**
509      * Method isElementDefinition.
510      * 
511      * @return true if XML schema definition of this Class is that
512      * of a global
513      * element or element with anonymous type definition.
514      */
515     public boolean isElementDefinition(
516     ) {
517         return _elementDefinition;
518     }
519
520 }