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