src/uk/ac/vamsas/objects/core/descriptors/SequenceMappingDescriptor.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.SequenceMapping;\r
  29 \r
  30 /**\r
  31  * Class SequenceMappingDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class SequenceMappingDescriptor 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 SequenceMappingDescriptor() {\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 = "sequenceMapping";\r
  71     _elementDefinition = true;\r
  72 \r
  73     // -- set grouping compositor\r
  74     setCompositorAsSequence();\r
  75     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;\r
  76     org.exolab.castor.mapping.FieldHandler handler = null;\r
  77     org.exolab.castor.xml.FieldValidator fieldValidator = null;\r
  78     // -- initialize attribute descriptors\r
  79 \r
  80     // -- _loc\r
  81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  82         java.lang.Object.class, "_loc", "loc",\r
  83         org.exolab.castor.xml.NodeType.Attribute);\r
  84     desc.setReference(true);\r
  85     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
  86       public java.lang.Object getValue(java.lang.Object object)\r
  87           throws IllegalStateException {\r
  88         SequenceMapping target = (SequenceMapping) object;\r
  89         return target.getLoc();\r
  90       }\r
  91 \r
  92       public void setValue(java.lang.Object object, java.lang.Object value)\r
  93           throws IllegalStateException, IllegalArgumentException {\r
  94         try {\r
  95           SequenceMapping target = (SequenceMapping) object;\r
  96           target.setLoc((java.lang.Object) value);\r
  97         } catch (java.lang.Exception ex) {\r
  98           throw new IllegalStateException(ex.toString());\r
  99         }\r
 100       }\r
 101 \r
 102       public java.lang.Object newInstance(java.lang.Object parent) {\r
 103         return new java.lang.Object();\r
 104       }\r
 105     };\r
 106     desc.setHandler(handler);\r
 107     desc.setRequired(true);\r
 108     desc.setMultivalued(false);\r
 109     addFieldDescriptor(desc);\r
 110 \r
 111     // -- validation code for: _loc\r
 112     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 113     fieldValidator.setMinOccurs(1);\r
 114     { // -- local scope\r
 115       org.exolab.castor.xml.validators.IdRefValidator typeValidator;\r
 116       typeValidator = new org.exolab.castor.xml.validators.IdRefValidator();\r
 117       fieldValidator.setValidator(typeValidator);\r
 118     }\r
 119     desc.setValidator(fieldValidator);\r
 120     // -- _map\r
 121     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 122         java.lang.Object.class, "_map", "map",\r
 123         org.exolab.castor.xml.NodeType.Attribute);\r
 124     desc.setReference(true);\r
 125     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 126       public java.lang.Object getValue(java.lang.Object object)\r
 127           throws IllegalStateException {\r
 128         SequenceMapping target = (SequenceMapping) object;\r
 129         return target.getMap();\r
 130       }\r
 131 \r
 132       public void setValue(java.lang.Object object, java.lang.Object value)\r
 133           throws IllegalStateException, IllegalArgumentException {\r
 134         try {\r
 135           SequenceMapping target = (SequenceMapping) object;\r
 136           target.setMap((java.lang.Object) value);\r
 137         } catch (java.lang.Exception ex) {\r
 138           throw new IllegalStateException(ex.toString());\r
 139         }\r
 140       }\r
 141 \r
 142       public java.lang.Object newInstance(java.lang.Object parent) {\r
 143         return new java.lang.Object();\r
 144       }\r
 145     };\r
 146     desc.setHandler(handler);\r
 147     desc.setRequired(true);\r
 148     desc.setMultivalued(false);\r
 149     addFieldDescriptor(desc);\r
 150 \r
 151     // -- validation code for: _map\r
 152     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 153     fieldValidator.setMinOccurs(1);\r
 154     { // -- local scope\r
 155       org.exolab.castor.xml.validators.IdRefValidator typeValidator;\r
 156       typeValidator = new org.exolab.castor.xml.validators.IdRefValidator();\r
 157       fieldValidator.setValidator(typeValidator);\r
 158     }\r
 159     desc.setValidator(fieldValidator);\r
 160     // -- _id\r
 161     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 162         java.lang.String.class, "_id", "id",\r
 163         org.exolab.castor.xml.NodeType.Attribute);\r
 164     super.setIdentity(desc);\r
 165     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 166       public java.lang.Object getValue(java.lang.Object object)\r
 167           throws IllegalStateException {\r
 168         SequenceMapping target = (SequenceMapping) object;\r
 169         return target.getId();\r
 170       }\r
 171 \r
 172       public void setValue(java.lang.Object object, java.lang.Object value)\r
 173           throws IllegalStateException, IllegalArgumentException {\r
 174         try {\r
 175           SequenceMapping target = (SequenceMapping) object;\r
 176           target.setId((java.lang.String) value);\r
 177         } catch (java.lang.Exception ex) {\r
 178           throw new IllegalStateException(ex.toString());\r
 179         }\r
 180       }\r
 181 \r
 182       public java.lang.Object newInstance(java.lang.Object parent) {\r
 183         return new java.lang.String();\r
 184       }\r
 185     };\r
 186     desc.setHandler(handler);\r
 187     desc.setMultivalued(false);\r
 188     addFieldDescriptor(desc);\r
 189 \r
 190     // -- validation code for: _id\r
 191     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 192     { // -- local scope\r
 193       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 194       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 195       fieldValidator.setValidator(typeValidator);\r
 196     }\r
 197     desc.setValidator(fieldValidator);\r
 198     // -- initialize element descriptors\r
 199 \r
 200     // -- _provenance\r
 201     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 202         uk.ac.vamsas.objects.core.Provenance.class, "_provenance",\r
 203         "Provenance", org.exolab.castor.xml.NodeType.Element);\r
 204     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 205       public java.lang.Object getValue(java.lang.Object object)\r
 206           throws IllegalStateException {\r
 207         SequenceMapping target = (SequenceMapping) object;\r
 208         return target.getProvenance();\r
 209       }\r
 210 \r
 211       public void setValue(java.lang.Object object, java.lang.Object value)\r
 212           throws IllegalStateException, IllegalArgumentException {\r
 213         try {\r
 214           SequenceMapping target = (SequenceMapping) object;\r
 215           target.setProvenance((uk.ac.vamsas.objects.core.Provenance) value);\r
 216         } catch (java.lang.Exception ex) {\r
 217           throw new IllegalStateException(ex.toString());\r
 218         }\r
 219       }\r
 220 \r
 221       public java.lang.Object newInstance(java.lang.Object parent) {\r
 222         return new uk.ac.vamsas.objects.core.Provenance();\r
 223       }\r
 224     };\r
 225     desc.setHandler(handler);\r
 226     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 227     desc.setRequired(true);\r
 228     desc.setMultivalued(false);\r
 229     addFieldDescriptor(desc);\r
 230 \r
 231     // -- validation code for: _provenance\r
 232     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 233     fieldValidator.setMinOccurs(1);\r
 234     { // -- local scope\r
 235     }\r
 236     desc.setValidator(fieldValidator);\r
 237   }\r
 238 \r
 239   // -----------/\r
 240   // - Methods -/\r
 241   // -----------/\r
 242 \r
 243   /**\r
 244    * Method getAccessMode.\r
 245    * \r
 246    * @return the access mode specified for this class.\r
 247    */\r
 248   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 249     return null;\r
 250   }\r
 251 \r
 252   /**\r
 253    * Method getIdentity.\r
 254    * \r
 255    * @return the identity field, null if this class has no identity.\r
 256    */\r
 257   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 258     return super.getIdentity();\r
 259   }\r
 260 \r
 261   /**\r
 262    * Method getJavaClass.\r
 263    * \r
 264    * @return the Java class represented by this descriptor.\r
 265    */\r
 266   public java.lang.Class getJavaClass() {\r
 267     return uk.ac.vamsas.objects.core.SequenceMapping.class;\r
 268   }\r
 269 \r
 270   /**\r
 271    * Method getNameSpacePrefix.\r
 272    * \r
 273    * @return the namespace prefix to use when marshaling as XML.\r
 274    */\r
 275   public java.lang.String getNameSpacePrefix() {\r
 276     return _nsPrefix;\r
 277   }\r
 278 \r
 279   /**\r
 280    * Method getNameSpaceURI.\r
 281    * \r
 282    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 283    */\r
 284   public java.lang.String getNameSpaceURI() {\r
 285     return _nsURI;\r
 286   }\r
 287 \r
 288   /**\r
 289    * Method getValidator.\r
 290    * \r
 291    * @return a specific validator for the class described by this\r
 292    *         ClassDescriptor.\r
 293    */\r
 294   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 295     return this;\r
 296   }\r
 297 \r
 298   /**\r
 299    * Method getXMLName.\r
 300    * \r
 301    * @return the XML Name for the Class being described.\r
 302    */\r
 303   public java.lang.String getXMLName() {\r
 304     return _xmlName;\r
 305   }\r
 306 \r
 307   /**\r
 308    * Method isElementDefinition.\r
 309    * \r
 310    * @return true if XML schema definition of this Class is that of a global\r
 311    *         element or element with anonymous type definition.\r
 312    */\r
 313   public boolean isElementDefinition() {\r
 314     return _elementDefinition;\r
 315   }\r
 316 \r
 317 }\r