src/uk/ac/vamsas/objects/core/descriptors/AlignmentDescriptor.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.Alignment;\r
  15 \r
  16 /**\r
  17  * Class AlignmentDescriptor.\r
  18  * \r
  19  * @version $Revision$ $Date$\r
  20  */\r
  21 public class AlignmentDescriptor 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      * Field _identity.\r
  50      */\r
  51     private org.exolab.castor.xml.XMLFieldDescriptor _identity;\r
  52 \r
  53 \r
  54       //----------------/\r
  55      //- Constructors -/\r
  56     //----------------/\r
  57 \r
  58     public AlignmentDescriptor() {\r
  59         super();\r
  60         _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  61         _xmlName = "Alignment";\r
  62         _elementDefinition = true;\r
  63         \r
  64         //-- set grouping compositor\r
  65         setCompositorAsSequence();\r
  66         org.exolab.castor.xml.util.XMLFieldDescriptorImpl  desc           = null;\r
  67         org.exolab.castor.mapping.FieldHandler             handler        = null;\r
  68         org.exolab.castor.xml.FieldValidator               fieldValidator = null;\r
  69         //-- initialize attribute descriptors\r
  70         \r
  71         //-- _gapChar\r
  72         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_gapChar", "gapChar", org.exolab.castor.xml.NodeType.Attribute);\r
  73         desc.setImmutable(true);\r
  74         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  75             public java.lang.Object getValue( java.lang.Object object ) \r
  76                 throws IllegalStateException\r
  77             {\r
  78                 Alignment target = (Alignment) object;\r
  79                 return target.getGapChar();\r
  80             }\r
  81             public void setValue( java.lang.Object object, java.lang.Object value) \r
  82                 throws IllegalStateException, IllegalArgumentException\r
  83             {\r
  84                 try {\r
  85                     Alignment target = (Alignment) object;\r
  86                     target.setGapChar( (java.lang.String) value);\r
  87                 } catch (java.lang.Exception ex) {\r
  88                     throw new IllegalStateException(ex.toString());\r
  89                 }\r
  90             }\r
  91             public java.lang.Object newInstance(java.lang.Object parent) {\r
  92                 return null;\r
  93             }\r
  94         };\r
  95         desc.setHandler(handler);\r
  96         desc.setRequired(true);\r
  97         desc.setMultivalued(false);\r
  98         addFieldDescriptor(desc);\r
  99         \r
 100         //-- validation code for: _gapChar\r
 101         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 102         fieldValidator.setMinOccurs(1);\r
 103         { //-- local scope\r
 104             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 105             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 106             fieldValidator.setValidator(typeValidator);\r
 107             typeValidator.setWhiteSpace("preserve");\r
 108         }\r
 109         desc.setValidator(fieldValidator);\r
 110         //-- _aligned\r
 111         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.Boolean.TYPE, "_aligned", "aligned", org.exolab.castor.xml.NodeType.Attribute);\r
 112         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 113             public java.lang.Object getValue( java.lang.Object object ) \r
 114                 throws IllegalStateException\r
 115             {\r
 116                 Alignment target = (Alignment) object;\r
 117                 if (!target.hasAligned()) { return null; }\r
 118                 return (target.getAligned() ? java.lang.Boolean.TRUE : java.lang.Boolean.FALSE);\r
 119             }\r
 120             public void setValue( java.lang.Object object, java.lang.Object value) \r
 121                 throws IllegalStateException, IllegalArgumentException\r
 122             {\r
 123                 try {\r
 124                     Alignment target = (Alignment) object;\r
 125                     // if null, use delete method for optional primitives \r
 126                     if (value == null) {\r
 127                         target.deleteAligned();\r
 128                         return;\r
 129                     }\r
 130                     target.setAligned( ((java.lang.Boolean) value).booleanValue());\r
 131                 } catch (java.lang.Exception ex) {\r
 132                     throw new IllegalStateException(ex.toString());\r
 133                 }\r
 134             }\r
 135             public java.lang.Object newInstance(java.lang.Object parent) {\r
 136                 return null;\r
 137             }\r
 138         };\r
 139         desc.setHandler(handler);\r
 140         desc.setMultivalued(false);\r
 141         addFieldDescriptor(desc);\r
 142         \r
 143         //-- validation code for: _aligned\r
 144         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 145         { //-- local scope\r
 146             org.exolab.castor.xml.validators.BooleanValidator typeValidator;\r
 147             typeValidator = new org.exolab.castor.xml.validators.BooleanValidator();\r
 148             fieldValidator.setValidator(typeValidator);\r
 149         }\r
 150         desc.setValidator(fieldValidator);\r
 151         //-- _id\r
 152         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_id", "id", org.exolab.castor.xml.NodeType.Attribute);\r
 153         this._identity = desc;\r
 154         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 155             public java.lang.Object getValue( java.lang.Object object ) \r
 156                 throws IllegalStateException\r
 157             {\r
 158                 Alignment target = (Alignment) object;\r
 159                 return target.getId();\r
 160             }\r
 161             public void setValue( java.lang.Object object, java.lang.Object value) \r
 162                 throws IllegalStateException, IllegalArgumentException\r
 163             {\r
 164                 try {\r
 165                     Alignment target = (Alignment) object;\r
 166                     target.setId( (java.lang.String) value);\r
 167                 } catch (java.lang.Exception ex) {\r
 168                     throw new IllegalStateException(ex.toString());\r
 169                 }\r
 170             }\r
 171             public java.lang.Object newInstance(java.lang.Object parent) {\r
 172                 return new java.lang.String();\r
 173             }\r
 174         };\r
 175         desc.setHandler(handler);\r
 176         desc.setMultivalued(false);\r
 177         addFieldDescriptor(desc);\r
 178         \r
 179         //-- validation code for: _id\r
 180         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 181         { //-- local scope\r
 182             org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 183             typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 184             fieldValidator.setValidator(typeValidator);\r
 185         }\r
 186         desc.setValidator(fieldValidator);\r
 187         //-- _modifiable\r
 188         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(java.lang.String.class, "_modifiable", "modifiable", org.exolab.castor.xml.NodeType.Attribute);\r
 189         desc.setImmutable(true);\r
 190         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 191             public java.lang.Object getValue( java.lang.Object object ) \r
 192                 throws IllegalStateException\r
 193             {\r
 194                 Alignment target = (Alignment) object;\r
 195                 return target.getModifiable();\r
 196             }\r
 197             public void setValue( java.lang.Object object, java.lang.Object value) \r
 198                 throws IllegalStateException, IllegalArgumentException\r
 199             {\r
 200                 try {\r
 201                     Alignment target = (Alignment) object;\r
 202                     target.setModifiable( (java.lang.String) value);\r
 203                 } catch (java.lang.Exception ex) {\r
 204                     throw new IllegalStateException(ex.toString());\r
 205                 }\r
 206             }\r
 207             public java.lang.Object newInstance(java.lang.Object parent) {\r
 208                 return null;\r
 209             }\r
 210         };\r
 211         desc.setHandler(handler);\r
 212         desc.setMultivalued(false);\r
 213         addFieldDescriptor(desc);\r
 214         \r
 215         //-- validation code for: _modifiable\r
 216         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 217         { //-- local scope\r
 218             org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 219             typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 220             fieldValidator.setValidator(typeValidator);\r
 221             typeValidator.setWhiteSpace("preserve");\r
 222         }\r
 223         desc.setValidator(fieldValidator);\r
 224         //-- initialize element descriptors\r
 225         \r
 226         //-- _alignmentAnnotationList\r
 227         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.AlignmentAnnotation.class, "_alignmentAnnotationList", "AlignmentAnnotation", org.exolab.castor.xml.NodeType.Element);\r
 228         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 229             public java.lang.Object getValue( java.lang.Object object ) \r
 230                 throws IllegalStateException\r
 231             {\r
 232                 Alignment target = (Alignment) object;\r
 233                 return target.getAlignmentAnnotation();\r
 234             }\r
 235             public void setValue( java.lang.Object object, java.lang.Object value) \r
 236                 throws IllegalStateException, IllegalArgumentException\r
 237             {\r
 238                 try {\r
 239                     Alignment target = (Alignment) object;\r
 240                     target.addAlignmentAnnotation( (uk.ac.vamsas.objects.core.AlignmentAnnotation) value);\r
 241                 } catch (java.lang.Exception ex) {\r
 242                     throw new IllegalStateException(ex.toString());\r
 243                 }\r
 244             }\r
 245             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
 246                 try {\r
 247                     Alignment target = (Alignment) object;\r
 248                     target.removeAllAlignmentAnnotation();\r
 249                 } catch (java.lang.Exception ex) {\r
 250                     throw new IllegalStateException(ex.toString());\r
 251                 }\r
 252             }\r
 253             public java.lang.Object newInstance(java.lang.Object parent) {\r
 254                 return new uk.ac.vamsas.objects.core.AlignmentAnnotation();\r
 255             }\r
 256         };\r
 257         desc.setHandler(handler);\r
 258         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 259         desc.setMultivalued(true);\r
 260         addFieldDescriptor(desc);\r
 261         \r
 262         //-- validation code for: _alignmentAnnotationList\r
 263         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 264         fieldValidator.setMinOccurs(0);\r
 265         { //-- local scope\r
 266         }\r
 267         desc.setValidator(fieldValidator);\r
 268         //-- _treeList\r
 269         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Tree.class, "_treeList", "Tree", org.exolab.castor.xml.NodeType.Element);\r
 270         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 271             public java.lang.Object getValue( java.lang.Object object ) \r
 272                 throws IllegalStateException\r
 273             {\r
 274                 Alignment target = (Alignment) object;\r
 275                 return target.getTree();\r
 276             }\r
 277             public void setValue( java.lang.Object object, java.lang.Object value) \r
 278                 throws IllegalStateException, IllegalArgumentException\r
 279             {\r
 280                 try {\r
 281                     Alignment target = (Alignment) object;\r
 282                     target.addTree( (uk.ac.vamsas.objects.core.Tree) value);\r
 283                 } catch (java.lang.Exception ex) {\r
 284                     throw new IllegalStateException(ex.toString());\r
 285                 }\r
 286             }\r
 287             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
 288                 try {\r
 289                     Alignment target = (Alignment) object;\r
 290                     target.removeAllTree();\r
 291                 } catch (java.lang.Exception ex) {\r
 292                     throw new IllegalStateException(ex.toString());\r
 293                 }\r
 294             }\r
 295             public java.lang.Object newInstance(java.lang.Object parent) {\r
 296                 return new uk.ac.vamsas.objects.core.Tree();\r
 297             }\r
 298         };\r
 299         desc.setHandler(handler);\r
 300         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 301         desc.setMultivalued(true);\r
 302         addFieldDescriptor(desc);\r
 303         \r
 304         //-- validation code for: _treeList\r
 305         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 306         fieldValidator.setMinOccurs(0);\r
 307         { //-- local scope\r
 308         }\r
 309         desc.setValidator(fieldValidator);\r
 310         //-- _alignmentSequenceList\r
 311         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.AlignmentSequence.class, "_alignmentSequenceList", "alignmentSequence", org.exolab.castor.xml.NodeType.Element);\r
 312         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 313             public java.lang.Object getValue( java.lang.Object object ) \r
 314                 throws IllegalStateException\r
 315             {\r
 316                 Alignment target = (Alignment) object;\r
 317                 return target.getAlignmentSequence();\r
 318             }\r
 319             public void setValue( java.lang.Object object, java.lang.Object value) \r
 320                 throws IllegalStateException, IllegalArgumentException\r
 321             {\r
 322                 try {\r
 323                     Alignment target = (Alignment) object;\r
 324                     target.addAlignmentSequence( (uk.ac.vamsas.objects.core.AlignmentSequence) value);\r
 325                 } catch (java.lang.Exception ex) {\r
 326                     throw new IllegalStateException(ex.toString());\r
 327                 }\r
 328             }\r
 329             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
 330                 try {\r
 331                     Alignment target = (Alignment) object;\r
 332                     target.removeAllAlignmentSequence();\r
 333                 } catch (java.lang.Exception ex) {\r
 334                     throw new IllegalStateException(ex.toString());\r
 335                 }\r
 336             }\r
 337             public java.lang.Object newInstance(java.lang.Object parent) {\r
 338                 return new uk.ac.vamsas.objects.core.AlignmentSequence();\r
 339             }\r
 340         };\r
 341         desc.setHandler(handler);\r
 342         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 343         desc.setRequired(true);\r
 344         desc.setMultivalued(true);\r
 345         addFieldDescriptor(desc);\r
 346         \r
 347         //-- validation code for: _alignmentSequenceList\r
 348         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 349         fieldValidator.setMinOccurs(1);\r
 350         { //-- local scope\r
 351         }\r
 352         desc.setValidator(fieldValidator);\r
 353         //-- _propertyList\r
 354         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Property.class, "_propertyList", "property", org.exolab.castor.xml.NodeType.Element);\r
 355         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 356             public java.lang.Object getValue( java.lang.Object object ) \r
 357                 throws IllegalStateException\r
 358             {\r
 359                 Alignment target = (Alignment) object;\r
 360                 return target.getProperty();\r
 361             }\r
 362             public void setValue( java.lang.Object object, java.lang.Object value) \r
 363                 throws IllegalStateException, IllegalArgumentException\r
 364             {\r
 365                 try {\r
 366                     Alignment target = (Alignment) object;\r
 367                     target.addProperty( (uk.ac.vamsas.objects.core.Property) value);\r
 368                 } catch (java.lang.Exception ex) {\r
 369                     throw new IllegalStateException(ex.toString());\r
 370                 }\r
 371             }\r
 372             public void resetValue(Object object) throws IllegalStateException, IllegalArgumentException {\r
 373                 try {\r
 374                     Alignment target = (Alignment) object;\r
 375                     target.removeAllProperty();\r
 376                 } catch (java.lang.Exception ex) {\r
 377                     throw new IllegalStateException(ex.toString());\r
 378                 }\r
 379             }\r
 380             public java.lang.Object newInstance(java.lang.Object parent) {\r
 381                 return new uk.ac.vamsas.objects.core.Property();\r
 382             }\r
 383         };\r
 384         desc.setHandler(handler);\r
 385         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 386         desc.setMultivalued(true);\r
 387         addFieldDescriptor(desc);\r
 388         \r
 389         //-- validation code for: _propertyList\r
 390         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 391         fieldValidator.setMinOccurs(0);\r
 392         { //-- local scope\r
 393         }\r
 394         desc.setValidator(fieldValidator);\r
 395         //-- _provenance\r
 396         desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(uk.ac.vamsas.objects.core.Provenance.class, "_provenance", "Provenance", org.exolab.castor.xml.NodeType.Element);\r
 397         handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 398             public java.lang.Object getValue( java.lang.Object object ) \r
 399                 throws IllegalStateException\r
 400             {\r
 401                 Alignment target = (Alignment) object;\r
 402                 return target.getProvenance();\r
 403             }\r
 404             public void setValue( java.lang.Object object, java.lang.Object value) \r
 405                 throws IllegalStateException, IllegalArgumentException\r
 406             {\r
 407                 try {\r
 408                     Alignment target = (Alignment) object;\r
 409                     target.setProvenance( (uk.ac.vamsas.objects.core.Provenance) value);\r
 410                 } catch (java.lang.Exception ex) {\r
 411                     throw new IllegalStateException(ex.toString());\r
 412                 }\r
 413             }\r
 414             public java.lang.Object newInstance(java.lang.Object parent) {\r
 415                 return new uk.ac.vamsas.objects.core.Provenance();\r
 416             }\r
 417         };\r
 418         desc.setHandler(handler);\r
 419         desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 420         desc.setRequired(true);\r
 421         desc.setMultivalued(false);\r
 422         addFieldDescriptor(desc);\r
 423         \r
 424         //-- validation code for: _provenance\r
 425         fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 426         fieldValidator.setMinOccurs(1);\r
 427         { //-- local scope\r
 428         }\r
 429         desc.setValidator(fieldValidator);\r
 430     }\r
 431 \r
 432 \r
 433       //-----------/\r
 434      //- Methods -/\r
 435     //-----------/\r
 436 \r
 437     /**\r
 438      * Method getAccessMode.\r
 439      * \r
 440      * @return the access mode specified for this class.\r
 441      */\r
 442     public org.exolab.castor.mapping.AccessMode getAccessMode(\r
 443     ) {\r
 444         return null;\r
 445     }\r
 446 \r
 447     /**\r
 448      * Method getIdentity.\r
 449      * \r
 450      * @return the identity field, null if this class has no\r
 451      * identity.\r
 452      */\r
 453     public org.exolab.castor.mapping.FieldDescriptor getIdentity(\r
 454     ) {\r
 455         return _identity;\r
 456     }\r
 457 \r
 458     /**\r
 459      * Method getJavaClass.\r
 460      * \r
 461      * @return the Java class represented by this descriptor.\r
 462      */\r
 463     public java.lang.Class getJavaClass(\r
 464     ) {\r
 465         return uk.ac.vamsas.objects.core.Alignment.class;\r
 466     }\r
 467 \r
 468     /**\r
 469      * Method getNameSpacePrefix.\r
 470      * \r
 471      * @return the namespace prefix to use when marshaling as XML.\r
 472      */\r
 473     public java.lang.String getNameSpacePrefix(\r
 474     ) {\r
 475         return _nsPrefix;\r
 476     }\r
 477 \r
 478     /**\r
 479      * Method getNameSpaceURI.\r
 480      * \r
 481      * @return the namespace URI used when marshaling and\r
 482      * unmarshaling as XML.\r
 483      */\r
 484     public java.lang.String getNameSpaceURI(\r
 485     ) {\r
 486         return _nsURI;\r
 487     }\r
 488 \r
 489     /**\r
 490      * Method getValidator.\r
 491      * \r
 492      * @return a specific validator for the class described by this\r
 493      * ClassDescriptor.\r
 494      */\r
 495     public org.exolab.castor.xml.TypeValidator getValidator(\r
 496     ) {\r
 497         return this;\r
 498     }\r
 499 \r
 500     /**\r
 501      * Method getXMLName.\r
 502      * \r
 503      * @return the XML Name for the Class being described.\r
 504      */\r
 505     public java.lang.String getXMLName(\r
 506     ) {\r
 507         return _xmlName;\r
 508     }\r
 509 \r
 510     /**\r
 511      * Method isElementDefinition.\r
 512      * \r
 513      * @return true if XML schema definition of this Class is that\r
 514      * of a global\r
 515      * element or element with anonymous type definition.\r
 516      */\r
 517     public boolean isElementDefinition(\r
 518     ) {\r
 519         return _elementDefinition;\r
 520     }\r
 521 \r
 522 }\r