src/jalview/schemabinding/version2/descriptors/JalviewModelDescriptor.java

   1 /*\r
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6)\r
   3  * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle\r
   4  * \r
   5  * This file is part of Jalview.\r
   6  * \r
   7  * Jalview is free software: you can redistribute it and/or\r
   8  * modify it under the terms of the GNU General Public License \r
   9  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
  10  * \r
  11  * Jalview is distributed in the hope that it will be useful, but \r
  12  * WITHOUT ANY WARRANTY; without even the implied warranty \r
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
  14  * PURPOSE.  See the GNU General Public License for more details.\r
  15  * \r
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
  17  */\r
  18 package jalview.schemabinding.version2.descriptors;\r
  19 \r
  20 //---------------------------------/\r
  21 //- Imported classes and packages -/\r
  22 //---------------------------------/\r
  23 \r
  24 import jalview.schemabinding.version2.JalviewModel;\r
  25 \r
  26 /**\r
  27  * Class JalviewModelDescriptor.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class JalviewModelDescriptor extends\r
  32         org.exolab.castor.xml.util.XMLClassDescriptorImpl\r
  33 {\r
  34 \r
  35   // --------------------------/\r
  36   // - Class/Member Variables -/\r
  37   // --------------------------/\r
  38 \r
  39   /**\r
  40    * Field _elementDefinition.\r
  41    */\r
  42   private boolean _elementDefinition;\r
  43 \r
  44   /**\r
  45    * Field _nsPrefix.\r
  46    */\r
  47   private java.lang.String _nsPrefix;\r
  48 \r
  49   /**\r
  50    * Field _nsURI.\r
  51    */\r
  52   private java.lang.String _nsURI;\r
  53 \r
  54   /**\r
  55    * Field _xmlName.\r
  56    */\r
  57   private java.lang.String _xmlName;\r
  58 \r
  59   // ----------------/\r
  60   // - Constructors -/\r
  61   // ----------------/\r
  62 \r
  63   public JalviewModelDescriptor()\r
  64   {\r
  65     super();\r
  66     _nsURI = "www.jalview.org";\r
  67     _xmlName = "JalviewModel";\r
  68     _elementDefinition = false;\r
  69 \r
  70     // -- set grouping compositor\r
  71     setCompositorAsSequence();\r
  72     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  73     org.exolab.castor.mapping.FieldHandler handler = null;\r
  74     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  75     // -- initialize attribute descriptors\r
  76 \r
  77     // -- initialize element descriptors\r
  78 \r
  79     // -- _creationDate\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81             java.util.Date.class, "_creationDate", "creationDate",\r
  82             org.exolab.castor.xml.NodeType.Element);\r
  83     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
  84     {\r
  85       public java.lang.Object getValue(java.lang.Object object)\r
  86               throws IllegalStateException\r
  87       {\r
  88         JalviewModel target = (JalviewModel) object;\r
  89         return target.getCreationDate();\r
  90       }\r
  91 \r
  92       public void setValue(java.lang.Object object, java.lang.Object value)\r
  93               throws IllegalStateException, IllegalArgumentException\r
  94       {\r
  95         try\r
  96         {\r
  97           JalviewModel target = (JalviewModel) object;\r
  98           target.setCreationDate((java.util.Date) value);\r
  99         } catch (java.lang.Exception ex)\r
 100         {\r
 101           throw new IllegalStateException(ex.toString());\r
 102         }\r
 103       }\r
 104 \r
 105       public java.lang.Object newInstance(java.lang.Object parent)\r
 106       {\r
 107         return new java.util.Date();\r
 108       }\r
 109     };\r
 110     handler = new org.exolab.castor.xml.handlers.DateFieldHandler(handler);\r
 111     desc.setImmutable(true);\r
 112     desc.setHandler(handler);\r
 113     desc.setNameSpaceURI("www.jalview.org");\r
 114     desc.setRequired(true);\r
 115     desc.setMultivalued(false);\r
 116     addFieldDescriptor(desc);\r
 117 \r
 118     // -- validation code for: _creationDate\r
 119     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 120     fieldValidator.setMinOccurs(1);\r
 121     { // -- local scope\r
 122       org.exolab.castor.xml.validators.DateTimeValidator typeValidator;\r
 123       typeValidator = new org.exolab.castor.xml.validators.DateTimeValidator();\r
 124       fieldValidator.setValidator(typeValidator);\r
 125     }\r
 126     desc.setValidator(fieldValidator);\r
 127     // -- _version\r
 128     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 129             java.lang.String.class, "_version", "version",\r
 130             org.exolab.castor.xml.NodeType.Element);\r
 131     desc.setImmutable(true);\r
 132     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
 133     {\r
 134       public java.lang.Object getValue(java.lang.Object object)\r
 135               throws IllegalStateException\r
 136       {\r
 137         JalviewModel target = (JalviewModel) object;\r
 138         return target.getVersion();\r
 139       }\r
 140 \r
 141       public void setValue(java.lang.Object object, java.lang.Object value)\r
 142               throws IllegalStateException, IllegalArgumentException\r
 143       {\r
 144         try\r
 145         {\r
 146           JalviewModel target = (JalviewModel) object;\r
 147           target.setVersion((java.lang.String) value);\r
 148         } catch (java.lang.Exception ex)\r
 149         {\r
 150           throw new IllegalStateException(ex.toString());\r
 151         }\r
 152       }\r
 153 \r
 154       public java.lang.Object newInstance(java.lang.Object parent)\r
 155       {\r
 156         return null;\r
 157       }\r
 158     };\r
 159     desc.setHandler(handler);\r
 160     desc.setNameSpaceURI("www.jalview.org");\r
 161     desc.setRequired(true);\r
 162     desc.setMultivalued(false);\r
 163     addFieldDescriptor(desc);\r
 164 \r
 165     // -- validation code for: _version\r
 166     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 167     fieldValidator.setMinOccurs(1);\r
 168     { // -- local scope\r
 169       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 170       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 171       fieldValidator.setValidator(typeValidator);\r
 172       typeValidator.setWhiteSpace("preserve");\r
 173     }\r
 174     desc.setValidator(fieldValidator);\r
 175     // -- _vamsasModel\r
 176     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 177             jalview.schemabinding.version2.VamsasModel.class,\r
 178             "_vamsasModel", "vamsasModel",\r
 179             org.exolab.castor.xml.NodeType.Element);\r
 180     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
 181     {\r
 182       public java.lang.Object getValue(java.lang.Object object)\r
 183               throws IllegalStateException\r
 184       {\r
 185         JalviewModel target = (JalviewModel) object;\r
 186         return target.getVamsasModel();\r
 187       }\r
 188 \r
 189       public void setValue(java.lang.Object object, java.lang.Object value)\r
 190               throws IllegalStateException, IllegalArgumentException\r
 191       {\r
 192         try\r
 193         {\r
 194           JalviewModel target = (JalviewModel) object;\r
 195           target.setVamsasModel((jalview.schemabinding.version2.VamsasModel) value);\r
 196         } catch (java.lang.Exception ex)\r
 197         {\r
 198           throw new IllegalStateException(ex.toString());\r
 199         }\r
 200       }\r
 201 \r
 202       public java.lang.Object newInstance(java.lang.Object parent)\r
 203       {\r
 204         return new jalview.schemabinding.version2.VamsasModel();\r
 205       }\r
 206     };\r
 207     desc.setHandler(handler);\r
 208     desc.setNameSpaceURI("www.jalview.org");\r
 209     desc.setRequired(true);\r
 210     desc.setMultivalued(false);\r
 211     addFieldDescriptor(desc);\r
 212 \r
 213     // -- validation code for: _vamsasModel\r
 214     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 215     fieldValidator.setMinOccurs(1);\r
 216     { // -- local scope\r
 217     }\r
 218     desc.setValidator(fieldValidator);\r
 219     // -- _jalviewModelSequence\r
 220     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 221             jalview.schemabinding.version2.JalviewModelSequence.class,\r
 222             "_jalviewModelSequence", "-error-if-this-is-used-",\r
 223             org.exolab.castor.xml.NodeType.Element);\r
 224     handler = new org.exolab.castor.xml.XMLFieldHandler()\r
 225     {\r
 226       public java.lang.Object getValue(java.lang.Object object)\r
 227               throws IllegalStateException\r
 228       {\r
 229         JalviewModel target = (JalviewModel) object;\r
 230         return target.getJalviewModelSequence();\r
 231       }\r
 232 \r
 233       public void setValue(java.lang.Object object, java.lang.Object value)\r
 234               throws IllegalStateException, IllegalArgumentException\r
 235       {\r
 236         try\r
 237         {\r
 238           JalviewModel target = (JalviewModel) object;\r
 239           target.setJalviewModelSequence((jalview.schemabinding.version2.JalviewModelSequence) value);\r
 240         } catch (java.lang.Exception ex)\r
 241         {\r
 242           throw new IllegalStateException(ex.toString());\r
 243         }\r
 244       }\r
 245 \r
 246       public java.lang.Object newInstance(java.lang.Object parent)\r
 247       {\r
 248         return new jalview.schemabinding.version2.JalviewModelSequence();\r
 249       }\r
 250     };\r
 251     desc.setHandler(handler);\r
 252     desc.setContainer(true);\r
 253     desc.setClassDescriptor(new jalview.schemabinding.version2.descriptors.JalviewModelSequenceDescriptor());\r
 254     desc.setNameSpaceURI("www.jalview.org");\r
 255     desc.setRequired(true);\r
 256     desc.setMultivalued(false);\r
 257     addFieldDescriptor(desc);\r
 258 \r
 259     // -- validation code for: _jalviewModelSequence\r
 260     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 261     fieldValidator.setMinOccurs(1);\r
 262     { // -- local scope\r
 263     }\r
 264     desc.setValidator(fieldValidator);\r
 265   }\r
 266 \r
 267   // -----------/\r
 268   // - Methods -/\r
 269   // -----------/\r
 270 \r
 271   /**\r
 272    * Method getAccessMode.\r
 273    * \r
 274    * @return the access mode specified for this class.\r
 275    */\r
 276   public org.exolab.castor.mapping.AccessMode getAccessMode()\r
 277   {\r
 278     return null;\r
 279   }\r
 280 \r
 281   /**\r
 282    * Method getIdentity.\r
 283    * \r
 284    * @return the identity field, null if this class has no identity.\r
 285    */\r
 286   public org.exolab.castor.mapping.FieldDescriptor getIdentity()\r
 287   {\r
 288     return super.getIdentity();\r
 289   }\r
 290 \r
 291   /**\r
 292    * Method getJavaClass.\r
 293    * \r
 294    * @return the Java class represented by this descriptor.\r
 295    */\r
 296   public java.lang.Class getJavaClass()\r
 297   {\r
 298     return jalview.schemabinding.version2.JalviewModel.class;\r
 299   }\r
 300 \r
 301   /**\r
 302    * Method getNameSpacePrefix.\r
 303    * \r
 304    * @return the namespace prefix to use when marshaling as XML.\r
 305    */\r
 306   public java.lang.String getNameSpacePrefix()\r
 307   {\r
 308     return _nsPrefix;\r
 309   }\r
 310 \r
 311   /**\r
 312    * Method getNameSpaceURI.\r
 313    * \r
 314    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 315    */\r
 316   public java.lang.String getNameSpaceURI()\r
 317   {\r
 318     return _nsURI;\r
 319   }\r
 320 \r
 321   /**\r
 322    * Method getValidator.\r
 323    * \r
 324    * @return a specific validator for the class described by this\r
 325    *         ClassDescriptor.\r
 326    */\r
 327   public org.exolab.castor.xml.TypeValidator getValidator()\r
 328   {\r
 329     return this;\r
 330   }\r
 331 \r
 332   /**\r
 333    * Method getXMLName.\r
 334    * \r
 335    * @return the XML Name for the Class being described.\r
 336    */\r
 337   public java.lang.String getXMLName()\r
 338   {\r
 339     return _xmlName;\r
 340   }\r
 341 \r
 342   /**\r
 343    * Method isElementDefinition.\r
 344    * \r
 345    * @return true if XML schema definition of this Class is that of a global\r
 346    *         element or element with anonymous type definition.\r
 347    */\r
 348   public boolean isElementDefinition()\r
 349   {\r
 350     return _elementDefinition;\r
 351   }\r
 352 \r
 353 }\r