src/uk/ac/vamsas/objects/core/descriptors/ReferenceTypeDescriptor.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.ReferenceType;\r
  29 \r
  30 /**\r
  31  * Class ReferenceTypeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class ReferenceTypeDescriptor 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 ReferenceTypeDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "referenceType";\r
  70     _elementDefinition = false;\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         ReferenceType target = (ReferenceType) 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           ReferenceType target = (ReferenceType) 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     // -- _id\r
 115     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 116         java.lang.String.class, "_id", "id",\r
 117         org.exolab.castor.xml.NodeType.Attribute);\r
 118     super.setIdentity(desc);\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         ReferenceType target = (ReferenceType) object;\r
 123         return target.getId();\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           ReferenceType target = (ReferenceType) object;\r
 130           target.setId((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 new java.lang.String();\r
 138       }\r
 139     };\r
 140     desc.setHandler(handler);\r
 141     desc.setMultivalued(false);\r
 142     addFieldDescriptor(desc);\r
 143 \r
 144     // -- validation code for: _id\r
 145     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 146     { // -- local scope\r
 147       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 148       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 149       fieldValidator.setValidator(typeValidator);\r
 150     }\r
 151     desc.setValidator(fieldValidator);\r
 152     // -- _refs\r
 153     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 154         java.lang.Object.class, "_refs", "refs",\r
 155         org.exolab.castor.xml.NodeType.Attribute);\r
 156     desc.setReference(true);\r
 157     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 158       public java.lang.Object getValue(java.lang.Object object)\r
 159           throws IllegalStateException {\r
 160         ReferenceType target = (ReferenceType) object;\r
 161         return target.getRefs();\r
 162       }\r
 163 \r
 164       public void setValue(java.lang.Object object, java.lang.Object value)\r
 165           throws IllegalStateException, IllegalArgumentException {\r
 166         try {\r
 167           ReferenceType target = (ReferenceType) object;\r
 168           target.addRefs((java.lang.Object) value);\r
 169         } catch (java.lang.Exception ex) {\r
 170           throw new IllegalStateException(ex.toString());\r
 171         }\r
 172       }\r
 173 \r
 174       public void resetValue(Object object) throws IllegalStateException,\r
 175           IllegalArgumentException {\r
 176         try {\r
 177           ReferenceType target = (ReferenceType) object;\r
 178           target.removeAllRefs();\r
 179         } catch (java.lang.Exception ex) {\r
 180           throw new IllegalStateException(ex.toString());\r
 181         }\r
 182       }\r
 183 \r
 184       public java.lang.Object newInstance(java.lang.Object parent) {\r
 185         return new java.lang.Object();\r
 186       }\r
 187     };\r
 188     desc.setMultivalued(true);\r
 189     desc.setHandler(handler);\r
 190     desc.setMultivalued(true);\r
 191     addFieldDescriptor(desc);\r
 192 \r
 193     // -- validation code for: _refs\r
 194     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 195     fieldValidator.setMinOccurs(0);\r
 196     { // -- local scope\r
 197       org.exolab.castor.xml.validators.IdRefsValidator typeValidator = new org.exolab.castor.xml.validators.IdRefsValidator();\r
 198       fieldValidator.setValidator(typeValidator);\r
 199       desc.setValidator(fieldValidator);\r
 200     }\r
 201     desc.setValidator(fieldValidator);\r
 202     // -- initialize element descriptors\r
 203 \r
 204   }\r
 205 \r
 206   // -----------/\r
 207   // - Methods -/\r
 208   // -----------/\r
 209 \r
 210   /**\r
 211    * Method getAccessMode.\r
 212    * \r
 213    * @return the access mode specified for this class.\r
 214    */\r
 215   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 216     return null;\r
 217   }\r
 218 \r
 219   /**\r
 220    * Method getIdentity.\r
 221    * \r
 222    * @return the identity field, null if this class has no identity.\r
 223    */\r
 224   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 225     return super.getIdentity();\r
 226   }\r
 227 \r
 228   /**\r
 229    * Method getJavaClass.\r
 230    * \r
 231    * @return the Java class represented by this descriptor.\r
 232    */\r
 233   public java.lang.Class getJavaClass() {\r
 234     return uk.ac.vamsas.objects.core.ReferenceType.class;\r
 235   }\r
 236 \r
 237   /**\r
 238    * Method getNameSpacePrefix.\r
 239    * \r
 240    * @return the namespace prefix to use when marshaling as XML.\r
 241    */\r
 242   public java.lang.String getNameSpacePrefix() {\r
 243     return _nsPrefix;\r
 244   }\r
 245 \r
 246   /**\r
 247    * Method getNameSpaceURI.\r
 248    * \r
 249    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 250    */\r
 251   public java.lang.String getNameSpaceURI() {\r
 252     return _nsURI;\r
 253   }\r
 254 \r
 255   /**\r
 256    * Method getValidator.\r
 257    * \r
 258    * @return a specific validator for the class described by this\r
 259    *         ClassDescriptor.\r
 260    */\r
 261   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 262     return this;\r
 263   }\r
 264 \r
 265   /**\r
 266    * Method getXMLName.\r
 267    * \r
 268    * @return the XML Name for the Class being described.\r
 269    */\r
 270   public java.lang.String getXMLName() {\r
 271     return _xmlName;\r
 272   }\r
 273 \r
 274   /**\r
 275    * Method isElementDefinition.\r
 276    * \r
 277    * @return true if XML schema definition of this Class is that of a global\r
 278    *         element or element with anonymous type definition.\r
 279    */\r
 280   public boolean isElementDefinition() {\r
 281     return _elementDefinition;\r
 282   }\r
 283 \r
 284 }\r