src/uk/ac/vamsas/objects/core/descriptors/SegDescriptor.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.Seg;\r
  29 \r
  30 /**\r
  31  * Class SegDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class SegDescriptor 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 SegDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "seg";\r
  70     _elementDefinition = true;\r
  71     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  72     org.exolab.castor.mapping.FieldHandler handler = null;\r
  73     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  74     // -- initialize attribute descriptors\r
  75 \r
  76     // -- _start\r
  77     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  78         java.lang.Integer.TYPE, "_start", "start",\r
  79         org.exolab.castor.xml.NodeType.Attribute);\r
  80     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  81       public java.lang.Object getValue(java.lang.Object object)\r
  82           throws IllegalStateException {\r
  83         Seg target = (Seg) object;\r
  84         if (!target.hasStart()) {\r
  85           return null;\r
  86         }\r
  87         return new java.lang.Integer(target.getStart());\r
  88       }\r
  89 \r
  90       public void setValue(java.lang.Object object, java.lang.Object value)\r
  91           throws IllegalStateException, IllegalArgumentException {\r
  92         try {\r
  93           Seg target = (Seg) object;\r
  94           // ignore null values for non optional primitives\r
  95           if (value == null) {\r
  96             return;\r
  97           }\r
  98 \r
  99           target.setStart(((java.lang.Integer) value).intValue());\r
 100         } catch (java.lang.Exception ex) {\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         return null;\r
 107       }\r
 108     };\r
 109     desc.setHandler(handler);\r
 110     desc.setRequired(true);\r
 111     desc.setMultivalued(false);\r
 112     addFieldDescriptor(desc);\r
 113 \r
 114     // -- validation code for: _start\r
 115     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 116     fieldValidator.setMinOccurs(1);\r
 117     { // -- local scope\r
 118       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 119       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 120       fieldValidator.setValidator(typeValidator);\r
 121       typeValidator.setMinInclusive(-2147483648);\r
 122       typeValidator.setMaxInclusive(2147483647);\r
 123     }\r
 124     desc.setValidator(fieldValidator);\r
 125     // -- _end\r
 126     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 127         java.lang.Integer.TYPE, "_end", "end",\r
 128         org.exolab.castor.xml.NodeType.Attribute);\r
 129     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 130       public java.lang.Object getValue(java.lang.Object object)\r
 131           throws IllegalStateException {\r
 132         Seg target = (Seg) object;\r
 133         if (!target.hasEnd()) {\r
 134           return null;\r
 135         }\r
 136         return new java.lang.Integer(target.getEnd());\r
 137       }\r
 138 \r
 139       public void setValue(java.lang.Object object, java.lang.Object value)\r
 140           throws IllegalStateException, IllegalArgumentException {\r
 141         try {\r
 142           Seg target = (Seg) object;\r
 143           // ignore null values for non optional primitives\r
 144           if (value == null) {\r
 145             return;\r
 146           }\r
 147 \r
 148           target.setEnd(((java.lang.Integer) value).intValue());\r
 149         } catch (java.lang.Exception ex) {\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         return null;\r
 156       }\r
 157     };\r
 158     desc.setHandler(handler);\r
 159     desc.setRequired(true);\r
 160     desc.setMultivalued(false);\r
 161     addFieldDescriptor(desc);\r
 162 \r
 163     // -- validation code for: _end\r
 164     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 165     fieldValidator.setMinOccurs(1);\r
 166     { // -- local scope\r
 167       org.exolab.castor.xml.validators.IntValidator typeValidator;\r
 168       typeValidator = new org.exolab.castor.xml.validators.IntValidator();\r
 169       fieldValidator.setValidator(typeValidator);\r
 170       typeValidator.setMinInclusive(-2147483648);\r
 171       typeValidator.setMaxInclusive(2147483647);\r
 172     }\r
 173     desc.setValidator(fieldValidator);\r
 174     // -- _inclusive\r
 175     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 176         java.lang.Boolean.TYPE, "_inclusive", "inclusive",\r
 177         org.exolab.castor.xml.NodeType.Attribute);\r
 178     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 179       public java.lang.Object getValue(java.lang.Object object)\r
 180           throws IllegalStateException {\r
 181         Seg target = (Seg) object;\r
 182         if (!target.hasInclusive()) {\r
 183           return null;\r
 184         }\r
 185         return (target.getInclusive() ? java.lang.Boolean.TRUE\r
 186             : java.lang.Boolean.FALSE);\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           Seg target = (Seg) object;\r
 193           // ignore null values for non optional primitives\r
 194           if (value == null) {\r
 195             return;\r
 196           }\r
 197 \r
 198           target.setInclusive(((java.lang.Boolean) value).booleanValue());\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.setRequired(true);\r
 210     desc.setMultivalued(false);\r
 211     addFieldDescriptor(desc);\r
 212 \r
 213     // -- validation code for: _inclusive\r
 214     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 215     fieldValidator.setMinOccurs(1);\r
 216     { // -- local scope\r
 217       org.exolab.castor.xml.validators.BooleanValidator typeValidator;\r
 218       typeValidator = new org.exolab.castor.xml.validators.BooleanValidator();\r
 219       fieldValidator.setValidator(typeValidator);\r
 220     }\r
 221     desc.setValidator(fieldValidator);\r
 222     // -- initialize element descriptors\r
 223 \r
 224   }\r
 225 \r
 226   // -----------/\r
 227   // - Methods -/\r
 228   // -----------/\r
 229 \r
 230   /**\r
 231    * Method getAccessMode.\r
 232    * \r
 233    * @return the access mode specified for this class.\r
 234    */\r
 235   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 236     return null;\r
 237   }\r
 238 \r
 239   /**\r
 240    * Method getIdentity.\r
 241    * \r
 242    * @return the identity field, null if this class has no identity.\r
 243    */\r
 244   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 245     return super.getIdentity();\r
 246   }\r
 247 \r
 248   /**\r
 249    * Method getJavaClass.\r
 250    * \r
 251    * @return the Java class represented by this descriptor.\r
 252    */\r
 253   public java.lang.Class getJavaClass() {\r
 254     return uk.ac.vamsas.objects.core.Seg.class;\r
 255   }\r
 256 \r
 257   /**\r
 258    * Method getNameSpacePrefix.\r
 259    * \r
 260    * @return the namespace prefix to use when marshaling as XML.\r
 261    */\r
 262   public java.lang.String getNameSpacePrefix() {\r
 263     return _nsPrefix;\r
 264   }\r
 265 \r
 266   /**\r
 267    * Method getNameSpaceURI.\r
 268    * \r
 269    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 270    */\r
 271   public java.lang.String getNameSpaceURI() {\r
 272     return _nsURI;\r
 273   }\r
 274 \r
 275   /**\r
 276    * Method getValidator.\r
 277    * \r
 278    * @return a specific validator for the class described by this\r
 279    *         ClassDescriptor.\r
 280    */\r
 281   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 282     return this;\r
 283   }\r
 284 \r
 285   /**\r
 286    * Method getXMLName.\r
 287    * \r
 288    * @return the XML Name for the Class being described.\r
 289    */\r
 290   public java.lang.String getXMLName() {\r
 291     return _xmlName;\r
 292   }\r
 293 \r
 294   /**\r
 295    * Method isElementDefinition.\r
 296    * \r
 297    * @return true if XML schema definition of this Class is that of a global\r
 298    *         element or element with anonymous type definition.\r
 299    */\r
 300   public boolean isElementDefinition() {\r
 301     return _elementDefinition;\r
 302   }\r
 303 \r
 304 }\r