src/uk/ac/vamsas/objects/core/descriptors/NodeTypeDescriptor.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.NodeType;\r
  29 \r
  30 /**\r
  31  * Class NodeTypeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class NodeTypeDescriptor 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 NodeTypeDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "nodeType";\r
  70     _elementDefinition = false;\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         NodeType target = (NodeType) 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           NodeType target = (NodeType) 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         NodeType target = (NodeType) 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           NodeType target = (NodeType) 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     // -- _name\r
 159     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 160         java.lang.String.class, "_name", "name",\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         NodeType target = (NodeType) object;\r
 167         return target.getName();\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           NodeType target = (NodeType) object;\r
 174           target.setName((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: _name\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     // -- _description\r
 199     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 200         java.lang.String.class, "_description", "description",\r
 201         org.exolab.castor.xml.NodeType.Element);\r
 202     desc.setImmutable(true);\r
 203     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 204       public java.lang.Object getValue(java.lang.Object object)\r
 205           throws IllegalStateException {\r
 206         NodeType target = (NodeType) object;\r
 207         return target.getDescription();\r
 208       }\r
 209 \r
 210       public void setValue(java.lang.Object object, java.lang.Object value)\r
 211           throws IllegalStateException, IllegalArgumentException {\r
 212         try {\r
 213           NodeType target = (NodeType) object;\r
 214           target.setDescription((java.lang.String) value);\r
 215         } catch (java.lang.Exception ex) {\r
 216           throw new IllegalStateException(ex.toString());\r
 217         }\r
 218       }\r
 219 \r
 220       public java.lang.Object newInstance(java.lang.Object parent) {\r
 221         return null;\r
 222       }\r
 223     };\r
 224     desc.setHandler(handler);\r
 225     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 226     desc.setMultivalued(false);\r
 227     addFieldDescriptor(desc);\r
 228 \r
 229     // -- validation code for: _description\r
 230     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 231     { // -- local scope\r
 232       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 233       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 234       fieldValidator.setValidator(typeValidator);\r
 235       typeValidator.setWhiteSpace("preserve");\r
 236     }\r
 237     desc.setValidator(fieldValidator);\r
 238     // -- _vrefList\r
 239     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 240         uk.ac.vamsas.objects.core.Vref.class, "_vrefList", "vref",\r
 241         org.exolab.castor.xml.NodeType.Element);\r
 242     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 243       public java.lang.Object getValue(java.lang.Object object)\r
 244           throws IllegalStateException {\r
 245         NodeType target = (NodeType) object;\r
 246         return target.getVref();\r
 247       }\r
 248 \r
 249       public void setValue(java.lang.Object object, java.lang.Object value)\r
 250           throws IllegalStateException, IllegalArgumentException {\r
 251         try {\r
 252           NodeType target = (NodeType) object;\r
 253           target.addVref((uk.ac.vamsas.objects.core.Vref) value);\r
 254         } catch (java.lang.Exception ex) {\r
 255           throw new IllegalStateException(ex.toString());\r
 256         }\r
 257       }\r
 258 \r
 259       public void resetValue(Object object) throws IllegalStateException,\r
 260           IllegalArgumentException {\r
 261         try {\r
 262           NodeType target = (NodeType) object;\r
 263           target.removeAllVref();\r
 264         } catch (java.lang.Exception ex) {\r
 265           throw new IllegalStateException(ex.toString());\r
 266         }\r
 267       }\r
 268 \r
 269       public java.lang.Object newInstance(java.lang.Object parent) {\r
 270         return new uk.ac.vamsas.objects.core.Vref();\r
 271       }\r
 272     };\r
 273     desc.setHandler(handler);\r
 274     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 275     desc.setMultivalued(true);\r
 276     addFieldDescriptor(desc);\r
 277 \r
 278     // -- validation code for: _vrefList\r
 279     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 280     fieldValidator.setMinOccurs(0);\r
 281     { // -- local scope\r
 282     }\r
 283     desc.setValidator(fieldValidator);\r
 284     // -- _propertyList\r
 285     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 286         uk.ac.vamsas.objects.core.Property.class, "_propertyList", "property",\r
 287         org.exolab.castor.xml.NodeType.Element);\r
 288     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 289       public java.lang.Object getValue(java.lang.Object object)\r
 290           throws IllegalStateException {\r
 291         NodeType target = (NodeType) object;\r
 292         return target.getProperty();\r
 293       }\r
 294 \r
 295       public void setValue(java.lang.Object object, java.lang.Object value)\r
 296           throws IllegalStateException, IllegalArgumentException {\r
 297         try {\r
 298           NodeType target = (NodeType) object;\r
 299           target.addProperty((uk.ac.vamsas.objects.core.Property) value);\r
 300         } catch (java.lang.Exception ex) {\r
 301           throw new IllegalStateException(ex.toString());\r
 302         }\r
 303       }\r
 304 \r
 305       public void resetValue(Object object) throws IllegalStateException,\r
 306           IllegalArgumentException {\r
 307         try {\r
 308           NodeType target = (NodeType) object;\r
 309           target.removeAllProperty();\r
 310         } catch (java.lang.Exception ex) {\r
 311           throw new IllegalStateException(ex.toString());\r
 312         }\r
 313       }\r
 314 \r
 315       public java.lang.Object newInstance(java.lang.Object parent) {\r
 316         return new uk.ac.vamsas.objects.core.Property();\r
 317       }\r
 318     };\r
 319     desc.setHandler(handler);\r
 320     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 321     desc.setMultivalued(true);\r
 322     addFieldDescriptor(desc);\r
 323 \r
 324     // -- validation code for: _propertyList\r
 325     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 326     fieldValidator.setMinOccurs(0);\r
 327     { // -- local scope\r
 328     }\r
 329     desc.setValidator(fieldValidator);\r
 330   }\r
 331 \r
 332   // -----------/\r
 333   // - Methods -/\r
 334   // -----------/\r
 335 \r
 336   /**\r
 337    * Method getAccessMode.\r
 338    * \r
 339    * @return the access mode specified for this class.\r
 340    */\r
 341   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 342     return null;\r
 343   }\r
 344 \r
 345   /**\r
 346    * Method getIdentity.\r
 347    * \r
 348    * @return the identity field, null if this class has no identity.\r
 349    */\r
 350   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 351     return super.getIdentity();\r
 352   }\r
 353 \r
 354   /**\r
 355    * Method getJavaClass.\r
 356    * \r
 357    * @return the Java class represented by this descriptor.\r
 358    */\r
 359   public java.lang.Class getJavaClass() {\r
 360     return uk.ac.vamsas.objects.core.NodeType.class;\r
 361   }\r
 362 \r
 363   /**\r
 364    * Method getNameSpacePrefix.\r
 365    * \r
 366    * @return the namespace prefix to use when marshaling as XML.\r
 367    */\r
 368   public java.lang.String getNameSpacePrefix() {\r
 369     return _nsPrefix;\r
 370   }\r
 371 \r
 372   /**\r
 373    * Method getNameSpaceURI.\r
 374    * \r
 375    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 376    */\r
 377   public java.lang.String getNameSpaceURI() {\r
 378     return _nsURI;\r
 379   }\r
 380 \r
 381   /**\r
 382    * Method getValidator.\r
 383    * \r
 384    * @return a specific validator for the class described by this\r
 385    *         ClassDescriptor.\r
 386    */\r
 387   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 388     return this;\r
 389   }\r
 390 \r
 391   /**\r
 392    * Method getXMLName.\r
 393    * \r
 394    * @return the XML Name for the Class being described.\r
 395    */\r
 396   public java.lang.String getXMLName() {\r
 397     return _xmlName;\r
 398   }\r
 399 \r
 400   /**\r
 401    * Method isElementDefinition.\r
 402    * \r
 403    * @return true if XML schema definition of this Class is that of a global\r
 404    *         element or element with anonymous type definition.\r
 405    */\r
 406   public boolean isElementDefinition() {\r
 407     return _elementDefinition;\r
 408   }\r
 409 \r
 410 }\r