src/uk/ac/vamsas/objects/core/descriptors/VAMSASDescriptor.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.VAMSAS;\r
  29 \r
  30 /**\r
  31  * Class VAMSASDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class VAMSASDescriptor 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 VAMSASDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "VAMSAS";\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     // -- _id\r
  80     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  81         java.lang.String.class, "_id", "id",\r
  82         org.exolab.castor.xml.NodeType.Attribute);\r
  83     super.setIdentity(desc);\r
  84     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  85       public java.lang.Object getValue(java.lang.Object object)\r
  86           throws IllegalStateException {\r
  87         VAMSAS target = (VAMSAS) object;\r
  88         return target.getId();\r
  89       }\r
  90 \r
  91       public void setValue(java.lang.Object object, java.lang.Object value)\r
  92           throws IllegalStateException, IllegalArgumentException {\r
  93         try {\r
  94           VAMSAS target = (VAMSAS) object;\r
  95           target.setId((java.lang.String) value);\r
  96         } catch (java.lang.Exception ex) {\r
  97           throw new IllegalStateException(ex.toString());\r
  98         }\r
  99       }\r
 100 \r
 101       public java.lang.Object newInstance(java.lang.Object parent) {\r
 102         return new java.lang.String();\r
 103       }\r
 104     };\r
 105     desc.setHandler(handler);\r
 106     desc.setMultivalued(false);\r
 107     addFieldDescriptor(desc);\r
 108 \r
 109     // -- validation code for: _id\r
 110     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 111     { // -- local scope\r
 112       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 113       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 114       fieldValidator.setValidator(typeValidator);\r
 115     }\r
 116     desc.setValidator(fieldValidator);\r
 117     // -- _modifiable\r
 118     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 119         java.lang.String.class, "_modifiable", "modifiable",\r
 120         org.exolab.castor.xml.NodeType.Attribute);\r
 121     desc.setImmutable(true);\r
 122     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 123       public java.lang.Object getValue(java.lang.Object object)\r
 124           throws IllegalStateException {\r
 125         VAMSAS target = (VAMSAS) object;\r
 126         return target.getModifiable();\r
 127       }\r
 128 \r
 129       public void setValue(java.lang.Object object, java.lang.Object value)\r
 130           throws IllegalStateException, IllegalArgumentException {\r
 131         try {\r
 132           VAMSAS target = (VAMSAS) object;\r
 133           target.setModifiable((java.lang.String) value);\r
 134         } catch (java.lang.Exception ex) {\r
 135           throw new IllegalStateException(ex.toString());\r
 136         }\r
 137       }\r
 138 \r
 139       public java.lang.Object newInstance(java.lang.Object parent) {\r
 140         return null;\r
 141       }\r
 142     };\r
 143     desc.setHandler(handler);\r
 144     desc.setMultivalued(false);\r
 145     addFieldDescriptor(desc);\r
 146 \r
 147     // -- validation code for: _modifiable\r
 148     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 149     { // -- local scope\r
 150       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 151       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 152       fieldValidator.setValidator(typeValidator);\r
 153       typeValidator.setWhiteSpace("preserve");\r
 154     }\r
 155     desc.setValidator(fieldValidator);\r
 156     // -- initialize element descriptors\r
 157 \r
 158     // -- _treeList\r
 159     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 160         uk.ac.vamsas.objects.core.Tree.class, "_treeList", "Tree",\r
 161         org.exolab.castor.xml.NodeType.Element);\r
 162     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 163       public java.lang.Object getValue(java.lang.Object object)\r
 164           throws IllegalStateException {\r
 165         VAMSAS target = (VAMSAS) object;\r
 166         return target.getTree();\r
 167       }\r
 168 \r
 169       public void setValue(java.lang.Object object, java.lang.Object value)\r
 170           throws IllegalStateException, IllegalArgumentException {\r
 171         try {\r
 172           VAMSAS target = (VAMSAS) object;\r
 173           target.addTree((uk.ac.vamsas.objects.core.Tree) value);\r
 174         } catch (java.lang.Exception ex) {\r
 175           throw new IllegalStateException(ex.toString());\r
 176         }\r
 177       }\r
 178 \r
 179       public void resetValue(Object object) throws IllegalStateException,\r
 180           IllegalArgumentException {\r
 181         try {\r
 182           VAMSAS target = (VAMSAS) object;\r
 183           target.removeAllTree();\r
 184         } catch (java.lang.Exception ex) {\r
 185           throw new IllegalStateException(ex.toString());\r
 186         }\r
 187       }\r
 188 \r
 189       public java.lang.Object newInstance(java.lang.Object parent) {\r
 190         return new uk.ac.vamsas.objects.core.Tree();\r
 191       }\r
 192     };\r
 193     desc.setHandler(handler);\r
 194     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 195     desc.setMultivalued(true);\r
 196     addFieldDescriptor(desc);\r
 197 \r
 198     // -- validation code for: _treeList\r
 199     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 200     fieldValidator.setMinOccurs(0);\r
 201     { // -- local scope\r
 202     }\r
 203     desc.setValidator(fieldValidator);\r
 204     // -- _dataSetList\r
 205     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 206         uk.ac.vamsas.objects.core.DataSet.class, "_dataSetList", "DataSet",\r
 207         org.exolab.castor.xml.NodeType.Element);\r
 208     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 209       public java.lang.Object getValue(java.lang.Object object)\r
 210           throws IllegalStateException {\r
 211         VAMSAS target = (VAMSAS) object;\r
 212         return target.getDataSet();\r
 213       }\r
 214 \r
 215       public void setValue(java.lang.Object object, java.lang.Object value)\r
 216           throws IllegalStateException, IllegalArgumentException {\r
 217         try {\r
 218           VAMSAS target = (VAMSAS) object;\r
 219           target.addDataSet((uk.ac.vamsas.objects.core.DataSet) value);\r
 220         } catch (java.lang.Exception ex) {\r
 221           throw new IllegalStateException(ex.toString());\r
 222         }\r
 223       }\r
 224 \r
 225       public void resetValue(Object object) throws IllegalStateException,\r
 226           IllegalArgumentException {\r
 227         try {\r
 228           VAMSAS target = (VAMSAS) object;\r
 229           target.removeAllDataSet();\r
 230         } catch (java.lang.Exception ex) {\r
 231           throw new IllegalStateException(ex.toString());\r
 232         }\r
 233       }\r
 234 \r
 235       public java.lang.Object newInstance(java.lang.Object parent) {\r
 236         return new uk.ac.vamsas.objects.core.DataSet();\r
 237       }\r
 238     };\r
 239     desc.setHandler(handler);\r
 240     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 241     desc.setMultivalued(true);\r
 242     addFieldDescriptor(desc);\r
 243 \r
 244     // -- validation code for: _dataSetList\r
 245     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 246     fieldValidator.setMinOccurs(0);\r
 247     { // -- local scope\r
 248     }\r
 249     desc.setValidator(fieldValidator);\r
 250   }\r
 251 \r
 252   // -----------/\r
 253   // - Methods -/\r
 254   // -----------/\r
 255 \r
 256   /**\r
 257    * Method getAccessMode.\r
 258    * \r
 259    * @return the access mode specified for this class.\r
 260    */\r
 261   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 262     return null;\r
 263   }\r
 264 \r
 265   /**\r
 266    * Method getIdentity.\r
 267    * \r
 268    * @return the identity field, null if this class has no identity.\r
 269    */\r
 270   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 271     return super.getIdentity();\r
 272   }\r
 273 \r
 274   /**\r
 275    * Method getJavaClass.\r
 276    * \r
 277    * @return the Java class represented by this descriptor.\r
 278    */\r
 279   public java.lang.Class getJavaClass() {\r
 280     return uk.ac.vamsas.objects.core.VAMSAS.class;\r
 281   }\r
 282 \r
 283   /**\r
 284    * Method getNameSpacePrefix.\r
 285    * \r
 286    * @return the namespace prefix to use when marshaling as XML.\r
 287    */\r
 288   public java.lang.String getNameSpacePrefix() {\r
 289     return _nsPrefix;\r
 290   }\r
 291 \r
 292   /**\r
 293    * Method getNameSpaceURI.\r
 294    * \r
 295    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 296    */\r
 297   public java.lang.String getNameSpaceURI() {\r
 298     return _nsURI;\r
 299   }\r
 300 \r
 301   /**\r
 302    * Method getValidator.\r
 303    * \r
 304    * @return a specific validator for the class described by this\r
 305    *         ClassDescriptor.\r
 306    */\r
 307   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 308     return this;\r
 309   }\r
 310 \r
 311   /**\r
 312    * Method getXMLName.\r
 313    * \r
 314    * @return the XML Name for the Class being described.\r
 315    */\r
 316   public java.lang.String getXMLName() {\r
 317     return _xmlName;\r
 318   }\r
 319 \r
 320   /**\r
 321    * Method isElementDefinition.\r
 322    * \r
 323    * @return true if XML schema definition of this Class is that of a global\r
 324    *         element or element with anonymous type definition.\r
 325    */\r
 326   public boolean isElementDefinition() {\r
 327     return _elementDefinition;\r
 328   }\r
 329 \r
 330 }\r