src/uk/ac/vamsas/objects/core/descriptors/ParamDescriptor.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.Param;\r
  29 \r
  30 /**\r
  31  * Class ParamDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class ParamDescriptor 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 ParamDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "param";\r
  70     _elementDefinition = true;\r
  71     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  72     org.exolab.castor.mapping.FieldHandler handler = null;\r
  73     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  74     // -- _content\r
  75     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  76         java.lang.String.class, "_content", "PCDATA",\r
  77         org.exolab.castor.xml.NodeType.Text);\r
  78     desc.setImmutable(true);\r
  79     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  80       public java.lang.Object getValue(java.lang.Object object)\r
  81           throws IllegalStateException {\r
  82         Param target = (Param) object;\r
  83         return target.getContent();\r
  84       }\r
  85 \r
  86       public void setValue(java.lang.Object object, java.lang.Object value)\r
  87           throws IllegalStateException, IllegalArgumentException {\r
  88         try {\r
  89           Param target = (Param) object;\r
  90           target.setContent((java.lang.String) value);\r
  91         } catch (java.lang.Exception ex) {\r
  92           throw new IllegalStateException(ex.toString());\r
  93         }\r
  94       }\r
  95 \r
  96       public java.lang.Object newInstance(java.lang.Object parent) {\r
  97         return null;\r
  98       }\r
  99     };\r
 100     desc.setHandler(handler);\r
 101     addFieldDescriptor(desc);\r
 102 \r
 103     // -- validation code for: _content\r
 104     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 105     { // -- local scope\r
 106       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 107       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 108       fieldValidator.setValidator(typeValidator);\r
 109       typeValidator.setWhiteSpace("preserve");\r
 110     }\r
 111     desc.setValidator(fieldValidator);\r
 112     // -- initialize attribute descriptors\r
 113 \r
 114     // -- _name\r
 115     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 116         java.lang.String.class, "_name", "name",\r
 117         org.exolab.castor.xml.NodeType.Attribute);\r
 118     desc.setImmutable(true);\r
 119     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 120       public java.lang.Object getValue(java.lang.Object object)\r
 121           throws IllegalStateException {\r
 122         Param target = (Param) object;\r
 123         return target.getName();\r
 124       }\r
 125 \r
 126       public void setValue(java.lang.Object object, java.lang.Object value)\r
 127           throws IllegalStateException, IllegalArgumentException {\r
 128         try {\r
 129           Param target = (Param) object;\r
 130           target.setName((java.lang.String) value);\r
 131         } catch (java.lang.Exception ex) {\r
 132           throw new IllegalStateException(ex.toString());\r
 133         }\r
 134       }\r
 135 \r
 136       public java.lang.Object newInstance(java.lang.Object parent) {\r
 137         return null;\r
 138       }\r
 139     };\r
 140     desc.setHandler(handler);\r
 141     desc.setRequired(true);\r
 142     desc.setMultivalued(false);\r
 143     addFieldDescriptor(desc);\r
 144 \r
 145     // -- validation code for: _name\r
 146     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 147     fieldValidator.setMinOccurs(1);\r
 148     { // -- local scope\r
 149       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 150       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 151       fieldValidator.setValidator(typeValidator);\r
 152       typeValidator.setWhiteSpace("preserve");\r
 153     }\r
 154     desc.setValidator(fieldValidator);\r
 155     // -- _type\r
 156     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 157         java.lang.String.class, "_type", "type",\r
 158         org.exolab.castor.xml.NodeType.Attribute);\r
 159     desc.setImmutable(true);\r
 160     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 161       public java.lang.Object getValue(java.lang.Object object)\r
 162           throws IllegalStateException {\r
 163         Param target = (Param) object;\r
 164         return target.getType();\r
 165       }\r
 166 \r
 167       public void setValue(java.lang.Object object, java.lang.Object value)\r
 168           throws IllegalStateException, IllegalArgumentException {\r
 169         try {\r
 170           Param target = (Param) object;\r
 171           target.setType((java.lang.String) value);\r
 172         } catch (java.lang.Exception ex) {\r
 173           throw new IllegalStateException(ex.toString());\r
 174         }\r
 175       }\r
 176 \r
 177       public java.lang.Object newInstance(java.lang.Object parent) {\r
 178         return null;\r
 179       }\r
 180     };\r
 181     desc.setHandler(handler);\r
 182     desc.setRequired(true);\r
 183     desc.setMultivalued(false);\r
 184     addFieldDescriptor(desc);\r
 185 \r
 186     // -- validation code for: _type\r
 187     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 188     fieldValidator.setMinOccurs(1);\r
 189     { // -- local scope\r
 190       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 191       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 192       fieldValidator.setValidator(typeValidator);\r
 193       typeValidator.setWhiteSpace("preserve");\r
 194     }\r
 195     desc.setValidator(fieldValidator);\r
 196     // -- initialize element descriptors\r
 197 \r
 198   }\r
 199 \r
 200   // -----------/\r
 201   // - Methods -/\r
 202   // -----------/\r
 203 \r
 204   /**\r
 205    * Method getAccessMode.\r
 206    * \r
 207    * @return the access mode specified for this class.\r
 208    */\r
 209   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 210     return null;\r
 211   }\r
 212 \r
 213   /**\r
 214    * Method getIdentity.\r
 215    * \r
 216    * @return the identity field, null if this class has no identity.\r
 217    */\r
 218   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 219     return super.getIdentity();\r
 220   }\r
 221 \r
 222   /**\r
 223    * Method getJavaClass.\r
 224    * \r
 225    * @return the Java class represented by this descriptor.\r
 226    */\r
 227   public java.lang.Class getJavaClass() {\r
 228     return uk.ac.vamsas.objects.core.Param.class;\r
 229   }\r
 230 \r
 231   /**\r
 232    * Method getNameSpacePrefix.\r
 233    * \r
 234    * @return the namespace prefix to use when marshaling as XML.\r
 235    */\r
 236   public java.lang.String getNameSpacePrefix() {\r
 237     return _nsPrefix;\r
 238   }\r
 239 \r
 240   /**\r
 241    * Method getNameSpaceURI.\r
 242    * \r
 243    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 244    */\r
 245   public java.lang.String getNameSpaceURI() {\r
 246     return _nsURI;\r
 247   }\r
 248 \r
 249   /**\r
 250    * Method getValidator.\r
 251    * \r
 252    * @return a specific validator for the class described by this\r
 253    *         ClassDescriptor.\r
 254    */\r
 255   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 256     return this;\r
 257   }\r
 258 \r
 259   /**\r
 260    * Method getXMLName.\r
 261    * \r
 262    * @return the XML Name for the Class being described.\r
 263    */\r
 264   public java.lang.String getXMLName() {\r
 265     return _xmlName;\r
 266   }\r
 267 \r
 268   /**\r
 269    * Method isElementDefinition.\r
 270    * \r
 271    * @return true if XML schema definition of this Class is that of a global\r
 272    *         element or element with anonymous type definition.\r
 273    */\r
 274   public boolean isElementDefinition() {\r
 275     return _elementDefinition;\r
 276   }\r
 277 \r
 278 }\r