f677adf2218fc29997dfdf3b7a0f68473e59d961
[vamsas.git] / src / uk / ac / vamsas / objects / core / descriptors / DataSetDescriptor.java
1 /*\r
2  * This class was automatically generated with \r
3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML\r
4  * Schema.\r
5  * $Id$\r
6  */\r
7 \r
8 package uk.ac.vamsas.objects.core.descriptors;\r
9 \r
10   //---------------------------------/\r
11  //- Imported classes and packages -/\r
12 //---------------------------------/\r
13 \r
14 import uk.ac.vamsas.objects.core.DataSet;\r
15 \r
16 /**\r
17  * Class DataSetDescriptor.\r
18  * \r
19  * @version $Revision$ $Date$\r
20  */\r
21 public class DataSetDescriptor extends org.exolab.castor.xml.util.XMLClassDescriptorImpl {\r
22 \r
23 \r
24       //--------------------------/\r
25      //- Class/Member Variables -/\r
26     //--------------------------/\r
27 \r
28     /**\r
29      * Field _elementDefinition.\r
30      */\r
31     private boolean _elementDefinition;\r
32 \r
33     /**\r
34      * Field _nsPrefix.\r
35      */\r
36     private java.lang.String _nsPrefix;\r
37 \r
38     /**\r
39      * Field _nsURI.\r
40      */\r
41     private java.lang.String _nsURI;\r
42 \r
43     /**\r
44      * Field _xmlName.\r
45      */\r
46     private java.lang.String _xmlName;\r
47 \r
48 \r
49       //----------------/\r
50      //- Constructors -/\r
51     //----------------/\r
52 \r
53     public DataSetDescriptor() {\r
54         super();\r
55         _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
56         _xmlName = "DataSet";\r
57         _elementDefinition = true;\r
58         \r
59         //-- set grouping compositor\r
60         setCompositorAsSequence();\r
61         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;\r
62         org.exolab.castor.mapping.FieldHandler             handler        = null;\r
63         org.exolab.castor.xml.FieldValidator               fieldValidator = null;\r
64         //-- initialize attribute descriptors\r
65         \r
66         //-- _id\r
67         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_id", "id", org.exolab.castor.xml.NodeType.Attribute);\r
68         super.setIdentity(desc);\r
69         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
70             public java.lang.Object getValue( java.lang.Object object ) \r
71                 throws IllegalStateException\r
72             {\r
73                 DataSet target = (DataSet) object;\r
74                 return target.getId();\r
75             }\r
76             public void setValue( java.lang.Object object, java.lang.Object value) \r
77                 throws IllegalStateException, IllegalArgumentException\r
78             {\r
79                 try {\r
80                     DataSet target = (DataSet) object;\r
81                     target.setId( (java.lang.String) value);\r
82                 } catch (java.lang.Exception ex) {\r
83                     throw new IllegalStateException(ex.toString());\r
84                 }\r
85             }\r
86             public java.lang.Object newInstance(java.lang.Object parent) {\r
87                 return new java.lang.String();\r
88             }\r
89         };\r
90         desc.setHandler(handler);\r
91         desc.setMultivalued(false);\r
92         addFieldDescriptor(desc);\r
93         \r
94         //-- validation code for: _id\r
95         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
96         { //-- local scope\r
97             org.exolab.castor.xml.validators.IdValidator typeValidator;\r
98             typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
99             fieldValidator.setValidator(typeValidator);\r
100         }\r
101         desc.setValidator(fieldValidator);\r
102         //-- initialize element descriptors\r
103         \r
104         //-- _sequenceList\r
105         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Sequence.class, "_sequenceList", "Sequence", org.exolab.castor.xml.NodeType.Element);\r
106         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
107             public java.lang.Object getValue( java.lang.Object object ) \r
108                 throws IllegalStateException\r
109             {\r
110                 DataSet target = (DataSet) object;\r
111                 return target.getSequence();\r
112             }\r
113             public void setValue( java.lang.Object object, java.lang.Object value) \r
114                 throws IllegalStateException, IllegalArgumentException\r
115             {\r
116                 try {\r
117                     DataSet target = (DataSet) object;\r
118                     target.addSequence( (uk.ac.vamsas.objects.core.Sequence) value);\r
119                 } catch (java.lang.Exception ex) {\r
120                     throw new IllegalStateException(ex.toString());\r
121                 }\r
122             }\r
123             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
124                 try {\r
125                     DataSet target = (DataSet) object;\r
126                     target.removeAllSequence();\r
127                 } catch (java.lang.Exception ex) {\r
128                     throw new IllegalStateException(ex.toString());\r
129                 }\r
130             }\r
131             public java.lang.Object newInstance(java.lang.Object parent) {\r
132                 return new uk.ac.vamsas.objects.core.Sequence();\r
133             }\r
134         };\r
135         desc.setHandler(handler);\r
136         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
137         desc.setRequired(true);\r
138         desc.setMultivalued(true);\r
139         addFieldDescriptor(desc);\r
140         \r
141         //-- validation code for: _sequenceList\r
142         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
143         fieldValidator.setMinOccurs(1);\r
144         { //-- local scope\r
145         }\r
146         desc.setValidator(fieldValidator);\r
147         //-- _sequenceMappingList\r
148         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.SequenceMapping.class, "_sequenceMappingList", "sequenceMapping", org.exolab.castor.xml.NodeType.Element);\r
149         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
150             public java.lang.Object getValue( java.lang.Object object ) \r
151                 throws IllegalStateException\r
152             {\r
153                 DataSet target = (DataSet) object;\r
154                 return target.getSequenceMapping();\r
155             }\r
156             public void setValue( java.lang.Object object, java.lang.Object value) \r
157                 throws IllegalStateException, IllegalArgumentException\r
158             {\r
159                 try {\r
160                     DataSet target = (DataSet) object;\r
161                     target.addSequenceMapping( (uk.ac.vamsas.objects.core.SequenceMapping) value);\r
162                 } catch (java.lang.Exception ex) {\r
163                     throw new IllegalStateException(ex.toString());\r
164                 }\r
165             }\r
166             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
167                 try {\r
168                     DataSet target = (DataSet) object;\r
169                     target.removeAllSequenceMapping();\r
170                 } catch (java.lang.Exception ex) {\r
171                     throw new IllegalStateException(ex.toString());\r
172                 }\r
173             }\r
174             public java.lang.Object newInstance(java.lang.Object parent) {\r
175                 return new uk.ac.vamsas.objects.core.SequenceMapping();\r
176             }\r
177         };\r
178         desc.setHandler(handler);\r
179         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
180         desc.setMultivalued(true);\r
181         addFieldDescriptor(desc);\r
182         \r
183         //-- validation code for: _sequenceMappingList\r
184         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
185         fieldValidator.setMinOccurs(0);\r
186         { //-- local scope\r
187         }\r
188         desc.setValidator(fieldValidator);\r
189         //-- _dataSetAnnotationsList\r
190         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.DataSetAnnotations.class, "_dataSetAnnotationsList", "DataSetAnnotations", org.exolab.castor.xml.NodeType.Element);\r
191         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
192             public java.lang.Object getValue( java.lang.Object object ) \r
193                 throws IllegalStateException\r
194             {\r
195                 DataSet target = (DataSet) object;\r
196                 return target.getDataSetAnnotations();\r
197             }\r
198             public void setValue( java.lang.Object object, java.lang.Object value) \r
199                 throws IllegalStateException, IllegalArgumentException\r
200             {\r
201                 try {\r
202                     DataSet target = (DataSet) object;\r
203                     target.addDataSetAnnotations( (uk.ac.vamsas.objects.core.DataSetAnnotations) value);\r
204                 } catch (java.lang.Exception ex) {\r
205                     throw new IllegalStateException(ex.toString());\r
206                 }\r
207             }\r
208             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
209                 try {\r
210                     DataSet target = (DataSet) object;\r
211                     target.removeAllDataSetAnnotations();\r
212                 } catch (java.lang.Exception ex) {\r
213                     throw new IllegalStateException(ex.toString());\r
214                 }\r
215             }\r
216             public java.lang.Object newInstance(java.lang.Object parent) {\r
217                 return new uk.ac.vamsas.objects.core.DataSetAnnotations();\r
218             }\r
219         };\r
220         desc.setHandler(handler);\r
221         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
222         desc.setMultivalued(true);\r
223         addFieldDescriptor(desc);\r
224         \r
225         //-- validation code for: _dataSetAnnotationsList\r
226         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
227         fieldValidator.setMinOccurs(0);\r
228         { //-- local scope\r
229         }\r
230         desc.setValidator(fieldValidator);\r
231         //-- _alignmentList\r
232         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Alignment.class, "_alignmentList", "Alignment", org.exolab.castor.xml.NodeType.Element);\r
233         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
234             public java.lang.Object getValue( java.lang.Object object ) \r
235                 throws IllegalStateException\r
236             {\r
237                 DataSet target = (DataSet) object;\r
238                 return target.getAlignment();\r
239             }\r
240             public void setValue( java.lang.Object object, java.lang.Object value) \r
241                 throws IllegalStateException, IllegalArgumentException\r
242             {\r
243                 try {\r
244                     DataSet target = (DataSet) object;\r
245                     target.addAlignment( (uk.ac.vamsas.objects.core.Alignment) value);\r
246                 } catch (java.lang.Exception ex) {\r
247                     throw new IllegalStateException(ex.toString());\r
248                 }\r
249             }\r
250             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
251                 try {\r
252                     DataSet target = (DataSet) object;\r
253                     target.removeAllAlignment();\r
254                 } catch (java.lang.Exception ex) {\r
255                     throw new IllegalStateException(ex.toString());\r
256                 }\r
257             }\r
258             public java.lang.Object newInstance(java.lang.Object parent) {\r
259                 return new uk.ac.vamsas.objects.core.Alignment();\r
260             }\r
261         };\r
262         desc.setHandler(handler);\r
263         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
264         desc.setMultivalued(true);\r
265         addFieldDescriptor(desc);\r
266         \r
267         //-- validation code for: _alignmentList\r
268         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
269         fieldValidator.setMinOccurs(0);\r
270         { //-- local scope\r
271         }\r
272         desc.setValidator(fieldValidator);\r
273         //-- _treeList\r
274         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Tree.class, "_treeList", "Tree", org.exolab.castor.xml.NodeType.Element);\r
275         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
276             public java.lang.Object getValue( java.lang.Object object ) \r
277                 throws IllegalStateException\r
278             {\r
279                 DataSet target = (DataSet) object;\r
280                 return target.getTree();\r
281             }\r
282             public void setValue( java.lang.Object object, java.lang.Object value) \r
283                 throws IllegalStateException, IllegalArgumentException\r
284             {\r
285                 try {\r
286                     DataSet target = (DataSet) object;\r
287                     target.addTree( (uk.ac.vamsas.objects.core.Tree) value);\r
288                 } catch (java.lang.Exception ex) {\r
289                     throw new IllegalStateException(ex.toString());\r
290                 }\r
291             }\r
292             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
293                 try {\r
294                     DataSet target = (DataSet) object;\r
295                     target.removeAllTree();\r
296                 } catch (java.lang.Exception ex) {\r
297                     throw new IllegalStateException(ex.toString());\r
298                 }\r
299             }\r
300             public java.lang.Object newInstance(java.lang.Object parent) {\r
301                 return new uk.ac.vamsas.objects.core.Tree();\r
302             }\r
303         };\r
304         desc.setHandler(handler);\r
305         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
306         desc.setMultivalued(true);\r
307         addFieldDescriptor(desc);\r
308         \r
309         //-- validation code for: _treeList\r
310         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
311         fieldValidator.setMinOccurs(0);\r
312         { //-- local scope\r
313         }\r
314         desc.setValidator(fieldValidator);\r
315         //-- _provenance\r
316         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Provenance.class, "_provenance", "Provenance", org.exolab.castor.xml.NodeType.Element);\r
317         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
318             public java.lang.Object getValue( java.lang.Object object ) \r
319                 throws IllegalStateException\r
320             {\r
321                 DataSet target = (DataSet) object;\r
322                 return target.getProvenance();\r
323             }\r
324             public void setValue( java.lang.Object object, java.lang.Object value) \r
325                 throws IllegalStateException, IllegalArgumentException\r
326             {\r
327                 try {\r
328                     DataSet target = (DataSet) object;\r
329                     target.setProvenance( (uk.ac.vamsas.objects.core.Provenance) value);\r
330                 } catch (java.lang.Exception ex) {\r
331                     throw new IllegalStateException(ex.toString());\r
332                 }\r
333             }\r
334             public java.lang.Object newInstance(java.lang.Object parent) {\r
335                 return new uk.ac.vamsas.objects.core.Provenance();\r
336             }\r
337         };\r
338         desc.setHandler(handler);\r
339         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
340         desc.setRequired(true);\r
341         desc.setMultivalued(false);\r
342         addFieldDescriptor(desc);\r
343         \r
344         //-- validation code for: _provenance\r
345         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
346         fieldValidator.setMinOccurs(1);\r
347         { //-- local scope\r
348         }\r
349         desc.setValidator(fieldValidator);\r
350     }\r
351 \r
352 \r
353       //-----------/\r
354      //- Methods -/\r
355     //-----------/\r
356 \r
357     /**\r
358      * Method getAccessMode.\r
359      * \r
360      * @return the access mode specified for this class.\r
361      */\r
362     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
363     ) {\r
364         return null;\r
365     }\r
366 \r
367     /**\r
368      * Method getIdentity.\r
369      * \r
370      * @return the identity field, null if this class has no\r
371      * identity.\r
372      */\r
373     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
374     ) {\r
375         return super.getIdentity();\r
376     }\r
377 \r
378     /**\r
379      * Method getJavaClass.\r
380      * \r
381      * @return the Java class represented by this descriptor.\r
382      */\r
383     public java.lang.Class getJavaClass(\r
384     ) {\r
385         return uk.ac.vamsas.objects.core.DataSet.class;\r
386     }\r
387 \r
388     /**\r
389      * Method getNameSpacePrefix.\r
390      * \r
391      * @return the namespace prefix to use when marshaling as XML.\r
392      */\r
393     public java.lang.String getNameSpacePrefix(\r
394     ) {\r
395         return _nsPrefix;\r
396     }\r
397 \r
398     /**\r
399      * Method getNameSpaceURI.\r
400      * \r
401      * @return the namespace URI used when marshaling and\r
402      * unmarshaling as XML.\r
403      */\r
404     public java.lang.String getNameSpaceURI(\r
405     ) {\r
406         return _nsURI;\r
407     }\r
408 \r
409     /**\r
410      * Method getValidator.\r
411      * \r
412      * @return a specific validator for the class described by this\r
413      * ClassDescriptor.\r
414      */\r
415     public org.exolab.castor.xml.TypeValidator getValidator(\r
416     ) {\r
417         return this;\r
418     }\r
419 \r
420     /**\r
421      * Method getXMLName.\r
422      * \r
423      * @return the XML Name for the Class being described.\r
424      */\r
425     public java.lang.String getXMLName(\r
426     ) {\r
427         return _xmlName;\r
428     }\r
429 \r
430     /**\r
431      * Method isElementDefinition.\r
432      * \r
433      * @return true if XML schema definition of this Class is that\r
434      * of a global\r
435      * element or element with anonymous type definition.\r
436      */\r
437     public boolean isElementDefinition(\r
438     ) {\r
439         return _elementDefinition;\r
440     }\r
441 \r
442 }\r