src/uk/ac/vamsas/objects/core/descriptors/DataSetAnnotationsDescriptor.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.DataSetAnnotations;\r
  29 \r
  30 /**\r
  31  * Class DataSetAnnotationsDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class DataSetAnnotationsDescriptor extends\r
  36     uk.ac.vamsas.objects.core.descriptors.RangeAnnotationDescriptor {\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 DataSetAnnotationsDescriptor() {\r
  67     super();\r
  68     setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.RangeAnnotationDescriptor());\r
  69     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  70     _xmlName = "DataSetAnnotations";\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     // -- _seqRef\r
  81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  82         java.lang.Object.class, "_seqRef", "seqRef",\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         DataSetAnnotations target = (DataSetAnnotations) object;\r
  89         return target.getSeqRef();\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           DataSetAnnotations target = (DataSetAnnotations) object;\r
  96           target.addSeqRef((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 void resetValue(Object object) throws IllegalStateException,\r
 103           IllegalArgumentException {\r
 104         try {\r
 105           DataSetAnnotations target = (DataSetAnnotations) object;\r
 106           target.removeAllSeqRef();\r
 107         } catch (java.lang.Exception ex) {\r
 108           throw new IllegalStateException(ex.toString());\r
 109         }\r
 110       }\r
 111 \r
 112       public java.lang.Object newInstance(java.lang.Object parent) {\r
 113         return new java.lang.Object();\r
 114       }\r
 115     };\r
 116     desc.setMultivalued(true);\r
 117     desc.setHandler(handler);\r
 118     desc.setRequired(true);\r
 119     desc.setMultivalued(true);\r
 120     addFieldDescriptor(desc);\r
 121 \r
 122     // -- validation code for: _seqRef\r
 123     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 124     fieldValidator.setMinOccurs(0);\r
 125     { // -- local scope\r
 126       org.exolab.castor.xml.validators.IdRefsValidator typeValidator = new org.exolab.castor.xml.validators.IdRefsValidator();\r
 127       fieldValidator.setValidator(typeValidator);\r
 128       desc.setValidator(fieldValidator);\r
 129     }\r
 130     desc.setValidator(fieldValidator);\r
 131     // -- initialize element descriptors\r
 132 \r
 133     // -- _provenance\r
 134     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 135         uk.ac.vamsas.objects.core.Provenance.class, "_provenance",\r
 136         "Provenance", org.exolab.castor.xml.NodeType.Element);\r
 137     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 138       public java.lang.Object getValue(java.lang.Object object)\r
 139           throws IllegalStateException {\r
 140         DataSetAnnotations target = (DataSetAnnotations) object;\r
 141         return target.getProvenance();\r
 142       }\r
 143 \r
 144       public void setValue(java.lang.Object object, java.lang.Object value)\r
 145           throws IllegalStateException, IllegalArgumentException {\r
 146         try {\r
 147           DataSetAnnotations target = (DataSetAnnotations) object;\r
 148           target.setProvenance((uk.ac.vamsas.objects.core.Provenance) value);\r
 149         } catch (java.lang.Exception ex) {\r
 150           throw new IllegalStateException(ex.toString());\r
 151         }\r
 152       }\r
 153 \r
 154       public java.lang.Object newInstance(java.lang.Object parent) {\r
 155         return new uk.ac.vamsas.objects.core.Provenance();\r
 156       }\r
 157     };\r
 158     desc.setHandler(handler);\r
 159     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 160     desc.setRequired(true);\r
 161     desc.setMultivalued(false);\r
 162     addFieldDescriptor(desc);\r
 163 \r
 164     // -- validation code for: _provenance\r
 165     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 166     fieldValidator.setMinOccurs(1);\r
 167     { // -- local scope\r
 168     }\r
 169     desc.setValidator(fieldValidator);\r
 170   }\r
 171 \r
 172   // -----------/\r
 173   // - Methods -/\r
 174   // -----------/\r
 175 \r
 176   /**\r
 177    * Method getAccessMode.\r
 178    * \r
 179    * @return the access mode specified for this class.\r
 180    */\r
 181   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 182     return null;\r
 183   }\r
 184 \r
 185   /**\r
 186    * Method getIdentity.\r
 187    * \r
 188    * @return the identity field, null if this class has no identity.\r
 189    */\r
 190   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 191     return super.getIdentity();\r
 192   }\r
 193 \r
 194   /**\r
 195    * Method getJavaClass.\r
 196    * \r
 197    * @return the Java class represented by this descriptor.\r
 198    */\r
 199   public java.lang.Class getJavaClass() {\r
 200     return uk.ac.vamsas.objects.core.DataSetAnnotations.class;\r
 201   }\r
 202 \r
 203   /**\r
 204    * Method getNameSpacePrefix.\r
 205    * \r
 206    * @return the namespace prefix to use when marshaling as XML.\r
 207    */\r
 208   public java.lang.String getNameSpacePrefix() {\r
 209     return _nsPrefix;\r
 210   }\r
 211 \r
 212   /**\r
 213    * Method getNameSpaceURI.\r
 214    * \r
 215    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 216    */\r
 217   public java.lang.String getNameSpaceURI() {\r
 218     return _nsURI;\r
 219   }\r
 220 \r
 221   /**\r
 222    * Method getValidator.\r
 223    * \r
 224    * @return a specific validator for the class described by this\r
 225    *         ClassDescriptor.\r
 226    */\r
 227   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 228     return this;\r
 229   }\r
 230 \r
 231   /**\r
 232    * Method getXMLName.\r
 233    * \r
 234    * @return the XML Name for the Class being described.\r
 235    */\r
 236   public java.lang.String getXMLName() {\r
 237     return _xmlName;\r
 238   }\r
 239 \r
 240   /**\r
 241    * Method isElementDefinition.\r
 242    * \r
 243    * @return true if XML schema definition of this Class is that of a global\r
 244    *         element or element with anonymous type definition.\r
 245    */\r
 246   public boolean isElementDefinition() {\r
 247     return _elementDefinition;\r
 248   }\r
 249 \r
 250 }\r