src/uk/ac/vamsas/objects/core/descriptors/RangeTypeDescriptor.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.RangeType;\r
  29 \r
  30 /**\r
  31  * Class RangeTypeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class RangeTypeDescriptor 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 RangeTypeDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "rangeType";\r
  70     _elementDefinition = false;\r
  71 \r
  72     // -- set grouping compositor\r
  73     setCompositorAsChoice();\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     // -- initialize element descriptors\r
  80 \r
  81     // -- _posList\r
  82     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  83         uk.ac.vamsas.objects.core.Pos.class, "_posList", "pos",\r
  84         org.exolab.castor.xml.NodeType.Element);\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         RangeType target = (RangeType) object;\r
  89         return target.getPos();\r
  90       }\r
  91 \r
  92       public void setValue(java.lang.Object object, java.lang.Object value)\r
  93           throws IllegalStateException, IllegalArgumentException {\r
  94         try {\r
  95           RangeType target = (RangeType) object;\r
  96           target.addPos((uk.ac.vamsas.objects.core.Pos) value);\r
  97         } catch (java.lang.Exception ex) {\r
  98           throw new IllegalStateException(ex.toString());\r
  99         }\r
 100       }\r
 101 \r
 102       public void resetValue(Object object) throws IllegalStateException,\r
 103           IllegalArgumentException {\r
 104         try {\r
 105           RangeType target = (RangeType) object;\r
 106           target.removeAllPos();\r
 107         } catch (java.lang.Exception ex) {\r
 108           throw new IllegalStateException(ex.toString());\r
 109         }\r
 110       }\r
 111 \r
 112       public java.lang.Object newInstance(java.lang.Object parent) {\r
 113         return new uk.ac.vamsas.objects.core.Pos();\r
 114       }\r
 115     };\r
 116     desc.setHandler(handler);\r
 117     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 118     desc.setRequired(true);\r
 119     desc.setMultivalued(true);\r
 120     addFieldDescriptor(desc);\r
 121 \r
 122     // -- validation code for: _posList\r
 123     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 124     fieldValidator.setMinOccurs(1);\r
 125     { // -- local scope\r
 126     }\r
 127     desc.setValidator(fieldValidator);\r
 128     // -- _segList\r
 129     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 130         uk.ac.vamsas.objects.core.Seg.class, "_segList", "seg",\r
 131         org.exolab.castor.xml.NodeType.Element);\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         RangeType target = (RangeType) object;\r
 136         return target.getSeg();\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           RangeType target = (RangeType) object;\r
 143           target.addSeg((uk.ac.vamsas.objects.core.Seg) value);\r
 144         } catch (java.lang.Exception ex) {\r
 145           throw new IllegalStateException(ex.toString());\r
 146         }\r
 147       }\r
 148 \r
 149       public void resetValue(Object object) throws IllegalStateException,\r
 150           IllegalArgumentException {\r
 151         try {\r
 152           RangeType target = (RangeType) object;\r
 153           target.removeAllSeg();\r
 154         } catch (java.lang.Exception ex) {\r
 155           throw new IllegalStateException(ex.toString());\r
 156         }\r
 157       }\r
 158 \r
 159       public java.lang.Object newInstance(java.lang.Object parent) {\r
 160         return new uk.ac.vamsas.objects.core.Seg();\r
 161       }\r
 162     };\r
 163     desc.setHandler(handler);\r
 164     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 165     desc.setRequired(true);\r
 166     desc.setMultivalued(true);\r
 167     addFieldDescriptor(desc);\r
 168 \r
 169     // -- validation code for: _segList\r
 170     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 171     fieldValidator.setMinOccurs(1);\r
 172     { // -- local scope\r
 173     }\r
 174     desc.setValidator(fieldValidator);\r
 175   }\r
 176 \r
 177   // -----------/\r
 178   // - Methods -/\r
 179   // -----------/\r
 180 \r
 181   /**\r
 182    * Method getAccessMode.\r
 183    * \r
 184    * @return the access mode specified for this class.\r
 185    */\r
 186   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 187     return null;\r
 188   }\r
 189 \r
 190   /**\r
 191    * Method getIdentity.\r
 192    * \r
 193    * @return the identity field, null if this class has no identity.\r
 194    */\r
 195   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 196     return super.getIdentity();\r
 197   }\r
 198 \r
 199   /**\r
 200    * Method getJavaClass.\r
 201    * \r
 202    * @return the Java class represented by this descriptor.\r
 203    */\r
 204   public java.lang.Class getJavaClass() {\r
 205     return uk.ac.vamsas.objects.core.RangeType.class;\r
 206   }\r
 207 \r
 208   /**\r
 209    * Method getNameSpacePrefix.\r
 210    * \r
 211    * @return the namespace prefix to use when marshaling as XML.\r
 212    */\r
 213   public java.lang.String getNameSpacePrefix() {\r
 214     return _nsPrefix;\r
 215   }\r
 216 \r
 217   /**\r
 218    * Method getNameSpaceURI.\r
 219    * \r
 220    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 221    */\r
 222   public java.lang.String getNameSpaceURI() {\r
 223     return _nsURI;\r
 224   }\r
 225 \r
 226   /**\r
 227    * Method getValidator.\r
 228    * \r
 229    * @return a specific validator for the class described by this\r
 230    *         ClassDescriptor.\r
 231    */\r
 232   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 233     return this;\r
 234   }\r
 235 \r
 236   /**\r
 237    * Method getXMLName.\r
 238    * \r
 239    * @return the XML Name for the Class being described.\r
 240    */\r
 241   public java.lang.String getXMLName() {\r
 242     return _xmlName;\r
 243   }\r
 244 \r
 245   /**\r
 246    * Method isElementDefinition.\r
 247    * \r
 248    * @return true if XML schema definition of this Class is that of a global\r
 249    *         element or element with anonymous type definition.\r
 250    */\r
 251   public boolean isElementDefinition() {\r
 252     return _elementDefinition;\r
 253   }\r
 254 \r
 255 }\r