src/uk/ac/vamsas/objects/core/descriptors/AnnotationElementDescriptor.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.AnnotationElement;\r
  29 \r
  30 /**\r
  31  * Class AnnotationElementDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class AnnotationElementDescriptor 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 AnnotationElementDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "annotationElement";\r
  70     _elementDefinition = true;\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     // -- _position\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81         java.lang.Long.TYPE, "_position", "position",\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         AnnotationElement target = (AnnotationElement) object;\r
  87         if (!target.hasPosition()) {\r
  88           return null;\r
  89         }\r
  90         return new java.lang.Long(target.getPosition());\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           AnnotationElement target = (AnnotationElement) 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.setPosition(((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: _position\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     // -- _after\r
 127     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 128         java.lang.Boolean.TYPE, "_after", "after",\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         AnnotationElement target = (AnnotationElement) object;\r
 134         if (!target.hasAfter()) {\r
 135           return null;\r
 136         }\r
 137         return (target.getAfter() ? java.lang.Boolean.TRUE\r
 138             : java.lang.Boolean.FALSE);\r
 139       }\r
 140 \r
 141       public void setValue(java.lang.Object object, java.lang.Object value)\r
 142           throws IllegalStateException, IllegalArgumentException {\r
 143         try {\r
 144           AnnotationElement target = (AnnotationElement) object;\r
 145           // if null, use delete method for optional primitives\r
 146           if (value == null) {\r
 147             target.deleteAfter();\r
 148             return;\r
 149           }\r
 150           target.setAfter(((java.lang.Boolean) value).booleanValue());\r
 151         } catch (java.lang.Exception ex) {\r
 152           throw new IllegalStateException(ex.toString());\r
 153         }\r
 154       }\r
 155 \r
 156       public java.lang.Object newInstance(java.lang.Object parent) {\r
 157         return null;\r
 158       }\r
 159     };\r
 160     desc.setHandler(handler);\r
 161     desc.setMultivalued(false);\r
 162     addFieldDescriptor(desc);\r
 163 \r
 164     // -- validation code for: _after\r
 165     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 166     { // -- local scope\r
 167       org.exolab.castor.xml.validators.BooleanValidator typeValidator;\r
 168       typeValidator = new org.exolab.castor.xml.validators.BooleanValidator();\r
 169       fieldValidator.setValidator(typeValidator);\r
 170     }\r
 171     desc.setValidator(fieldValidator);\r
 172     // -- _id\r
 173     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 174         java.lang.String.class, "_id", "id",\r
 175         org.exolab.castor.xml.NodeType.Attribute);\r
 176     super.setIdentity(desc);\r
 177     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 178       public java.lang.Object getValue(java.lang.Object object)\r
 179           throws IllegalStateException {\r
 180         AnnotationElement target = (AnnotationElement) object;\r
 181         return target.getId();\r
 182       }\r
 183 \r
 184       public void setValue(java.lang.Object object, java.lang.Object value)\r
 185           throws IllegalStateException, IllegalArgumentException {\r
 186         try {\r
 187           AnnotationElement target = (AnnotationElement) object;\r
 188           target.setId((java.lang.String) value);\r
 189         } catch (java.lang.Exception ex) {\r
 190           throw new IllegalStateException(ex.toString());\r
 191         }\r
 192       }\r
 193 \r
 194       public java.lang.Object newInstance(java.lang.Object parent) {\r
 195         return new java.lang.String();\r
 196       }\r
 197     };\r
 198     desc.setHandler(handler);\r
 199     desc.setMultivalued(false);\r
 200     addFieldDescriptor(desc);\r
 201 \r
 202     // -- validation code for: _id\r
 203     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 204     { // -- local scope\r
 205       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 206       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 207       fieldValidator.setValidator(typeValidator);\r
 208     }\r
 209     desc.setValidator(fieldValidator);\r
 210     // -- initialize element descriptors\r
 211 \r
 212     // -- _description\r
 213     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 214         java.lang.String.class, "_description", "description",\r
 215         org.exolab.castor.xml.NodeType.Element);\r
 216     desc.setImmutable(true);\r
 217     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 218       public java.lang.Object getValue(java.lang.Object object)\r
 219           throws IllegalStateException {\r
 220         AnnotationElement target = (AnnotationElement) object;\r
 221         return target.getDescription();\r
 222       }\r
 223 \r
 224       public void setValue(java.lang.Object object, java.lang.Object value)\r
 225           throws IllegalStateException, IllegalArgumentException {\r
 226         try {\r
 227           AnnotationElement target = (AnnotationElement) object;\r
 228           target.setDescription((java.lang.String) value);\r
 229         } catch (java.lang.Exception ex) {\r
 230           throw new IllegalStateException(ex.toString());\r
 231         }\r
 232       }\r
 233 \r
 234       public java.lang.Object newInstance(java.lang.Object parent) {\r
 235         return null;\r
 236       }\r
 237     };\r
 238     desc.setHandler(handler);\r
 239     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 240     desc.setMultivalued(false);\r
 241     addFieldDescriptor(desc);\r
 242 \r
 243     // -- validation code for: _description\r
 244     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 245     { // -- local scope\r
 246       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 247       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 248       fieldValidator.setValidator(typeValidator);\r
 249       typeValidator.setWhiteSpace("preserve");\r
 250     }\r
 251     desc.setValidator(fieldValidator);\r
 252     // -- _glyphList\r
 253     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 254         uk.ac.vamsas.objects.core.Glyph.class, "_glyphList", "glyph",\r
 255         org.exolab.castor.xml.NodeType.Element);\r
 256     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 257       public java.lang.Object getValue(java.lang.Object object)\r
 258           throws IllegalStateException {\r
 259         AnnotationElement target = (AnnotationElement) object;\r
 260         return target.getGlyph();\r
 261       }\r
 262 \r
 263       public void setValue(java.lang.Object object, java.lang.Object value)\r
 264           throws IllegalStateException, IllegalArgumentException {\r
 265         try {\r
 266           AnnotationElement target = (AnnotationElement) object;\r
 267           target.addGlyph((uk.ac.vamsas.objects.core.Glyph) value);\r
 268         } catch (java.lang.Exception ex) {\r
 269           throw new IllegalStateException(ex.toString());\r
 270         }\r
 271       }\r
 272 \r
 273       public void resetValue(Object object) throws IllegalStateException,\r
 274           IllegalArgumentException {\r
 275         try {\r
 276           AnnotationElement target = (AnnotationElement) object;\r
 277           target.removeAllGlyph();\r
 278         } catch (java.lang.Exception ex) {\r
 279           throw new IllegalStateException(ex.toString());\r
 280         }\r
 281       }\r
 282 \r
 283       public java.lang.Object newInstance(java.lang.Object parent) {\r
 284         return new uk.ac.vamsas.objects.core.Glyph();\r
 285       }\r
 286     };\r
 287     desc.setHandler(handler);\r
 288     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 289     desc.setMultivalued(true);\r
 290     addFieldDescriptor(desc);\r
 291 \r
 292     // -- validation code for: _glyphList\r
 293     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 294     fieldValidator.setMinOccurs(0);\r
 295     { // -- local scope\r
 296     }\r
 297     desc.setValidator(fieldValidator);\r
 298     // -- _valueList\r
 299     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 300         java.lang.Float.TYPE, "_valueList", "value",\r
 301         org.exolab.castor.xml.NodeType.Element);\r
 302     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 303       public java.lang.Object getValue(java.lang.Object object)\r
 304           throws IllegalStateException {\r
 305         AnnotationElement target = (AnnotationElement) object;\r
 306         return target.getValue();\r
 307       }\r
 308 \r
 309       public void setValue(java.lang.Object object, java.lang.Object value)\r
 310           throws IllegalStateException, IllegalArgumentException {\r
 311         try {\r
 312           AnnotationElement target = (AnnotationElement) object;\r
 313           // ignore null values for non optional primitives\r
 314           if (value == null) {\r
 315             return;\r
 316           }\r
 317 \r
 318           target.addValue(((java.lang.Float) value).floatValue());\r
 319         } catch (java.lang.Exception ex) {\r
 320           throw new IllegalStateException(ex.toString());\r
 321         }\r
 322       }\r
 323 \r
 324       public void resetValue(Object object) throws IllegalStateException,\r
 325           IllegalArgumentException {\r
 326         try {\r
 327           AnnotationElement target = (AnnotationElement) object;\r
 328           target.removeAllValue();\r
 329         } catch (java.lang.Exception ex) {\r
 330           throw new IllegalStateException(ex.toString());\r
 331         }\r
 332       }\r
 333 \r
 334       public java.lang.Object newInstance(java.lang.Object parent) {\r
 335         return null;\r
 336       }\r
 337     };\r
 338     desc.setHandler(handler);\r
 339     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 340     desc.setMultivalued(true);\r
 341     addFieldDescriptor(desc);\r
 342 \r
 343     // -- validation code for: _valueList\r
 344     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 345     fieldValidator.setMinOccurs(0);\r
 346     { // -- local scope\r
 347       org.exolab.castor.xml.validators.FloatValidator typeValidator;\r
 348       typeValidator = new org.exolab.castor.xml.validators.FloatValidator();\r
 349       fieldValidator.setValidator(typeValidator);\r
 350       typeValidator.setMinInclusive((float) -3.4028235E38);\r
 351       typeValidator.setMaxInclusive((float) 3.4028235E38);\r
 352     }\r
 353     desc.setValidator(fieldValidator);\r
 354   }\r
 355 \r
 356   // -----------/\r
 357   // - Methods -/\r
 358   // -----------/\r
 359 \r
 360   /**\r
 361    * Method getAccessMode.\r
 362    * \r
 363    * @return the access mode specified for this class.\r
 364    */\r
 365   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 366     return null;\r
 367   }\r
 368 \r
 369   /**\r
 370    * Method getIdentity.\r
 371    * \r
 372    * @return the identity field, null if this class has no identity.\r
 373    */\r
 374   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 375     return super.getIdentity();\r
 376   }\r
 377 \r
 378   /**\r
 379    * Method getJavaClass.\r
 380    * \r
 381    * @return the Java class represented by this descriptor.\r
 382    */\r
 383   public java.lang.Class getJavaClass() {\r
 384     return uk.ac.vamsas.objects.core.AnnotationElement.class;\r
 385   }\r
 386 \r
 387   /**\r
 388    * Method getNameSpacePrefix.\r
 389    * \r
 390    * @return the namespace prefix to use when marshaling as XML.\r
 391    */\r
 392   public java.lang.String getNameSpacePrefix() {\r
 393     return _nsPrefix;\r
 394   }\r
 395 \r
 396   /**\r
 397    * Method getNameSpaceURI.\r
 398    * \r
 399    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 400    */\r
 401   public java.lang.String getNameSpaceURI() {\r
 402     return _nsURI;\r
 403   }\r
 404 \r
 405   /**\r
 406    * Method getValidator.\r
 407    * \r
 408    * @return a specific validator for the class described by this\r
 409    *         ClassDescriptor.\r
 410    */\r
 411   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 412     return this;\r
 413   }\r
 414 \r
 415   /**\r
 416    * Method getXMLName.\r
 417    * \r
 418    * @return the XML Name for the Class being described.\r
 419    */\r
 420   public java.lang.String getXMLName() {\r
 421     return _xmlName;\r
 422   }\r
 423 \r
 424   /**\r
 425    * Method isElementDefinition.\r
 426    * \r
 427    * @return true if XML schema definition of this Class is that of a global\r
 428    *         element or element with anonymous type definition.\r
 429    */\r
 430   public boolean isElementDefinition() {\r
 431     return _elementDefinition;\r
 432   }\r
 433 \r
 434 }\r