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