src/uk/ac/vamsas/objects/core/descriptors/RangeDescriptor.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.Range;\r
  29 \r
  30 /**\r
  31  * Class RangeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class RangeDescriptor 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    * Field _identity.\r
  64    */\r
  65   private org.exolab.castor.xml.XMLFieldDescriptor _identity;\r
  66 \r
  67   // ----------------/\r
  68   // - Constructors -/\r
  69   // ----------------/\r
  70 \r
  71   public RangeDescriptor() {\r
  72     super();\r
  73     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  74     _xmlName = "range";\r
  75     _elementDefinition = true;\r
  76     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  77     org.exolab.castor.mapping.FieldHandler handler = null;\r
  78     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  79     // -- initialize attribute descriptors\r
  80 \r
  81     // -- _seqAStart\r
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  83         java.lang.Integer.TYPE, "_seqAStart", "seqAStart",\r
  84         org.exolab.castor.xml.NodeType.Attribute);\r
  85     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  86       public java.lang.Object getValue(java.lang.Object object)\r
  87           throws IllegalStateException {\r
  88         Range target = (Range) object;\r
  89         if (!target.hasSeqAStart()) {\r
  90           return null;\r
  91         }\r
  92         return new java.lang.Integer(target.getSeqAStart());\r
  93       }\r
  94 \r
  95       public void setValue(java.lang.Object object, java.lang.Object value)\r
  96           throws IllegalStateException, IllegalArgumentException {\r
  97         try {\r
  98           Range target = (Range) object;\r
  99           // if null, use delete method for optional primitives\r
 100           if (value == null) {\r
 101             target.deleteSeqAStart();\r
 102             return;\r
 103           }\r
 104           target.setSeqAStart(((java.lang.Integer) value).intValue());\r
 105         } catch (java.lang.Exception ex) {\r
 106           throw new IllegalStateException(ex.toString());\r
 107         }\r
 108       }\r
 109 \r
 110       public java.lang.Object newInstance(java.lang.Object parent) {\r
 111         return null;\r
 112       }\r
 113     };\r
 114     desc.setHandler(handler);\r
 115     desc.setMultivalued(false);\r
 116     addFieldDescriptor(desc);\r
 117 \r
 118     // -- validation code for: _seqAStart\r
 119     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 120     { // -- local scope\r
 121       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 122       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 123       fieldValidator.setValidator(typeValidator);\r
 124       typeValidator.setMinInclusive(-2147483648);\r
 125       typeValidator.setMaxInclusive(2147483647);\r
 126     }\r
 127     desc.setValidator(fieldValidator);\r
 128     // -- _seqAEnd\r
 129     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 130         java.lang.Integer.TYPE, "_seqAEnd", "seqAEnd",\r
 131         org.exolab.castor.xml.NodeType.Attribute);\r
 132     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 133       public java.lang.Object getValue(java.lang.Object object)\r
 134           throws IllegalStateException {\r
 135         Range target = (Range) object;\r
 136         if (!target.hasSeqAEnd()) {\r
 137           return null;\r
 138         }\r
 139         return new java.lang.Integer(target.getSeqAEnd());\r
 140       }\r
 141 \r
 142       public void setValue(java.lang.Object object, java.lang.Object value)\r
 143           throws IllegalStateException, IllegalArgumentException {\r
 144         try {\r
 145           Range target = (Range) object;\r
 146           // if null, use delete method for optional primitives\r
 147           if (value == null) {\r
 148             target.deleteSeqAEnd();\r
 149             return;\r
 150           }\r
 151           target.setSeqAEnd(((java.lang.Integer) value).intValue());\r
 152         } catch (java.lang.Exception ex) {\r
 153           throw new IllegalStateException(ex.toString());\r
 154         }\r
 155       }\r
 156 \r
 157       public java.lang.Object newInstance(java.lang.Object parent) {\r
 158         return null;\r
 159       }\r
 160     };\r
 161     desc.setHandler(handler);\r
 162     desc.setMultivalued(false);\r
 163     addFieldDescriptor(desc);\r
 164 \r
 165     // -- validation code for: _seqAEnd\r
 166     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 167     { // -- local scope\r
 168       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 169       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 170       fieldValidator.setValidator(typeValidator);\r
 171       typeValidator.setMinInclusive(-2147483648);\r
 172       typeValidator.setMaxInclusive(2147483647);\r
 173     }\r
 174     desc.setValidator(fieldValidator);\r
 175     // -- _seqBStart\r
 176     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 177         java.lang.Integer.TYPE, "_seqBStart", "seqBStart",\r
 178         org.exolab.castor.xml.NodeType.Attribute);\r
 179     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 180       public java.lang.Object getValue(java.lang.Object object)\r
 181           throws IllegalStateException {\r
 182         Range target = (Range) object;\r
 183         if (!target.hasSeqBStart()) {\r
 184           return null;\r
 185         }\r
 186         return new java.lang.Integer(target.getSeqBStart());\r
 187       }\r
 188 \r
 189       public void setValue(java.lang.Object object, java.lang.Object value)\r
 190           throws IllegalStateException, IllegalArgumentException {\r
 191         try {\r
 192           Range target = (Range) object;\r
 193           // if null, use delete method for optional primitives\r
 194           if (value == null) {\r
 195             target.deleteSeqBStart();\r
 196             return;\r
 197           }\r
 198           target.setSeqBStart(((java.lang.Integer) value).intValue());\r
 199         } catch (java.lang.Exception ex) {\r
 200           throw new IllegalStateException(ex.toString());\r
 201         }\r
 202       }\r
 203 \r
 204       public java.lang.Object newInstance(java.lang.Object parent) {\r
 205         return null;\r
 206       }\r
 207     };\r
 208     desc.setHandler(handler);\r
 209     desc.setMultivalued(false);\r
 210     addFieldDescriptor(desc);\r
 211 \r
 212     // -- validation code for: _seqBStart\r
 213     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 214     { // -- local scope\r
 215       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 216       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 217       fieldValidator.setValidator(typeValidator);\r
 218       typeValidator.setMinInclusive(-2147483648);\r
 219       typeValidator.setMaxInclusive(2147483647);\r
 220     }\r
 221     desc.setValidator(fieldValidator);\r
 222     // -- _seqBEnd\r
 223     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 224         java.lang.Integer.TYPE, "_seqBEnd", "seqBEnd",\r
 225         org.exolab.castor.xml.NodeType.Attribute);\r
 226     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 227       public java.lang.Object getValue(java.lang.Object object)\r
 228           throws IllegalStateException {\r
 229         Range target = (Range) object;\r
 230         if (!target.hasSeqBEnd()) {\r
 231           return null;\r
 232         }\r
 233         return new java.lang.Integer(target.getSeqBEnd());\r
 234       }\r
 235 \r
 236       public void setValue(java.lang.Object object, java.lang.Object value)\r
 237           throws IllegalStateException, IllegalArgumentException {\r
 238         try {\r
 239           Range target = (Range) object;\r
 240           // if null, use delete method for optional primitives\r
 241           if (value == null) {\r
 242             target.deleteSeqBEnd();\r
 243             return;\r
 244           }\r
 245           target.setSeqBEnd(((java.lang.Integer) value).intValue());\r
 246         } catch (java.lang.Exception ex) {\r
 247           throw new IllegalStateException(ex.toString());\r
 248         }\r
 249       }\r
 250 \r
 251       public java.lang.Object newInstance(java.lang.Object parent) {\r
 252         return null;\r
 253       }\r
 254     };\r
 255     desc.setHandler(handler);\r
 256     desc.setMultivalued(false);\r
 257     addFieldDescriptor(desc);\r
 258 \r
 259     // -- validation code for: _seqBEnd\r
 260     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 261     { // -- local scope\r
 262       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 263       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 264       fieldValidator.setValidator(typeValidator);\r
 265       typeValidator.setMinInclusive(-2147483648);\r
 266       typeValidator.setMaxInclusive(2147483647);\r
 267     }\r
 268     desc.setValidator(fieldValidator);\r
 269     // -- initialize element descriptors\r
 270 \r
 271   }\r
 272 \r
 273   // -----------/\r
 274   // - Methods -/\r
 275   // -----------/\r
 276 \r
 277   /**\r
 278    * Method getAccessMode.\r
 279    * \r
 280    * @return the access mode specified for this class.\r
 281    */\r
 282   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 283     return null;\r
 284   }\r
 285 \r
 286   /**\r
 287    * Method getIdentity.\r
 288    * \r
 289    * @return the identity field, null if this class has no identity.\r
 290    */\r
 291   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 292     return _identity;\r
 293   }\r
 294 \r
 295   /**\r
 296    * Method getJavaClass.\r
 297    * \r
 298    * @return the Java class represented by this descriptor.\r
 299    */\r
 300   public java.lang.Class getJavaClass() {\r
 301     return uk.ac.vamsas.objects.core.Range.class;\r
 302   }\r
 303 \r
 304   /**\r
 305    * Method getNameSpacePrefix.\r
 306    * \r
 307    * @return the namespace prefix to use when marshaling as XML.\r
 308    */\r
 309   public java.lang.String getNameSpacePrefix() {\r
 310     return _nsPrefix;\r
 311   }\r
 312 \r
 313   /**\r
 314    * Method getNameSpaceURI.\r
 315    * \r
 316    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 317    */\r
 318   public java.lang.String getNameSpaceURI() {\r
 319     return _nsURI;\r
 320   }\r
 321 \r
 322   /**\r
 323    * Method getValidator.\r
 324    * \r
 325    * @return a specific validator for the class described by this\r
 326    *         ClassDescriptor.\r
 327    */\r
 328   public org.exolab.castor.xml.TypeValidator getValidator() {\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     return _xmlName;\r
 339   }\r
 340 \r
 341   /**\r
 342    * Method isElementDefinition.\r
 343    * \r
 344    * @return true if XML schema definition of this Class is that of a global\r
 345    *         element or element with anonymous type definition.\r
 346    */\r
 347   public boolean isElementDefinition() {\r
 348     return _elementDefinition;\r
 349   }\r
 350 \r
 351 }\r