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