JAL-1432 updated copyright notices
[jalview.git] / src / jalview / schemabinding / version2 / descriptors / JalviewModelSequenceDescriptor.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
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 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  * The Jalview Authors are detailed in the 'AUTHORS' file.
18  */
19 package jalview.schemabinding.version2.descriptors;
20
21 //---------------------------------/
22 //- Imported classes and packages -/
23 //---------------------------------/
24
25 import jalview.schemabinding.version2.JalviewModelSequence;
26
27 /**
28  * Class JalviewModelSequenceDescriptor.
29  * 
30  * @version $Revision$ $Date$
31  */
32 public class JalviewModelSequenceDescriptor extends
33         org.exolab.castor.xml.util.XMLClassDescriptorImpl
34 {
35
36   // --------------------------/
37   // - Class/Member Variables -/
38   // --------------------------/
39
40   /**
41    * Field _elementDefinition.
42    */
43   private boolean _elementDefinition;
44
45   /**
46    * Field _nsPrefix.
47    */
48   private java.lang.String _nsPrefix;
49
50   /**
51    * Field _nsURI.
52    */
53   private java.lang.String _nsURI;
54
55   /**
56    * Field _xmlName.
57    */
58   private java.lang.String _xmlName;
59
60   // ----------------/
61   // - Constructors -/
62   // ----------------/
63
64   public JalviewModelSequenceDescriptor()
65   {
66     super();
67     _nsURI = "www.jalview.org";
68     _elementDefinition = false;
69
70     // -- set grouping compositor
71     setCompositorAsSequence();
72     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
73     org.exolab.castor.mapping.FieldHandler handler = null;
74     org.exolab.castor.xml.FieldValidator fieldValidator = null;
75     // -- initialize attribute descriptors
76
77     // -- initialize element descriptors
78
79     // -- _JSeqList
80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
81             jalview.schemabinding.version2.JSeq.class, "_JSeqList", "JSeq",
82             org.exolab.castor.xml.NodeType.Element);
83     handler = new org.exolab.castor.xml.XMLFieldHandler()
84     {
85       public java.lang.Object getValue(java.lang.Object object)
86               throws IllegalStateException
87       {
88         JalviewModelSequence target = (JalviewModelSequence) object;
89         return target.getJSeq();
90       }
91
92       public void setValue(java.lang.Object object, java.lang.Object value)
93               throws IllegalStateException, IllegalArgumentException
94       {
95         try
96         {
97           JalviewModelSequence target = (JalviewModelSequence) object;
98           target.addJSeq((jalview.schemabinding.version2.JSeq) value);
99         } catch (java.lang.Exception ex)
100         {
101           throw new IllegalStateException(ex.toString());
102         }
103       }
104
105       public void resetValue(Object object) throws IllegalStateException,
106               IllegalArgumentException
107       {
108         try
109         {
110           JalviewModelSequence target = (JalviewModelSequence) object;
111           target.removeAllJSeq();
112         } catch (java.lang.Exception ex)
113         {
114           throw new IllegalStateException(ex.toString());
115         }
116       }
117
118       public java.lang.Object newInstance(java.lang.Object parent)
119       {
120         return new jalview.schemabinding.version2.JSeq();
121       }
122     };
123     desc.setHandler(handler);
124     desc.setNameSpaceURI("www.jalview.org");
125     desc.setRequired(true);
126     desc.setMultivalued(true);
127     addFieldDescriptor(desc);
128
129     // -- validation code for: _JSeqList
130     fieldValidator = new org.exolab.castor.xml.FieldValidator();
131     fieldValidator.setMinOccurs(1);
132     { // -- local scope
133     }
134     desc.setValidator(fieldValidator);
135     // -- _JGroupList
136     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
137             jalview.schemabinding.version2.JGroup.class, "_JGroupList",
138             "JGroup", org.exolab.castor.xml.NodeType.Element);
139     handler = new org.exolab.castor.xml.XMLFieldHandler()
140     {
141       public java.lang.Object getValue(java.lang.Object object)
142               throws IllegalStateException
143       {
144         JalviewModelSequence target = (JalviewModelSequence) object;
145         return target.getJGroup();
146       }
147
148       public void setValue(java.lang.Object object, java.lang.Object value)
149               throws IllegalStateException, IllegalArgumentException
150       {
151         try
152         {
153           JalviewModelSequence target = (JalviewModelSequence) object;
154           target.addJGroup((jalview.schemabinding.version2.JGroup) value);
155         } catch (java.lang.Exception ex)
156         {
157           throw new IllegalStateException(ex.toString());
158         }
159       }
160
161       public void resetValue(Object object) throws IllegalStateException,
162               IllegalArgumentException
163       {
164         try
165         {
166           JalviewModelSequence target = (JalviewModelSequence) object;
167           target.removeAllJGroup();
168         } catch (java.lang.Exception ex)
169         {
170           throw new IllegalStateException(ex.toString());
171         }
172       }
173
174       public java.lang.Object newInstance(java.lang.Object parent)
175       {
176         return new jalview.schemabinding.version2.JGroup();
177       }
178     };
179     desc.setHandler(handler);
180     desc.setNameSpaceURI("www.jalview.org");
181     desc.setMultivalued(true);
182     addFieldDescriptor(desc);
183
184     // -- validation code for: _JGroupList
185     fieldValidator = new org.exolab.castor.xml.FieldValidator();
186     fieldValidator.setMinOccurs(0);
187     { // -- local scope
188     }
189     desc.setValidator(fieldValidator);
190     // -- _viewportList
191     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
192             jalview.schemabinding.version2.Viewport.class, "_viewportList",
193             "Viewport", org.exolab.castor.xml.NodeType.Element);
194     handler = new org.exolab.castor.xml.XMLFieldHandler()
195     {
196       public java.lang.Object getValue(java.lang.Object object)
197               throws IllegalStateException
198       {
199         JalviewModelSequence target = (JalviewModelSequence) object;
200         return target.getViewport();
201       }
202
203       public void setValue(java.lang.Object object, java.lang.Object value)
204               throws IllegalStateException, IllegalArgumentException
205       {
206         try
207         {
208           JalviewModelSequence target = (JalviewModelSequence) object;
209           target.addViewport((jalview.schemabinding.version2.Viewport) value);
210         } catch (java.lang.Exception ex)
211         {
212           throw new IllegalStateException(ex.toString());
213         }
214       }
215
216       public void resetValue(Object object) throws IllegalStateException,
217               IllegalArgumentException
218       {
219         try
220         {
221           JalviewModelSequence target = (JalviewModelSequence) object;
222           target.removeAllViewport();
223         } catch (java.lang.Exception ex)
224         {
225           throw new IllegalStateException(ex.toString());
226         }
227       }
228
229       public java.lang.Object newInstance(java.lang.Object parent)
230       {
231         return new jalview.schemabinding.version2.Viewport();
232       }
233     };
234     desc.setHandler(handler);
235     desc.setNameSpaceURI("www.jalview.org");
236     desc.setRequired(true);
237     desc.setMultivalued(true);
238     addFieldDescriptor(desc);
239
240     // -- validation code for: _viewportList
241     fieldValidator = new org.exolab.castor.xml.FieldValidator();
242     fieldValidator.setMinOccurs(1);
243     { // -- local scope
244     }
245     desc.setValidator(fieldValidator);
246     // -- _userColoursList
247     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
248             jalview.schemabinding.version2.UserColours.class,
249             "_userColoursList", "UserColours",
250             org.exolab.castor.xml.NodeType.Element);
251     handler = new org.exolab.castor.xml.XMLFieldHandler()
252     {
253       public java.lang.Object getValue(java.lang.Object object)
254               throws IllegalStateException
255       {
256         JalviewModelSequence target = (JalviewModelSequence) object;
257         return target.getUserColours();
258       }
259
260       public void setValue(java.lang.Object object, java.lang.Object value)
261               throws IllegalStateException, IllegalArgumentException
262       {
263         try
264         {
265           JalviewModelSequence target = (JalviewModelSequence) object;
266           target.addUserColours((jalview.schemabinding.version2.UserColours) value);
267         } catch (java.lang.Exception ex)
268         {
269           throw new IllegalStateException(ex.toString());
270         }
271       }
272
273       public void resetValue(Object object) throws IllegalStateException,
274               IllegalArgumentException
275       {
276         try
277         {
278           JalviewModelSequence target = (JalviewModelSequence) object;
279           target.removeAllUserColours();
280         } catch (java.lang.Exception ex)
281         {
282           throw new IllegalStateException(ex.toString());
283         }
284       }
285
286       public java.lang.Object newInstance(java.lang.Object parent)
287       {
288         return new jalview.schemabinding.version2.UserColours();
289       }
290     };
291     desc.setHandler(handler);
292     desc.setNameSpaceURI("www.jalview.org");
293     desc.setMultivalued(true);
294     addFieldDescriptor(desc);
295
296     // -- validation code for: _userColoursList
297     fieldValidator = new org.exolab.castor.xml.FieldValidator();
298     fieldValidator.setMinOccurs(0);
299     { // -- local scope
300     }
301     desc.setValidator(fieldValidator);
302     // -- _treeList
303     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
304             jalview.schemabinding.version2.Tree.class, "_treeList", "tree",
305             org.exolab.castor.xml.NodeType.Element);
306     handler = new org.exolab.castor.xml.XMLFieldHandler()
307     {
308       public java.lang.Object getValue(java.lang.Object object)
309               throws IllegalStateException
310       {
311         JalviewModelSequence target = (JalviewModelSequence) object;
312         return target.getTree();
313       }
314
315       public void setValue(java.lang.Object object, java.lang.Object value)
316               throws IllegalStateException, IllegalArgumentException
317       {
318         try
319         {
320           JalviewModelSequence target = (JalviewModelSequence) object;
321           target.addTree((jalview.schemabinding.version2.Tree) value);
322         } catch (java.lang.Exception ex)
323         {
324           throw new IllegalStateException(ex.toString());
325         }
326       }
327
328       public void resetValue(Object object) throws IllegalStateException,
329               IllegalArgumentException
330       {
331         try
332         {
333           JalviewModelSequence target = (JalviewModelSequence) object;
334           target.removeAllTree();
335         } catch (java.lang.Exception ex)
336         {
337           throw new IllegalStateException(ex.toString());
338         }
339       }
340
341       public java.lang.Object newInstance(java.lang.Object parent)
342       {
343         return new jalview.schemabinding.version2.Tree();
344       }
345     };
346     desc.setHandler(handler);
347     desc.setNameSpaceURI("www.jalview.org");
348     desc.setMultivalued(true);
349     addFieldDescriptor(desc);
350
351     // -- validation code for: _treeList
352     fieldValidator = new org.exolab.castor.xml.FieldValidator();
353     fieldValidator.setMinOccurs(0);
354     { // -- local scope
355     }
356     desc.setValidator(fieldValidator);
357     // -- _featureSettings
358     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
359             jalview.schemabinding.version2.FeatureSettings.class,
360             "_featureSettings", "FeatureSettings",
361             org.exolab.castor.xml.NodeType.Element);
362     handler = new org.exolab.castor.xml.XMLFieldHandler()
363     {
364       public java.lang.Object getValue(java.lang.Object object)
365               throws IllegalStateException
366       {
367         JalviewModelSequence target = (JalviewModelSequence) object;
368         return target.getFeatureSettings();
369       }
370
371       public void setValue(java.lang.Object object, java.lang.Object value)
372               throws IllegalStateException, IllegalArgumentException
373       {
374         try
375         {
376           JalviewModelSequence target = (JalviewModelSequence) object;
377           target.setFeatureSettings((jalview.schemabinding.version2.FeatureSettings) value);
378         } catch (java.lang.Exception ex)
379         {
380           throw new IllegalStateException(ex.toString());
381         }
382       }
383
384       public java.lang.Object newInstance(java.lang.Object parent)
385       {
386         return new jalview.schemabinding.version2.FeatureSettings();
387       }
388     };
389     desc.setHandler(handler);
390     desc.setNameSpaceURI("www.jalview.org");
391     desc.setMultivalued(false);
392     addFieldDescriptor(desc);
393
394     // -- validation code for: _featureSettings
395     fieldValidator = new org.exolab.castor.xml.FieldValidator();
396     { // -- local scope
397     }
398     desc.setValidator(fieldValidator);
399   }
400
401   // -----------/
402   // - Methods -/
403   // -----------/
404
405   /**
406    * Method getAccessMode.
407    * 
408    * @return the access mode specified for this class.
409    */
410   public org.exolab.castor.mapping.AccessMode getAccessMode()
411   {
412     return null;
413   }
414
415   /**
416    * Method getIdentity.
417    * 
418    * @return the identity field, null if this class has no identity.
419    */
420   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
421   {
422     return super.getIdentity();
423   }
424
425   /**
426    * Method getJavaClass.
427    * 
428    * @return the Java class represented by this descriptor.
429    */
430   public java.lang.Class getJavaClass()
431   {
432     return jalview.schemabinding.version2.JalviewModelSequence.class;
433   }
434
435   /**
436    * Method getNameSpacePrefix.
437    * 
438    * @return the namespace prefix to use when marshaling as XML.
439    */
440   public java.lang.String getNameSpacePrefix()
441   {
442     return _nsPrefix;
443   }
444
445   /**
446    * Method getNameSpaceURI.
447    * 
448    * @return the namespace URI used when marshaling and unmarshaling as XML.
449    */
450   public java.lang.String getNameSpaceURI()
451   {
452     return _nsURI;
453   }
454
455   /**
456    * Method getValidator.
457    * 
458    * @return a specific validator for the class described by this
459    *         ClassDescriptor.
460    */
461   public org.exolab.castor.xml.TypeValidator getValidator()
462   {
463     return this;
464   }
465
466   /**
467    * Method getXMLName.
468    * 
469    * @return the XML Name for the Class being described.
470    */
471   public java.lang.String getXMLName()
472   {
473     return _xmlName;
474   }
475
476   /**
477    * Method isElementDefinition.
478    * 
479    * @return true if XML schema definition of this Class is that of a global
480    *         element or element with anonymous type definition.
481    */
482   public boolean isElementDefinition()
483   {
484     return _elementDefinition;
485   }
486
487 }