src/uk/ac/vamsas/objects/core/descriptors/VamsasDocumentDescriptor.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.VamsasDocument;\r
  29 \r
  30 /**\r
  31  * Class VamsasDocumentDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class VamsasDocumentDescriptor 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 VamsasDocumentDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument";\r
  69     _xmlName = "VamsasDocument";\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     // -- initialize element descriptors\r
  80 \r
  81     // -- _version\r
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  83         java.lang.String.class, "_version", "Version",\r
  84         org.exolab.castor.xml.NodeType.Element);\r
  85     desc.setImmutable(true);\r
  86     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  87       public java.lang.Object getValue(java.lang.Object object)\r
  88           throws IllegalStateException {\r
  89         VamsasDocument target = (VamsasDocument) object;\r
  90         return target.getVersion();\r
  91       }\r
  92 \r
  93       public void setValue(java.lang.Object object, java.lang.Object value)\r
  94           throws IllegalStateException, IllegalArgumentException {\r
  95         try {\r
  96           VamsasDocument target = (VamsasDocument) object;\r
  97           target.setVersion((java.lang.String) value);\r
  98         } catch (java.lang.Exception ex) {\r
  99           throw new IllegalStateException(ex.toString());\r
 100         }\r
 101       }\r
 102 \r
 103       public java.lang.Object newInstance(java.lang.Object parent) {\r
 104         return null;\r
 105       }\r
 106     };\r
 107     desc.setHandler(handler);\r
 108     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument");\r
 109     desc.setRequired(true);\r
 110     desc.setMultivalued(false);\r
 111     addFieldDescriptor(desc);\r
 112 \r
 113     // -- validation code for: _version\r
 114     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 115     fieldValidator.setMinOccurs(1);\r
 116     { // -- local scope\r
 117       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 118       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 119       fieldValidator.setValidator(typeValidator);\r
 120       typeValidator.setWhiteSpace("preserve");\r
 121     }\r
 122     desc.setValidator(fieldValidator);\r
 123     // -- _lockFile\r
 124     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 125         uk.ac.vamsas.objects.core.LockFile.class, "_lockFile", "LockFile",\r
 126         org.exolab.castor.xml.NodeType.Element);\r
 127     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 128       public java.lang.Object getValue(java.lang.Object object)\r
 129           throws IllegalStateException {\r
 130         VamsasDocument target = (VamsasDocument) object;\r
 131         return target.getLockFile();\r
 132       }\r
 133 \r
 134       public void setValue(java.lang.Object object, java.lang.Object value)\r
 135           throws IllegalStateException, IllegalArgumentException {\r
 136         try {\r
 137           VamsasDocument target = (VamsasDocument) object;\r
 138           target.setLockFile((uk.ac.vamsas.objects.core.LockFile) value);\r
 139         } catch (java.lang.Exception ex) {\r
 140           throw new IllegalStateException(ex.toString());\r
 141         }\r
 142       }\r
 143 \r
 144       public java.lang.Object newInstance(java.lang.Object parent) {\r
 145         return new uk.ac.vamsas.objects.core.LockFile();\r
 146       }\r
 147     };\r
 148     desc.setHandler(handler);\r
 149     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasDocument");\r
 150     desc.setMultivalued(false);\r
 151     addFieldDescriptor(desc);\r
 152 \r
 153     // -- validation code for: _lockFile\r
 154     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 155     { // -- local scope\r
 156     }\r
 157     desc.setValidator(fieldValidator);\r
 158     // -- _provenance\r
 159     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 160         uk.ac.vamsas.objects.core.Provenance.class, "_provenance",\r
 161         "Provenance", org.exolab.castor.xml.NodeType.Element);\r
 162     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 163       public java.lang.Object getValue(java.lang.Object object)\r
 164           throws IllegalStateException {\r
 165         VamsasDocument target = (VamsasDocument) object;\r
 166         return target.getProvenance();\r
 167       }\r
 168 \r
 169       public void setValue(java.lang.Object object, java.lang.Object value)\r
 170           throws IllegalStateException, IllegalArgumentException {\r
 171         try {\r
 172           VamsasDocument target = (VamsasDocument) object;\r
 173           target.setProvenance((uk.ac.vamsas.objects.core.Provenance) value);\r
 174         } catch (java.lang.Exception ex) {\r
 175           throw new IllegalStateException(ex.toString());\r
 176         }\r
 177       }\r
 178 \r
 179       public java.lang.Object newInstance(java.lang.Object parent) {\r
 180         return new uk.ac.vamsas.objects.core.Provenance();\r
 181       }\r
 182     };\r
 183     desc.setHandler(handler);\r
 184     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 185     desc.setMultivalued(false);\r
 186     addFieldDescriptor(desc);\r
 187 \r
 188     // -- validation code for: _provenance\r
 189     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 190     { // -- local scope\r
 191     }\r
 192     desc.setValidator(fieldValidator);\r
 193     // -- _VAMSASList\r
 194     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 195         uk.ac.vamsas.objects.core.VAMSAS.class, "_VAMSASList", "VAMSAS",\r
 196         org.exolab.castor.xml.NodeType.Element);\r
 197     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 198       public java.lang.Object getValue(java.lang.Object object)\r
 199           throws IllegalStateException {\r
 200         VamsasDocument target = (VamsasDocument) object;\r
 201         return target.getVAMSAS();\r
 202       }\r
 203 \r
 204       public void setValue(java.lang.Object object, java.lang.Object value)\r
 205           throws IllegalStateException, IllegalArgumentException {\r
 206         try {\r
 207           VamsasDocument target = (VamsasDocument) object;\r
 208           target.addVAMSAS((uk.ac.vamsas.objects.core.VAMSAS) value);\r
 209         } catch (java.lang.Exception ex) {\r
 210           throw new IllegalStateException(ex.toString());\r
 211         }\r
 212       }\r
 213 \r
 214       public void resetValue(Object object) throws IllegalStateException,\r
 215           IllegalArgumentException {\r
 216         try {\r
 217           VamsasDocument target = (VamsasDocument) object;\r
 218           target.removeAllVAMSAS();\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 uk.ac.vamsas.objects.core.VAMSAS();\r
 226       }\r
 227     };\r
 228     desc.setHandler(handler);\r
 229     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 230     desc.setRequired(true);\r
 231     desc.setMultivalued(true);\r
 232     addFieldDescriptor(desc);\r
 233 \r
 234     // -- validation code for: _VAMSASList\r
 235     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 236     fieldValidator.setMinOccurs(1);\r
 237     { // -- local scope\r
 238     }\r
 239     desc.setValidator(fieldValidator);\r
 240     // -- _applicationDataList\r
 241     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 242         uk.ac.vamsas.objects.core.ApplicationData.class,\r
 243         "_applicationDataList", "ApplicationData",\r
 244         org.exolab.castor.xml.NodeType.Element);\r
 245     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 246       public java.lang.Object getValue(java.lang.Object object)\r
 247           throws IllegalStateException {\r
 248         VamsasDocument target = (VamsasDocument) object;\r
 249         return target.getApplicationData();\r
 250       }\r
 251 \r
 252       public void setValue(java.lang.Object object, java.lang.Object value)\r
 253           throws IllegalStateException, IllegalArgumentException {\r
 254         try {\r
 255           VamsasDocument target = (VamsasDocument) object;\r
 256           target\r
 257               .addApplicationData((uk.ac.vamsas.objects.core.ApplicationData) 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           VamsasDocument target = (VamsasDocument) object;\r
 267           target.removeAllApplicationData();\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.ApplicationData();\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: _applicationDataList\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     // -- _attachmentList\r
 289     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 290         uk.ac.vamsas.objects.core.Attachment.class, "_attachmentList",\r
 291         "Attachment", 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         VamsasDocument target = (VamsasDocument) object;\r
 296         return target.getAttachment();\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           VamsasDocument target = (VamsasDocument) object;\r
 303           target.addAttachment((uk.ac.vamsas.objects.core.Attachment) 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           VamsasDocument target = (VamsasDocument) object;\r
 313           target.removeAllAttachment();\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.Attachment();\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: _attachmentList\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   }\r
 335 \r
 336   // -----------/\r
 337   // - Methods -/\r
 338   // -----------/\r
 339 \r
 340   /**\r
 341    * Method getAccessMode.\r
 342    * \r
 343    * @return the access mode specified for this class.\r
 344    */\r
 345   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 346     return null;\r
 347   }\r
 348 \r
 349   /**\r
 350    * Method getIdentity.\r
 351    * \r
 352    * @return the identity field, null if this class has no identity.\r
 353    */\r
 354   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 355     return super.getIdentity();\r
 356   }\r
 357 \r
 358   /**\r
 359    * Method getJavaClass.\r
 360    * \r
 361    * @return the Java class represented by this descriptor.\r
 362    */\r
 363   public java.lang.Class getJavaClass() {\r
 364     return uk.ac.vamsas.objects.core.VamsasDocument.class;\r
 365   }\r
 366 \r
 367   /**\r
 368    * Method getNameSpacePrefix.\r
 369    * \r
 370    * @return the namespace prefix to use when marshaling as XML.\r
 371    */\r
 372   public java.lang.String getNameSpacePrefix() {\r
 373     return _nsPrefix;\r
 374   }\r
 375 \r
 376   /**\r
 377    * Method getNameSpaceURI.\r
 378    * \r
 379    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 380    */\r
 381   public java.lang.String getNameSpaceURI() {\r
 382     return _nsURI;\r
 383   }\r
 384 \r
 385   /**\r
 386    * Method getValidator.\r
 387    * \r
 388    * @return a specific validator for the class described by this\r
 389    *         ClassDescriptor.\r
 390    */\r
 391   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 392     return this;\r
 393   }\r
 394 \r
 395   /**\r
 396    * Method getXMLName.\r
 397    * \r
 398    * @return the XML Name for the Class being described.\r
 399    */\r
 400   public java.lang.String getXMLName() {\r
 401     return _xmlName;\r
 402   }\r
 403 \r
 404   /**\r
 405    * Method isElementDefinition.\r
 406    * \r
 407    * @return true if XML schema definition of this Class is that of a global\r
 408    *         element or element with anonymous type definition.\r
 409    */\r
 410   public boolean isElementDefinition() {\r
 411     return _elementDefinition;\r
 412   }\r
 413 \r
 414 }\r