src/uk/ac/vamsas/objects/core/descriptors/GlyphDescriptor.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.Glyph;\r
  29 \r
  30 /**\r
  31  * Class GlyphDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class GlyphDescriptor 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 GlyphDescriptor() {\r
  67     super();\r
  68     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  69     _xmlName = "glyph";\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         Glyph target = (Glyph) 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           Glyph target = (Glyph) 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     // -- _dict\r
 115     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 116         java.lang.String.class, "_dict", "dict",\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         Glyph target = (Glyph) object;\r
 123         return target.getDict();\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           Glyph target = (Glyph) object;\r
 130           target.setDict((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.setMultivalued(false);\r
 142     addFieldDescriptor(desc);\r
 143 \r
 144     // -- validation code for: _dict\r
 145     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 146     { // -- local scope\r
 147       org.exolab.castor.xml.validators.StringValidator typeValidator;\r
 148       typeValidator = new org.exolab.castor.xml.validators.StringValidator();\r
 149       fieldValidator.setValidator(typeValidator);\r
 150       typeValidator.setWhiteSpace("preserve");\r
 151     }\r
 152     desc.setValidator(fieldValidator);\r
 153     // -- initialize element descriptors\r
 154 \r
 155   }\r
 156 \r
 157   // -----------/\r
 158   // - Methods -/\r
 159   // -----------/\r
 160 \r
 161   /**\r
 162    * Method getAccessMode.\r
 163    * \r
 164    * @return the access mode specified for this class.\r
 165    */\r
 166   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 167     return null;\r
 168   }\r
 169 \r
 170   /**\r
 171    * Method getIdentity.\r
 172    * \r
 173    * @return the identity field, null if this class has no identity.\r
 174    */\r
 175   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 176     return super.getIdentity();\r
 177   }\r
 178 \r
 179   /**\r
 180    * Method getJavaClass.\r
 181    * \r
 182    * @return the Java class represented by this descriptor.\r
 183    */\r
 184   public java.lang.Class getJavaClass() {\r
 185     return uk.ac.vamsas.objects.core.Glyph.class;\r
 186   }\r
 187 \r
 188   /**\r
 189    * Method getNameSpacePrefix.\r
 190    * \r
 191    * @return the namespace prefix to use when marshaling as XML.\r
 192    */\r
 193   public java.lang.String getNameSpacePrefix() {\r
 194     return _nsPrefix;\r
 195   }\r
 196 \r
 197   /**\r
 198    * Method getNameSpaceURI.\r
 199    * \r
 200    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 201    */\r
 202   public java.lang.String getNameSpaceURI() {\r
 203     return _nsURI;\r
 204   }\r
 205 \r
 206   /**\r
 207    * Method getValidator.\r
 208    * \r
 209    * @return a specific validator for the class described by this\r
 210    *         ClassDescriptor.\r
 211    */\r
 212   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 213     return this;\r
 214   }\r
 215 \r
 216   /**\r
 217    * Method getXMLName.\r
 218    * \r
 219    * @return the XML Name for the Class being described.\r
 220    */\r
 221   public java.lang.String getXMLName() {\r
 222     return _xmlName;\r
 223   }\r
 224 \r
 225   /**\r
 226    * Method isElementDefinition.\r
 227    * \r
 228    * @return true if XML schema definition of this Class is that of a global\r
 229    *         element or element with anonymous type definition.\r
 230    */\r
 231   public boolean isElementDefinition() {\r
 232     return _elementDefinition;\r
 233   }\r
 234 \r
 235 }\r