src/uk/ac/vamsas/objects/core/descriptors/SequenceTypeDescriptor.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.SequenceType;\r
  29 \r
  30 /**\r
  31  * Class SequenceTypeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class SequenceTypeDescriptor 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 SequenceTypeDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "SequenceType";\r
  70     _elementDefinition = false;\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     // -- _start\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81         java.lang.Long.TYPE, "_start", "start",\r
  82         org.exolab.castor.xml.NodeType.Attribute);\r
  83     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  84       public java.lang.Object getValue(java.lang.Object object)\r
  85           throws IllegalStateException {\r
  86         SequenceType target = (SequenceType) object;\r
  87         if (!target.hasStart()) {\r
  88           return null;\r
  89         }\r
  90         return new java.lang.Long(target.getStart());\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           SequenceType target = (SequenceType) object;\r
  97           // ignore null values for non optional primitives\r
  98           if (value == null) {\r
  99             return;\r
 100           }\r
 101 \r
 102           target.setStart(((java.lang.Long) value).longValue());\r
 103         } catch (java.lang.Exception ex) {\r
 104           throw new IllegalStateException(ex.toString());\r
 105         }\r
 106       }\r
 107 \r
 108       public java.lang.Object newInstance(java.lang.Object parent) {\r
 109         return null;\r
 110       }\r
 111     };\r
 112     desc.setHandler(handler);\r
 113     desc.setRequired(true);\r
 114     desc.setMultivalued(false);\r
 115     addFieldDescriptor(desc);\r
 116 \r
 117     // -- validation code for: _start\r
 118     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 119     fieldValidator.setMinOccurs(1);\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     // -- _end\r
 127     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 128         java.lang.Long.TYPE, "_end", "end",\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         SequenceType target = (SequenceType) object;\r
 134         if (!target.hasEnd()) {\r
 135           return null;\r
 136         }\r
 137         return new java.lang.Long(target.getEnd());\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           SequenceType target = (SequenceType) object;\r
 144           // ignore null values for non optional primitives\r
 145           if (value == null) {\r
 146             return;\r
 147           }\r
 148 \r
 149           target.setEnd(((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.setRequired(true);\r
 161     desc.setMultivalued(false);\r
 162     addFieldDescriptor(desc);\r
 163 \r
 164     // -- validation code for: _end\r
 165     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 166     fieldValidator.setMinOccurs(1);\r
 167     { // -- local scope\r
 168       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 169       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 170       fieldValidator.setValidator(typeValidator);\r
 171     }\r
 172     desc.setValidator(fieldValidator);\r
 173     // -- initialize element descriptors\r
 174 \r
 175     // -- _sequence\r
 176     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 177         java.lang.String.class, "_sequence", "sequence",\r
 178         org.exolab.castor.xml.NodeType.Element);\r
 179     desc.setImmutable(true);\r
 180     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 181       public java.lang.Object getValue(java.lang.Object object)\r
 182           throws IllegalStateException {\r
 183         SequenceType target = (SequenceType) object;\r
 184         return target.getSequence();\r
 185       }\r
 186 \r
 187       public void setValue(java.lang.Object object, java.lang.Object value)\r
 188           throws IllegalStateException, IllegalArgumentException {\r
 189         try {\r
 190           SequenceType target = (SequenceType) object;\r
 191           target.setSequence((java.lang.String) value);\r
 192         } catch (java.lang.Exception ex) {\r
 193           throw new IllegalStateException(ex.toString());\r
 194         }\r
 195       }\r
 196 \r
 197       public java.lang.Object newInstance(java.lang.Object parent) {\r
 198         return null;\r
 199       }\r
 200     };\r
 201     desc.setHandler(handler);\r
 202     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 203     desc.setRequired(true);\r
 204     desc.setMultivalued(false);\r
 205     addFieldDescriptor(desc);\r
 206 \r
 207     // -- validation code for: _sequence\r
 208     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 209     fieldValidator.setMinOccurs(1);\r
 210     { // -- local scope\r
 211       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 212       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 213       fieldValidator.setValidator(typeValidator);\r
 214       typeValidator.setWhiteSpace("preserve");\r
 215     }\r
 216     desc.setValidator(fieldValidator);\r
 217     // -- _name\r
 218     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 219         java.lang.String.class, "_name", "name",\r
 220         org.exolab.castor.xml.NodeType.Element);\r
 221     desc.setImmutable(true);\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         SequenceType target = (SequenceType) object;\r
 226         return target.getName();\r
 227       }\r
 228 \r
 229       public void setValue(java.lang.Object object, java.lang.Object value)\r
 230           throws IllegalStateException, IllegalArgumentException {\r
 231         try {\r
 232           SequenceType target = (SequenceType) object;\r
 233           target.setName((java.lang.String) value);\r
 234         } catch (java.lang.Exception ex) {\r
 235           throw new IllegalStateException(ex.toString());\r
 236         }\r
 237       }\r
 238 \r
 239       public java.lang.Object newInstance(java.lang.Object parent) {\r
 240         return null;\r
 241       }\r
 242     };\r
 243     desc.setHandler(handler);\r
 244     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 245     desc.setRequired(true);\r
 246     desc.setMultivalued(false);\r
 247     addFieldDescriptor(desc);\r
 248 \r
 249     // -- validation code for: _name\r
 250     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 251     fieldValidator.setMinOccurs(1);\r
 252     { // -- local scope\r
 253       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 254       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 255       fieldValidator.setValidator(typeValidator);\r
 256       typeValidator.setWhiteSpace("preserve");\r
 257     }\r
 258     desc.setValidator(fieldValidator);\r
 259     // -- _description\r
 260     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 261         java.lang.String.class, "_description", "description",\r
 262         org.exolab.castor.xml.NodeType.Element);\r
 263     desc.setImmutable(true);\r
 264     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 265       public java.lang.Object getValue(java.lang.Object object)\r
 266           throws IllegalStateException {\r
 267         SequenceType target = (SequenceType) object;\r
 268         return target.getDescription();\r
 269       }\r
 270 \r
 271       public void setValue(java.lang.Object object, java.lang.Object value)\r
 272           throws IllegalStateException, IllegalArgumentException {\r
 273         try {\r
 274           SequenceType target = (SequenceType) object;\r
 275           target.setDescription((java.lang.String) value);\r
 276         } catch (java.lang.Exception ex) {\r
 277           throw new IllegalStateException(ex.toString());\r
 278         }\r
 279       }\r
 280 \r
 281       public java.lang.Object newInstance(java.lang.Object parent) {\r
 282         return null;\r
 283       }\r
 284     };\r
 285     desc.setHandler(handler);\r
 286     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 287     desc.setMultivalued(false);\r
 288     addFieldDescriptor(desc);\r
 289 \r
 290     // -- validation code for: _description\r
 291     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 292     { // -- local scope\r
 293       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 294       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 295       fieldValidator.setValidator(typeValidator);\r
 296       typeValidator.setWhiteSpace("preserve");\r
 297     }\r
 298     desc.setValidator(fieldValidator);\r
 299     // -- _propertyList\r
 300     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 301         uk.ac.vamsas.objects.core.Property.class, "_propertyList", "property",\r
 302         org.exolab.castor.xml.NodeType.Element);\r
 303     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 304       public java.lang.Object getValue(java.lang.Object object)\r
 305           throws IllegalStateException {\r
 306         SequenceType target = (SequenceType) object;\r
 307         return target.getProperty();\r
 308       }\r
 309 \r
 310       public void setValue(java.lang.Object object, java.lang.Object value)\r
 311           throws IllegalStateException, IllegalArgumentException {\r
 312         try {\r
 313           SequenceType target = (SequenceType) object;\r
 314           target.addProperty((uk.ac.vamsas.objects.core.Property) value);\r
 315         } catch (java.lang.Exception ex) {\r
 316           throw new IllegalStateException(ex.toString());\r
 317         }\r
 318       }\r
 319 \r
 320       public void resetValue(Object object) throws IllegalStateException,\r
 321           IllegalArgumentException {\r
 322         try {\r
 323           SequenceType target = (SequenceType) object;\r
 324           target.removeAllProperty();\r
 325         } catch (java.lang.Exception ex) {\r
 326           throw new IllegalStateException(ex.toString());\r
 327         }\r
 328       }\r
 329 \r
 330       public java.lang.Object newInstance(java.lang.Object parent) {\r
 331         return new uk.ac.vamsas.objects.core.Property();\r
 332       }\r
 333     };\r
 334     desc.setHandler(handler);\r
 335     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 336     desc.setMultivalued(true);\r
 337     addFieldDescriptor(desc);\r
 338 \r
 339     // -- validation code for: _propertyList\r
 340     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 341     fieldValidator.setMinOccurs(0);\r
 342     { // -- local scope\r
 343     }\r
 344     desc.setValidator(fieldValidator);\r
 345   }\r
 346 \r
 347   // -----------/\r
 348   // - Methods -/\r
 349   // -----------/\r
 350 \r
 351   /**\r
 352    * Method getAccessMode.\r
 353    * \r
 354    * @return the access mode specified for this class.\r
 355    */\r
 356   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 357     return null;\r
 358   }\r
 359 \r
 360   /**\r
 361    * Method getIdentity.\r
 362    * \r
 363    * @return the identity field, null if this class has no identity.\r
 364    */\r
 365   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 366     return super.getIdentity();\r
 367   }\r
 368 \r
 369   /**\r
 370    * Method getJavaClass.\r
 371    * \r
 372    * @return the Java class represented by this descriptor.\r
 373    */\r
 374   public java.lang.Class getJavaClass() {\r
 375     return uk.ac.vamsas.objects.core.SequenceType.class;\r
 376   }\r
 377 \r
 378   /**\r
 379    * Method getNameSpacePrefix.\r
 380    * \r
 381    * @return the namespace prefix to use when marshaling as XML.\r
 382    */\r
 383   public java.lang.String getNameSpacePrefix() {\r
 384     return _nsPrefix;\r
 385   }\r
 386 \r
 387   /**\r
 388    * Method getNameSpaceURI.\r
 389    * \r
 390    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 391    */\r
 392   public java.lang.String getNameSpaceURI() {\r
 393     return _nsURI;\r
 394   }\r
 395 \r
 396   /**\r
 397    * Method getValidator.\r
 398    * \r
 399    * @return a specific validator for the class described by this\r
 400    *         ClassDescriptor.\r
 401    */\r
 402   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 403     return this;\r
 404   }\r
 405 \r
 406   /**\r
 407    * Method getXMLName.\r
 408    * \r
 409    * @return the XML Name for the Class being described.\r
 410    */\r
 411   public java.lang.String getXMLName() {\r
 412     return _xmlName;\r
 413   }\r
 414 \r
 415   /**\r
 416    * Method isElementDefinition.\r
 417    * \r
 418    * @return true if XML schema definition of this Class is that of a global\r
 419    *         element or element with anonymous type definition.\r
 420    */\r
 421   public boolean isElementDefinition() {\r
 422     return _elementDefinition;\r
 423   }\r
 424 \r
 425 }\r