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