src/uk/ac/vamsas/objects/core/descriptors/DbRefDescriptor.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.DbRef;\r
  29 \r
  30 /**\r
  31  * Class DbRefDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class DbRefDescriptor 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 DbRefDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "dbRef";\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     // -- _source\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81         java.lang.String.class, "_source", "source",\r
  82         org.exolab.castor.xml.NodeType.Attribute);\r
  83     desc.setImmutable(true);\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         DbRef target = (DbRef) object;\r
  88         return target.getSource();\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           DbRef target = (DbRef) object;\r
  95           target.setSource((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 null;\r
 103       }\r
 104     };\r
 105     desc.setHandler(handler);\r
 106     desc.setRequired(true);\r
 107     desc.setMultivalued(false);\r
 108     addFieldDescriptor(desc);\r
 109 \r
 110     // -- validation code for: _source\r
 111     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 112     fieldValidator.setMinOccurs(1);\r
 113     { // -- local scope\r
 114       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 115       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 116       fieldValidator.setValidator(typeValidator);\r
 117       typeValidator.setWhiteSpace("preserve");\r
 118     }\r
 119     desc.setValidator(fieldValidator);\r
 120     // -- _version\r
 121     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 122         java.lang.String.class, "_version", "version",\r
 123         org.exolab.castor.xml.NodeType.Attribute);\r
 124     desc.setImmutable(true);\r
 125     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 126       public java.lang.Object getValue(java.lang.Object object)\r
 127           throws IllegalStateException {\r
 128         DbRef target = (DbRef) object;\r
 129         return target.getVersion();\r
 130       }\r
 131 \r
 132       public void setValue(java.lang.Object object, java.lang.Object value)\r
 133           throws IllegalStateException, IllegalArgumentException {\r
 134         try {\r
 135           DbRef target = (DbRef) object;\r
 136           target.setVersion((java.lang.String) value);\r
 137         } catch (java.lang.Exception ex) {\r
 138           throw new IllegalStateException(ex.toString());\r
 139         }\r
 140       }\r
 141 \r
 142       public java.lang.Object newInstance(java.lang.Object parent) {\r
 143         return null;\r
 144       }\r
 145     };\r
 146     desc.setHandler(handler);\r
 147     desc.setRequired(true);\r
 148     desc.setMultivalued(false);\r
 149     addFieldDescriptor(desc);\r
 150 \r
 151     // -- validation code for: _version\r
 152     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 153     fieldValidator.setMinOccurs(1);\r
 154     { // -- local scope\r
 155       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 156       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 157       fieldValidator.setValidator(typeValidator);\r
 158       typeValidator.setWhiteSpace("preserve");\r
 159     }\r
 160     desc.setValidator(fieldValidator);\r
 161     // -- _accessionId\r
 162     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 163         java.lang.String.class, "_accessionId", "accessionId",\r
 164         org.exolab.castor.xml.NodeType.Attribute);\r
 165     desc.setImmutable(true);\r
 166     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 167       public java.lang.Object getValue(java.lang.Object object)\r
 168           throws IllegalStateException {\r
 169         DbRef target = (DbRef) object;\r
 170         return target.getAccessionId();\r
 171       }\r
 172 \r
 173       public void setValue(java.lang.Object object, java.lang.Object value)\r
 174           throws IllegalStateException, IllegalArgumentException {\r
 175         try {\r
 176           DbRef target = (DbRef) object;\r
 177           target.setAccessionId((java.lang.String) value);\r
 178         } catch (java.lang.Exception ex) {\r
 179           throw new IllegalStateException(ex.toString());\r
 180         }\r
 181       }\r
 182 \r
 183       public java.lang.Object newInstance(java.lang.Object parent) {\r
 184         return null;\r
 185       }\r
 186     };\r
 187     desc.setHandler(handler);\r
 188     desc.setRequired(true);\r
 189     desc.setMultivalued(false);\r
 190     addFieldDescriptor(desc);\r
 191 \r
 192     // -- validation code for: _accessionId\r
 193     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 194     fieldValidator.setMinOccurs(1);\r
 195     { // -- local scope\r
 196       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 197       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 198       fieldValidator.setValidator(typeValidator);\r
 199       typeValidator.setWhiteSpace("preserve");\r
 200     }\r
 201     desc.setValidator(fieldValidator);\r
 202     // -- _id\r
 203     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 204         java.lang.String.class, "_id", "id",\r
 205         org.exolab.castor.xml.NodeType.Attribute);\r
 206     super.setIdentity(desc);\r
 207     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 208       public java.lang.Object getValue(java.lang.Object object)\r
 209           throws IllegalStateException {\r
 210         DbRef target = (DbRef) object;\r
 211         return target.getId();\r
 212       }\r
 213 \r
 214       public void setValue(java.lang.Object object, java.lang.Object value)\r
 215           throws IllegalStateException, IllegalArgumentException {\r
 216         try {\r
 217           DbRef target = (DbRef) object;\r
 218           target.setId((java.lang.String) value);\r
 219         } catch (java.lang.Exception ex) {\r
 220           throw new IllegalStateException(ex.toString());\r
 221         }\r
 222       }\r
 223 \r
 224       public java.lang.Object newInstance(java.lang.Object parent) {\r
 225         return new java.lang.String();\r
 226       }\r
 227     };\r
 228     desc.setHandler(handler);\r
 229     desc.setMultivalued(false);\r
 230     addFieldDescriptor(desc);\r
 231 \r
 232     // -- validation code for: _id\r
 233     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 234     { // -- local scope\r
 235       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 236       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 237       fieldValidator.setValidator(typeValidator);\r
 238     }\r
 239     desc.setValidator(fieldValidator);\r
 240     // -- initialize element descriptors\r
 241 \r
 242     // -- _mapList\r
 243     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 244         uk.ac.vamsas.objects.core.Map.class, "_mapList", "map",\r
 245         org.exolab.castor.xml.NodeType.Element);\r
 246     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 247       public java.lang.Object getValue(java.lang.Object object)\r
 248           throws IllegalStateException {\r
 249         DbRef target = (DbRef) object;\r
 250         return target.getMap();\r
 251       }\r
 252 \r
 253       public void setValue(java.lang.Object object, java.lang.Object value)\r
 254           throws IllegalStateException, IllegalArgumentException {\r
 255         try {\r
 256           DbRef target = (DbRef) object;\r
 257           target.addMap((uk.ac.vamsas.objects.core.Map) value);\r
 258         } catch (java.lang.Exception ex) {\r
 259           throw new IllegalStateException(ex.toString());\r
 260         }\r
 261       }\r
 262 \r
 263       public void resetValue(Object object) throws IllegalStateException,\r
 264           IllegalArgumentException {\r
 265         try {\r
 266           DbRef target = (DbRef) object;\r
 267           target.removeAllMap();\r
 268         } catch (java.lang.Exception ex) {\r
 269           throw new IllegalStateException(ex.toString());\r
 270         }\r
 271       }\r
 272 \r
 273       public java.lang.Object newInstance(java.lang.Object parent) {\r
 274         return new uk.ac.vamsas.objects.core.Map();\r
 275       }\r
 276     };\r
 277     desc.setHandler(handler);\r
 278     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 279     desc.setMultivalued(true);\r
 280     addFieldDescriptor(desc);\r
 281 \r
 282     // -- validation code for: _mapList\r
 283     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 284     fieldValidator.setMinOccurs(0);\r
 285     { // -- local scope\r
 286     }\r
 287     desc.setValidator(fieldValidator);\r
 288     // -- _linkList\r
 289     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 290         uk.ac.vamsas.objects.core.Link.class, "_linkList", "link",\r
 291         org.exolab.castor.xml.NodeType.Element);\r
 292     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 293       public java.lang.Object getValue(java.lang.Object object)\r
 294           throws IllegalStateException {\r
 295         DbRef target = (DbRef) object;\r
 296         return target.getLink();\r
 297       }\r
 298 \r
 299       public void setValue(java.lang.Object object, java.lang.Object value)\r
 300           throws IllegalStateException, IllegalArgumentException {\r
 301         try {\r
 302           DbRef target = (DbRef) object;\r
 303           target.addLink((uk.ac.vamsas.objects.core.Link) value);\r
 304         } catch (java.lang.Exception ex) {\r
 305           throw new IllegalStateException(ex.toString());\r
 306         }\r
 307       }\r
 308 \r
 309       public void resetValue(Object object) throws IllegalStateException,\r
 310           IllegalArgumentException {\r
 311         try {\r
 312           DbRef target = (DbRef) object;\r
 313           target.removeAllLink();\r
 314         } catch (java.lang.Exception ex) {\r
 315           throw new IllegalStateException(ex.toString());\r
 316         }\r
 317       }\r
 318 \r
 319       public java.lang.Object newInstance(java.lang.Object parent) {\r
 320         return new uk.ac.vamsas.objects.core.Link();\r
 321       }\r
 322     };\r
 323     desc.setHandler(handler);\r
 324     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 325     desc.setMultivalued(true);\r
 326     addFieldDescriptor(desc);\r
 327 \r
 328     // -- validation code for: _linkList\r
 329     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 330     fieldValidator.setMinOccurs(0);\r
 331     { // -- local scope\r
 332     }\r
 333     desc.setValidator(fieldValidator);\r
 334     // -- _propertyList\r
 335     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 336         uk.ac.vamsas.objects.core.Property.class, "_propertyList", "property",\r
 337         org.exolab.castor.xml.NodeType.Element);\r
 338     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 339       public java.lang.Object getValue(java.lang.Object object)\r
 340           throws IllegalStateException {\r
 341         DbRef target = (DbRef) object;\r
 342         return target.getProperty();\r
 343       }\r
 344 \r
 345       public void setValue(java.lang.Object object, java.lang.Object value)\r
 346           throws IllegalStateException, IllegalArgumentException {\r
 347         try {\r
 348           DbRef target = (DbRef) object;\r
 349           target.addProperty((uk.ac.vamsas.objects.core.Property) value);\r
 350         } catch (java.lang.Exception ex) {\r
 351           throw new IllegalStateException(ex.toString());\r
 352         }\r
 353       }\r
 354 \r
 355       public void resetValue(Object object) throws IllegalStateException,\r
 356           IllegalArgumentException {\r
 357         try {\r
 358           DbRef target = (DbRef) object;\r
 359           target.removeAllProperty();\r
 360         } catch (java.lang.Exception ex) {\r
 361           throw new IllegalStateException(ex.toString());\r
 362         }\r
 363       }\r
 364 \r
 365       public java.lang.Object newInstance(java.lang.Object parent) {\r
 366         return new uk.ac.vamsas.objects.core.Property();\r
 367       }\r
 368     };\r
 369     desc.setHandler(handler);\r
 370     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 371     desc.setMultivalued(true);\r
 372     addFieldDescriptor(desc);\r
 373 \r
 374     // -- validation code for: _propertyList\r
 375     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 376     fieldValidator.setMinOccurs(0);\r
 377     { // -- local scope\r
 378     }\r
 379     desc.setValidator(fieldValidator);\r
 380   }\r
 381 \r
 382   // -----------/\r
 383   // - Methods -/\r
 384   // -----------/\r
 385 \r
 386   /**\r
 387    * Method getAccessMode.\r
 388    * \r
 389    * @return the access mode specified for this class.\r
 390    */\r
 391   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 392     return null;\r
 393   }\r
 394 \r
 395   /**\r
 396    * Method getIdentity.\r
 397    * \r
 398    * @return the identity field, null if this class has no identity.\r
 399    */\r
 400   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 401     return super.getIdentity();\r
 402   }\r
 403 \r
 404   /**\r
 405    * Method getJavaClass.\r
 406    * \r
 407    * @return the Java class represented by this descriptor.\r
 408    */\r
 409   public java.lang.Class getJavaClass() {\r
 410     return uk.ac.vamsas.objects.core.DbRef.class;\r
 411   }\r
 412 \r
 413   /**\r
 414    * Method getNameSpacePrefix.\r
 415    * \r
 416    * @return the namespace prefix to use when marshaling as XML.\r
 417    */\r
 418   public java.lang.String getNameSpacePrefix() {\r
 419     return _nsPrefix;\r
 420   }\r
 421 \r
 422   /**\r
 423    * Method getNameSpaceURI.\r
 424    * \r
 425    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 426    */\r
 427   public java.lang.String getNameSpaceURI() {\r
 428     return _nsURI;\r
 429   }\r
 430 \r
 431   /**\r
 432    * Method getValidator.\r
 433    * \r
 434    * @return a specific validator for the class described by this\r
 435    *         ClassDescriptor.\r
 436    */\r
 437   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 438     return this;\r
 439   }\r
 440 \r
 441   /**\r
 442    * Method getXMLName.\r
 443    * \r
 444    * @return the XML Name for the Class being described.\r
 445    */\r
 446   public java.lang.String getXMLName() {\r
 447     return _xmlName;\r
 448   }\r
 449 \r
 450   /**\r
 451    * Method isElementDefinition.\r
 452    * \r
 453    * @return true if XML schema definition of this Class is that of a global\r
 454    *         element or element with anonymous type definition.\r
 455    */\r
 456   public boolean isElementDefinition() {\r
 457     return _elementDefinition;\r
 458   }\r
 459 \r
 460 }\r