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