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