src/uk/ac/vamsas/objects/core/descriptors/TreeDescriptor.java

   1 /*\r
   2  * This file is part of the Vamsas Client version 0.1. \r
   3  * Copyright 2009 by Jim Procter, Iain Milne, Pierre Marguerite, \r
   4  *  Andrew Waterhouse and Dominik Lindner.\r
   5  * \r
   6  * Earlier versions have also been incorporated into Jalview version 2.4 \r
   7  * since 2008, and TOPALi version 2 since 2007.\r
   8  * \r
   9  * The Vamsas Client is free software: you can redistribute it and/or modify\r
  10  * it under the terms of the GNU Lesser General Public License as published by\r
  11  * the Free Software Foundation, either version 3 of the License, or\r
  12  * (at your option) any later version.\r
  13  *  \r
  14  * The Vamsas Client is distributed in the hope that it will be useful,\r
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  17  * GNU Lesser General Public License for more details.\r
  18  * \r
  19  * You should have received a copy of the GNU Lesser General Public License\r
  20  * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.\r
  21  */\r
  22 package uk.ac.vamsas.objects.core.descriptors;\r
  23 \r
  24 //---------------------------------/\r
  25 //- Imported classes and packages -/\r
  26 //---------------------------------/\r
  27 \r
  28 import uk.ac.vamsas.objects.core.Tree;\r
  29 \r
  30 /**\r
  31  * Class TreeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class TreeDescriptor extends\r
  36     org.exolab.castor.xml.util.XMLClassDescriptorImpl {\r
  37 \r
  38   // --------------------------/\r
  39   // - Class/Member Variables -/\r
  40   // --------------------------/\r
  41 \r
  42   /**\r
  43    * Field _elementDefinition.\r
  44    */\r
  45   private boolean _elementDefinition;\r
  46 \r
  47   /**\r
  48    * Field _nsPrefix.\r
  49    */\r
  50   private java.lang.String _nsPrefix;\r
  51 \r
  52   /**\r
  53    * Field _nsURI.\r
  54    */\r
  55   private java.lang.String _nsURI;\r
  56 \r
  57   /**\r
  58    * Field _xmlName.\r
  59    */\r
  60   private java.lang.String _xmlName;\r
  61 \r
  62   // ----------------/\r
  63   // - Constructors -/\r
  64   // ----------------/\r
  65 \r
  66   public TreeDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "Tree";\r
  70     _elementDefinition = true;\r
  71 \r
  72     // -- set grouping compositor\r
  73     setCompositorAsSequence();\r
  74     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  75     org.exolab.castor.mapping.FieldHandler handler = null;\r
  76     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  77     // -- initialize attribute descriptors\r
  78 \r
  79     // -- _id\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81         java.lang.String.class, "_id", "id",\r
  82         org.exolab.castor.xml.NodeType.Attribute);\r
  83     super.setIdentity(desc);\r
  84     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  85       public java.lang.Object getValue(java.lang.Object object)\r
  86           throws IllegalStateException {\r
  87         Tree target = (Tree) object;\r
  88         return target.getId();\r
  89       }\r
  90 \r
  91       public void setValue(java.lang.Object object, java.lang.Object value)\r
  92           throws IllegalStateException, IllegalArgumentException {\r
  93         try {\r
  94           Tree target = (Tree) object;\r
  95           target.setId((java.lang.String) value);\r
  96         } catch (java.lang.Exception ex) {\r
  97           throw new IllegalStateException(ex.toString());\r
  98         }\r
  99       }\r
 100 \r
 101       public java.lang.Object newInstance(java.lang.Object parent) {\r
 102         return new java.lang.String();\r
 103       }\r
 104     };\r
 105     desc.setHandler(handler);\r
 106     desc.setMultivalued(false);\r
 107     addFieldDescriptor(desc);\r
 108 \r
 109     // -- validation code for: _id\r
 110     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 111     { // -- local scope\r
 112       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 113       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 114       fieldValidator.setValidator(typeValidator);\r
 115     }\r
 116     desc.setValidator(fieldValidator);\r
 117     // -- _modifiable\r
 118     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 119         java.lang.String.class, "_modifiable", "modifiable",\r
 120         org.exolab.castor.xml.NodeType.Attribute);\r
 121     desc.setImmutable(true);\r
 122     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 123       public java.lang.Object getValue(java.lang.Object object)\r
 124           throws IllegalStateException {\r
 125         Tree target = (Tree) object;\r
 126         return target.getModifiable();\r
 127       }\r
 128 \r
 129       public void setValue(java.lang.Object object, java.lang.Object value)\r
 130           throws IllegalStateException, IllegalArgumentException {\r
 131         try {\r
 132           Tree target = (Tree) object;\r
 133           target.setModifiable((java.lang.String) value);\r
 134         } catch (java.lang.Exception ex) {\r
 135           throw new IllegalStateException(ex.toString());\r
 136         }\r
 137       }\r
 138 \r
 139       public java.lang.Object newInstance(java.lang.Object parent) {\r
 140         return null;\r
 141       }\r
 142     };\r
 143     desc.setHandler(handler);\r
 144     desc.setMultivalued(false);\r
 145     addFieldDescriptor(desc);\r
 146 \r
 147     // -- validation code for: _modifiable\r
 148     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 149     { // -- local scope\r
 150       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 151       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 152       fieldValidator.setValidator(typeValidator);\r
 153       typeValidator.setWhiteSpace("preserve");\r
 154     }\r
 155     desc.setValidator(fieldValidator);\r
 156     // -- initialize element descriptors\r
 157 \r
 158     // -- _title\r
 159     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 160         java.lang.String.class, "_title", "title",\r
 161         org.exolab.castor.xml.NodeType.Element);\r
 162     desc.setImmutable(true);\r
 163     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 164       public java.lang.Object getValue(java.lang.Object object)\r
 165           throws IllegalStateException {\r
 166         Tree target = (Tree) object;\r
 167         return target.getTitle();\r
 168       }\r
 169 \r
 170       public void setValue(java.lang.Object object, java.lang.Object value)\r
 171           throws IllegalStateException, IllegalArgumentException {\r
 172         try {\r
 173           Tree target = (Tree) object;\r
 174           target.setTitle((java.lang.String) value);\r
 175         } catch (java.lang.Exception ex) {\r
 176           throw new IllegalStateException(ex.toString());\r
 177         }\r
 178       }\r
 179 \r
 180       public java.lang.Object newInstance(java.lang.Object parent) {\r
 181         return null;\r
 182       }\r
 183     };\r
 184     desc.setHandler(handler);\r
 185     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 186     desc.setMultivalued(false);\r
 187     addFieldDescriptor(desc);\r
 188 \r
 189     // -- validation code for: _title\r
 190     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 191     { // -- local scope\r
 192       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 193       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 194       fieldValidator.setValidator(typeValidator);\r
 195       typeValidator.setWhiteSpace("preserve");\r
 196     }\r
 197     desc.setValidator(fieldValidator);\r
 198     // -- _newickList\r
 199     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 200         uk.ac.vamsas.objects.core.Newick.class, "_newickList", "newick",\r
 201         org.exolab.castor.xml.NodeType.Element);\r
 202     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 203       public java.lang.Object getValue(java.lang.Object object)\r
 204           throws IllegalStateException {\r
 205         Tree target = (Tree) object;\r
 206         return target.getNewick();\r
 207       }\r
 208 \r
 209       public void setValue(java.lang.Object object, java.lang.Object value)\r
 210           throws IllegalStateException, IllegalArgumentException {\r
 211         try {\r
 212           Tree target = (Tree) object;\r
 213           target.addNewick((uk.ac.vamsas.objects.core.Newick) value);\r
 214         } catch (java.lang.Exception ex) {\r
 215           throw new IllegalStateException(ex.toString());\r
 216         }\r
 217       }\r
 218 \r
 219       public void resetValue(Object object) throws IllegalStateException,\r
 220           IllegalArgumentException {\r
 221         try {\r
 222           Tree target = (Tree) object;\r
 223           target.removeAllNewick();\r
 224         } catch (java.lang.Exception ex) {\r
 225           throw new IllegalStateException(ex.toString());\r
 226         }\r
 227       }\r
 228 \r
 229       public java.lang.Object newInstance(java.lang.Object parent) {\r
 230         return new uk.ac.vamsas.objects.core.Newick();\r
 231       }\r
 232     };\r
 233     desc.setHandler(handler);\r
 234     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 235     desc.setRequired(true);\r
 236     desc.setMultivalued(true);\r
 237     addFieldDescriptor(desc);\r
 238 \r
 239     // -- validation code for: _newickList\r
 240     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 241     fieldValidator.setMinOccurs(1);\r
 242     { // -- local scope\r
 243     }\r
 244     desc.setValidator(fieldValidator);\r
 245     // -- _treenodeList\r
 246     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 247         uk.ac.vamsas.objects.core.Treenode.class, "_treenodeList", "treenode",\r
 248         org.exolab.castor.xml.NodeType.Element);\r
 249     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 250       public java.lang.Object getValue(java.lang.Object object)\r
 251           throws IllegalStateException {\r
 252         Tree target = (Tree) object;\r
 253         return target.getTreenode();\r
 254       }\r
 255 \r
 256       public void setValue(java.lang.Object object, java.lang.Object value)\r
 257           throws IllegalStateException, IllegalArgumentException {\r
 258         try {\r
 259           Tree target = (Tree) object;\r
 260           target.addTreenode((uk.ac.vamsas.objects.core.Treenode) value);\r
 261         } catch (java.lang.Exception ex) {\r
 262           throw new IllegalStateException(ex.toString());\r
 263         }\r
 264       }\r
 265 \r
 266       public void resetValue(Object object) throws IllegalStateException,\r
 267           IllegalArgumentException {\r
 268         try {\r
 269           Tree target = (Tree) object;\r
 270           target.removeAllTreenode();\r
 271         } catch (java.lang.Exception ex) {\r
 272           throw new IllegalStateException(ex.toString());\r
 273         }\r
 274       }\r
 275 \r
 276       public java.lang.Object newInstance(java.lang.Object parent) {\r
 277         return new uk.ac.vamsas.objects.core.Treenode();\r
 278       }\r
 279     };\r
 280     desc.setHandler(handler);\r
 281     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 282     desc.setMultivalued(true);\r
 283     addFieldDescriptor(desc);\r
 284 \r
 285     // -- validation code for: _treenodeList\r
 286     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 287     fieldValidator.setMinOccurs(0);\r
 288     { // -- local scope\r
 289     }\r
 290     desc.setValidator(fieldValidator);\r
 291     // -- _propertyList\r
 292     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 293         uk.ac.vamsas.objects.core.Property.class, "_propertyList", "property",\r
 294         org.exolab.castor.xml.NodeType.Element);\r
 295     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 296       public java.lang.Object getValue(java.lang.Object object)\r
 297           throws IllegalStateException {\r
 298         Tree target = (Tree) object;\r
 299         return target.getProperty();\r
 300       }\r
 301 \r
 302       public void setValue(java.lang.Object object, java.lang.Object value)\r
 303           throws IllegalStateException, IllegalArgumentException {\r
 304         try {\r
 305           Tree target = (Tree) object;\r
 306           target.addProperty((uk.ac.vamsas.objects.core.Property) value);\r
 307         } catch (java.lang.Exception ex) {\r
 308           throw new IllegalStateException(ex.toString());\r
 309         }\r
 310       }\r
 311 \r
 312       public void resetValue(Object object) throws IllegalStateException,\r
 313           IllegalArgumentException {\r
 314         try {\r
 315           Tree target = (Tree) object;\r
 316           target.removeAllProperty();\r
 317         } catch (java.lang.Exception ex) {\r
 318           throw new IllegalStateException(ex.toString());\r
 319         }\r
 320       }\r
 321 \r
 322       public java.lang.Object newInstance(java.lang.Object parent) {\r
 323         return new uk.ac.vamsas.objects.core.Property();\r
 324       }\r
 325     };\r
 326     desc.setHandler(handler);\r
 327     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 328     desc.setMultivalued(true);\r
 329     addFieldDescriptor(desc);\r
 330 \r
 331     // -- validation code for: _propertyList\r
 332     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 333     fieldValidator.setMinOccurs(0);\r
 334     { // -- local scope\r
 335     }\r
 336     desc.setValidator(fieldValidator);\r
 337     // -- _provenance\r
 338     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 339         uk.ac.vamsas.objects.core.Provenance.class, "_provenance",\r
 340         "Provenance", org.exolab.castor.xml.NodeType.Element);\r
 341     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 342       public java.lang.Object getValue(java.lang.Object object)\r
 343           throws IllegalStateException {\r
 344         Tree target = (Tree) object;\r
 345         return target.getProvenance();\r
 346       }\r
 347 \r
 348       public void setValue(java.lang.Object object, java.lang.Object value)\r
 349           throws IllegalStateException, IllegalArgumentException {\r
 350         try {\r
 351           Tree target = (Tree) object;\r
 352           target.setProvenance((uk.ac.vamsas.objects.core.Provenance) value);\r
 353         } catch (java.lang.Exception ex) {\r
 354           throw new IllegalStateException(ex.toString());\r
 355         }\r
 356       }\r
 357 \r
 358       public java.lang.Object newInstance(java.lang.Object parent) {\r
 359         return new uk.ac.vamsas.objects.core.Provenance();\r
 360       }\r
 361     };\r
 362     desc.setHandler(handler);\r
 363     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 364     desc.setRequired(true);\r
 365     desc.setMultivalued(false);\r
 366     addFieldDescriptor(desc);\r
 367 \r
 368     // -- validation code for: _provenance\r
 369     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 370     fieldValidator.setMinOccurs(1);\r
 371     { // -- local scope\r
 372     }\r
 373     desc.setValidator(fieldValidator);\r
 374   }\r
 375 \r
 376   // -----------/\r
 377   // - Methods -/\r
 378   // -----------/\r
 379 \r
 380   /**\r
 381    * Method getAccessMode.\r
 382    * \r
 383    * @return the access mode specified for this class.\r
 384    */\r
 385   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 386     return null;\r
 387   }\r
 388 \r
 389   /**\r
 390    * Method getIdentity.\r
 391    * \r
 392    * @return the identity field, null if this class has no identity.\r
 393    */\r
 394   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 395     return super.getIdentity();\r
 396   }\r
 397 \r
 398   /**\r
 399    * Method getJavaClass.\r
 400    * \r
 401    * @return the Java class represented by this descriptor.\r
 402    */\r
 403   public java.lang.Class getJavaClass() {\r
 404     return uk.ac.vamsas.objects.core.Tree.class;\r
 405   }\r
 406 \r
 407   /**\r
 408    * Method getNameSpacePrefix.\r
 409    * \r
 410    * @return the namespace prefix to use when marshaling as XML.\r
 411    */\r
 412   public java.lang.String getNameSpacePrefix() {\r
 413     return _nsPrefix;\r
 414   }\r
 415 \r
 416   /**\r
 417    * Method getNameSpaceURI.\r
 418    * \r
 419    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 420    */\r
 421   public java.lang.String getNameSpaceURI() {\r
 422     return _nsURI;\r
 423   }\r
 424 \r
 425   /**\r
 426    * Method getValidator.\r
 427    * \r
 428    * @return a specific validator for the class described by this\r
 429    *         ClassDescriptor.\r
 430    */\r
 431   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 432     return this;\r
 433   }\r
 434 \r
 435   /**\r
 436    * Method getXMLName.\r
 437    * \r
 438    * @return the XML Name for the Class being described.\r
 439    */\r
 440   public java.lang.String getXMLName() {\r
 441     return _xmlName;\r
 442   }\r
 443 \r
 444   /**\r
 445    * Method isElementDefinition.\r
 446    * \r
 447    * @return true if XML schema definition of this Class is that of a global\r
 448    *         element or element with anonymous type definition.\r
 449    */\r
 450   public boolean isElementDefinition() {\r
 451     return _elementDefinition;\r
 452   }\r
 453 \r
 454 }\r