src/uk/ac/vamsas/objects/core/descriptors/MapListDescriptor.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.MapList;\r
  29 \r
  30 /**\r
  31  * Class MapListDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class MapListDescriptor 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 MapListDescriptor() {\r
  72     super();\r
  73     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  74     _xmlName = "mapList";\r
  75     _elementDefinition = false;\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     // -- _from\r
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  83         java.lang.Long.TYPE, "_from", "from",\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         MapList target = (MapList) object;\r
  89         if (!target.hasFrom()) {\r
  90           return null;\r
  91         }\r
  92         return new java.lang.Long(target.getFrom());\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           MapList target = (MapList) object;\r
  99           // if null, use delete method for optional primitives\r
 100           if (value == null) {\r
 101             target.deleteFrom();\r
 102             return;\r
 103           }\r
 104           target.setFrom(((java.lang.Long) value).longValue());\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: _from\r
 119     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 120     { // -- local scope\r
 121       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 122       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 123       fieldValidator.setValidator(typeValidator);\r
 124     }\r
 125     desc.setValidator(fieldValidator);\r
 126     // -- _to\r
 127     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 128         java.lang.Long.TYPE, "_to", "to",\r
 129         org.exolab.castor.xml.NodeType.Attribute);\r
 130     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 131       public java.lang.Object getValue(java.lang.Object object)\r
 132           throws IllegalStateException {\r
 133         MapList target = (MapList) object;\r
 134         if (!target.hasTo()) {\r
 135           return null;\r
 136         }\r
 137         return new java.lang.Long(target.getTo());\r
 138       }\r
 139 \r
 140       public void setValue(java.lang.Object object, java.lang.Object value)\r
 141           throws IllegalStateException, IllegalArgumentException {\r
 142         try {\r
 143           MapList target = (MapList) object;\r
 144           // if null, use delete method for optional primitives\r
 145           if (value == null) {\r
 146             target.deleteTo();\r
 147             return;\r
 148           }\r
 149           target.setTo(((java.lang.Long) value).longValue());\r
 150         } catch (java.lang.Exception ex) {\r
 151           throw new IllegalStateException(ex.toString());\r
 152         }\r
 153       }\r
 154 \r
 155       public java.lang.Object newInstance(java.lang.Object parent) {\r
 156         return null;\r
 157       }\r
 158     };\r
 159     desc.setHandler(handler);\r
 160     desc.setMultivalued(false);\r
 161     addFieldDescriptor(desc);\r
 162 \r
 163     // -- validation code for: _to\r
 164     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 165     { // -- local scope\r
 166       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 167       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 168       fieldValidator.setValidator(typeValidator);\r
 169     }\r
 170     desc.setValidator(fieldValidator);\r
 171     // -- _start\r
 172     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 173         java.lang.Long.TYPE, "_start", "start",\r
 174         org.exolab.castor.xml.NodeType.Attribute);\r
 175     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 176       public java.lang.Object getValue(java.lang.Object object)\r
 177           throws IllegalStateException {\r
 178         MapList target = (MapList) object;\r
 179         if (!target.hasStart()) {\r
 180           return null;\r
 181         }\r
 182         return new java.lang.Long(target.getStart());\r
 183       }\r
 184 \r
 185       public void setValue(java.lang.Object object, java.lang.Object value)\r
 186           throws IllegalStateException, IllegalArgumentException {\r
 187         try {\r
 188           MapList target = (MapList) object;\r
 189           // ignore null values for non optional primitives\r
 190           if (value == null) {\r
 191             return;\r
 192           }\r
 193 \r
 194           target.setStart(((java.lang.Long) value).longValue());\r
 195         } catch (java.lang.Exception ex) {\r
 196           throw new IllegalStateException(ex.toString());\r
 197         }\r
 198       }\r
 199 \r
 200       public java.lang.Object newInstance(java.lang.Object parent) {\r
 201         return null;\r
 202       }\r
 203     };\r
 204     desc.setHandler(handler);\r
 205     desc.setRequired(true);\r
 206     desc.setMultivalued(false);\r
 207     addFieldDescriptor(desc);\r
 208 \r
 209     // -- validation code for: _start\r
 210     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 211     fieldValidator.setMinOccurs(1);\r
 212     { // -- local scope\r
 213       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 214       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 215       fieldValidator.setValidator(typeValidator);\r
 216     }\r
 217     desc.setValidator(fieldValidator);\r
 218     // -- _end\r
 219     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 220         java.lang.Long.TYPE, "_end", "end",\r
 221         org.exolab.castor.xml.NodeType.Attribute);\r
 222     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 223       public java.lang.Object getValue(java.lang.Object object)\r
 224           throws IllegalStateException {\r
 225         MapList target = (MapList) object;\r
 226         if (!target.hasEnd()) {\r
 227           return null;\r
 228         }\r
 229         return new java.lang.Long(target.getEnd());\r
 230       }\r
 231 \r
 232       public void setValue(java.lang.Object object, java.lang.Object value)\r
 233           throws IllegalStateException, IllegalArgumentException {\r
 234         try {\r
 235           MapList target = (MapList) object;\r
 236           // ignore null values for non optional primitives\r
 237           if (value == null) {\r
 238             return;\r
 239           }\r
 240 \r
 241           target.setEnd(((java.lang.Long) value).longValue());\r
 242         } catch (java.lang.Exception ex) {\r
 243           throw new IllegalStateException(ex.toString());\r
 244         }\r
 245       }\r
 246 \r
 247       public java.lang.Object newInstance(java.lang.Object parent) {\r
 248         return null;\r
 249       }\r
 250     };\r
 251     desc.setHandler(handler);\r
 252     desc.setRequired(true);\r
 253     desc.setMultivalued(false);\r
 254     addFieldDescriptor(desc);\r
 255 \r
 256     // -- validation code for: _end\r
 257     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 258     fieldValidator.setMinOccurs(1);\r
 259     { // -- local scope\r
 260       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 261       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 262       fieldValidator.setValidator(typeValidator);\r
 263     }\r
 264     desc.setValidator(fieldValidator);\r
 265     // -- initialize element descriptors\r
 266 \r
 267   }\r
 268 \r
 269   // -----------/\r
 270   // - Methods -/\r
 271   // -----------/\r
 272 \r
 273   /**\r
 274    * Method getAccessMode.\r
 275    * \r
 276    * @return the access mode specified for this class.\r
 277    */\r
 278   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 279     return null;\r
 280   }\r
 281 \r
 282   /**\r
 283    * Method getIdentity.\r
 284    * \r
 285    * @return the identity field, null if this class has no identity.\r
 286    */\r
 287   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 288     return _identity;\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     return uk.ac.vamsas.objects.core.MapList.class;\r
 298   }\r
 299 \r
 300   /**\r
 301    * Method getNameSpacePrefix.\r
 302    * \r
 303    * @return the namespace prefix to use when marshaling as XML.\r
 304    */\r
 305   public java.lang.String getNameSpacePrefix() {\r
 306     return _nsPrefix;\r
 307   }\r
 308 \r
 309   /**\r
 310    * Method getNameSpaceURI.\r
 311    * \r
 312    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 313    */\r
 314   public java.lang.String getNameSpaceURI() {\r
 315     return _nsURI;\r
 316   }\r
 317 \r
 318   /**\r
 319    * Method getValidator.\r
 320    * \r
 321    * @return a specific validator for the class described by this\r
 322    *         ClassDescriptor.\r
 323    */\r
 324   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 325     return this;\r
 326   }\r
 327 \r
 328   /**\r
 329    * Method getXMLName.\r
 330    * \r
 331    * @return the XML Name for the Class being described.\r
 332    */\r
 333   public java.lang.String getXMLName() {\r
 334     return _xmlName;\r
 335   }\r
 336 \r
 337   /**\r
 338    * Method isElementDefinition.\r
 339    * \r
 340    * @return true if XML schema definition of this Class is that of a global\r
 341    *         element or element with anonymous type definition.\r
 342    */\r
 343   public boolean isElementDefinition() {\r
 344     return _elementDefinition;\r
 345   }\r
 346 \r
 347 }\r