src/uk/ac/vamsas/objects/core/descriptors/MapRangeTypeDescriptor.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.MapRangeType;\r
  29 \r
  30 /**\r
  31  * Class MapRangeTypeDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class MapRangeTypeDescriptor extends\r
  36     uk.ac.vamsas.objects.core.descriptors.RangeTypeDescriptor {\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 MapRangeTypeDescriptor() {\r
  67     super();\r
  68     setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.RangeTypeDescriptor());\r
  69     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  70     _xmlName = "mapRangeType";\r
  71     _elementDefinition = false;\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     // -- _unit\r
  78     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  79         java.lang.Long.TYPE, "_unit", "unit",\r
  80         org.exolab.castor.xml.NodeType.Attribute);\r
  81     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  82       public java.lang.Object getValue(java.lang.Object object)\r
  83           throws IllegalStateException {\r
  84         MapRangeType target = (MapRangeType) object;\r
  85         if (!target.hasUnit()) {\r
  86           return null;\r
  87         }\r
  88         return new java.lang.Long(target.getUnit());\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           MapRangeType target = (MapRangeType) object;\r
  95           // if null, use delete method for optional primitives\r
  96           if (value == null) {\r
  97             target.deleteUnit();\r
  98             return;\r
  99           }\r
 100           target.setUnit(((java.lang.Long) value).longValue());\r
 101         } catch (java.lang.Exception ex) {\r
 102           throw new IllegalStateException(ex.toString());\r
 103         }\r
 104       }\r
 105 \r
 106       public java.lang.Object newInstance(java.lang.Object parent) {\r
 107         return null;\r
 108       }\r
 109     };\r
 110     desc.setHandler(handler);\r
 111     desc.setMultivalued(false);\r
 112     addFieldDescriptor(desc);\r
 113 \r
 114     // -- validation code for: _unit\r
 115     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 116     { // -- local scope\r
 117       org.exolab.castor.xml.validators.LongValidator typeValidator;\r
 118       typeValidator = new org.exolab.castor.xml.validators.LongValidator();\r
 119       fieldValidator.setValidator(typeValidator);\r
 120       typeValidator.setMinInclusive(1L);\r
 121     }\r
 122     desc.setValidator(fieldValidator);\r
 123     // -- initialize element descriptors\r
 124 \r
 125   }\r
 126 \r
 127   // -----------/\r
 128   // - Methods -/\r
 129   // -----------/\r
 130 \r
 131   /**\r
 132    * Method getAccessMode.\r
 133    * \r
 134    * @return the access mode specified for this class.\r
 135    */\r
 136   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 137     return null;\r
 138   }\r
 139 \r
 140   /**\r
 141    * Method getIdentity.\r
 142    * \r
 143    * @return the identity field, null if this class has no identity.\r
 144    */\r
 145   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 146     return super.getIdentity();\r
 147   }\r
 148 \r
 149   /**\r
 150    * Method getJavaClass.\r
 151    * \r
 152    * @return the Java class represented by this descriptor.\r
 153    */\r
 154   public java.lang.Class getJavaClass() {\r
 155     return uk.ac.vamsas.objects.core.MapRangeType.class;\r
 156   }\r
 157 \r
 158   /**\r
 159    * Method getNameSpacePrefix.\r
 160    * \r
 161    * @return the namespace prefix to use when marshaling as XML.\r
 162    */\r
 163   public java.lang.String getNameSpacePrefix() {\r
 164     return _nsPrefix;\r
 165   }\r
 166 \r
 167   /**\r
 168    * Method getNameSpaceURI.\r
 169    * \r
 170    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 171    */\r
 172   public java.lang.String getNameSpaceURI() {\r
 173     return _nsURI;\r
 174   }\r
 175 \r
 176   /**\r
 177    * Method getValidator.\r
 178    * \r
 179    * @return a specific validator for the class described by this\r
 180    *         ClassDescriptor.\r
 181    */\r
 182   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 183     return this;\r
 184   }\r
 185 \r
 186   /**\r
 187    * Method getXMLName.\r
 188    * \r
 189    * @return the XML Name for the Class being described.\r
 190    */\r
 191   public java.lang.String getXMLName() {\r
 192     return _xmlName;\r
 193   }\r
 194 \r
 195   /**\r
 196    * Method isElementDefinition.\r
 197    * \r
 198    * @return true if XML schema definition of this Class is that of a global\r
 199    *         element or element with anonymous type definition.\r
 200    */\r
 201   public boolean isElementDefinition() {\r
 202     return _elementDefinition;\r
 203   }\r
 204 \r
 205 }\r