src/uk/ac/vamsas/objects/core/descriptors/AlignmentSequenceDescriptor.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.AlignmentSequence;\r
  29 \r
  30 /**\r
  31  * Class AlignmentSequenceDescriptor.\r
  32  * \r
  33  * @version $Revision$ $Date$\r
  34  */\r
  35 public class AlignmentSequenceDescriptor extends\r
  36     uk.ac.vamsas.objects.core.descriptors.SequenceTypeDescriptor {\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 AlignmentSequenceDescriptor() {\r
  67     super();\r
  68     setExtendsWithoutFlatten(new uk.ac.vamsas.objects.core.descriptors.SequenceTypeDescriptor());\r
  69     _nsURI = "http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes";\r
  70     _xmlName = "alignmentSequence";\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     // -- _id\r
  81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
  82         java.lang.String.class, "_id", "id",\r
  83         org.exolab.castor.xml.NodeType.Attribute);\r
  84     super.setIdentity(desc);\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         AlignmentSequence target = (AlignmentSequence) object;\r
  89         return target.getId();\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           AlignmentSequence target = (AlignmentSequence) object;\r
  96           target.setId((java.lang.String) 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.String();\r
 104       }\r
 105     };\r
 106     desc.setHandler(handler);\r
 107     desc.setMultivalued(false);\r
 108     addFieldDescriptor(desc);\r
 109 \r
 110     // -- validation code for: _id\r
 111     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 112     { // -- local scope\r
 113       org.exolab.castor.xml.validators.IdValidator typeValidator;\r
 114       typeValidator = new org.exolab.castor.xml.validators.IdValidator();\r
 115       fieldValidator.setValidator(typeValidator);\r
 116     }\r
 117     desc.setValidator(fieldValidator);\r
 118     // -- _refid\r
 119     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 120         java.lang.Object.class, "_refid", "refid",\r
 121         org.exolab.castor.xml.NodeType.Attribute);\r
 122     desc.setReference(true);\r
 123     handler = new org.exolab.castor.xml.XMLFieldHandler() {\r
 124       public java.lang.Object getValue(java.lang.Object object)\r
 125           throws IllegalStateException {\r
 126         AlignmentSequence target = (AlignmentSequence) object;\r
 127         return target.getRefid();\r
 128       }\r
 129 \r
 130       public void setValue(java.lang.Object object, java.lang.Object value)\r
 131           throws IllegalStateException, IllegalArgumentException {\r
 132         try {\r
 133           AlignmentSequence target = (AlignmentSequence) object;\r
 134           target.setRefid((java.lang.Object) value);\r
 135         } catch (java.lang.Exception ex) {\r
 136           throw new IllegalStateException(ex.toString());\r
 137         }\r
 138       }\r
 139 \r
 140       public java.lang.Object newInstance(java.lang.Object parent) {\r
 141         return new java.lang.Object();\r
 142       }\r
 143     };\r
 144     desc.setHandler(handler);\r
 145     desc.setRequired(true);\r
 146     desc.setMultivalued(false);\r
 147     addFieldDescriptor(desc);\r
 148 \r
 149     // -- validation code for: _refid\r
 150     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 151     fieldValidator.setMinOccurs(1);\r
 152     { // -- local scope\r
 153       org.exolab.castor.xml.validators.IdRefValidator typeValidator;\r
 154       typeValidator = new org.exolab.castor.xml.validators.IdRefValidator();\r
 155       fieldValidator.setValidator(typeValidator);\r
 156     }\r
 157     desc.setValidator(fieldValidator);\r
 158     // -- initialize element descriptors\r
 159 \r
 160     // -- _alignmentSequenceAnnotationList\r
 161     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(\r
 162         uk.ac.vamsas.objects.core.AlignmentSequenceAnnotation.class,\r
 163         "_alignmentSequenceAnnotationList", "AlignmentSequenceAnnotation",\r
 164         org.exolab.castor.xml.NodeType.Element);\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         AlignmentSequence target = (AlignmentSequence) object;\r
 169         return target.getAlignmentSequenceAnnotation();\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           AlignmentSequence target = (AlignmentSequence) object;\r
 176           target\r
 177               .addAlignmentSequenceAnnotation((uk.ac.vamsas.objects.core.AlignmentSequenceAnnotation) value);\r
 178         } catch (java.lang.Exception ex) {\r
 179           throw new IllegalStateException(ex.toString());\r
 180         }\r
 181       }\r
 182 \r
 183       public void resetValue(Object object) throws IllegalStateException,\r
 184           IllegalArgumentException {\r
 185         try {\r
 186           AlignmentSequence target = (AlignmentSequence) object;\r
 187           target.removeAllAlignmentSequenceAnnotation();\r
 188         } catch (java.lang.Exception ex) {\r
 189           throw new IllegalStateException(ex.toString());\r
 190         }\r
 191       }\r
 192 \r
 193       public java.lang.Object newInstance(java.lang.Object parent) {\r
 194         return new uk.ac.vamsas.objects.core.AlignmentSequenceAnnotation();\r
 195       }\r
 196     };\r
 197     desc.setHandler(handler);\r
 198     desc.setNameSpaceURI("http://www.vamsas.ac.uk/schemas/1.0/vamsasTypes");\r
 199     desc.setMultivalued(true);\r
 200     addFieldDescriptor(desc);\r
 201 \r
 202     // -- validation code for: _alignmentSequenceAnnotationList\r
 203     fieldValidator = new org.exolab.castor.xml.FieldValidator();\r
 204     fieldValidator.setMinOccurs(0);\r
 205     { // -- local scope\r
 206     }\r
 207     desc.setValidator(fieldValidator);\r
 208   }\r
 209 \r
 210   // -----------/\r
 211   // - Methods -/\r
 212   // -----------/\r
 213 \r
 214   /**\r
 215    * Method getAccessMode.\r
 216    * \r
 217    * @return the access mode specified for this class.\r
 218    */\r
 219   public org.exolab.castor.mapping.AccessMode getAccessMode() {\r
 220     return null;\r
 221   }\r
 222 \r
 223   /**\r
 224    * Method getIdentity.\r
 225    * \r
 226    * @return the identity field, null if this class has no identity.\r
 227    */\r
 228   public org.exolab.castor.mapping.FieldDescriptor getIdentity() {\r
 229     return super.getIdentity();\r
 230   }\r
 231 \r
 232   /**\r
 233    * Method getJavaClass.\r
 234    * \r
 235    * @return the Java class represented by this descriptor.\r
 236    */\r
 237   public java.lang.Class getJavaClass() {\r
 238     return uk.ac.vamsas.objects.core.AlignmentSequence.class;\r
 239   }\r
 240 \r
 241   /**\r
 242    * Method getNameSpacePrefix.\r
 243    * \r
 244    * @return the namespace prefix to use when marshaling as XML.\r
 245    */\r
 246   public java.lang.String getNameSpacePrefix() {\r
 247     return _nsPrefix;\r
 248   }\r
 249 \r
 250   /**\r
 251    * Method getNameSpaceURI.\r
 252    * \r
 253    * @return the namespace URI used when marshaling and unmarshaling as XML.\r
 254    */\r
 255   public java.lang.String getNameSpaceURI() {\r
 256     return _nsURI;\r
 257   }\r
 258 \r
 259   /**\r
 260    * Method getValidator.\r
 261    * \r
 262    * @return a specific validator for the class described by this\r
 263    *         ClassDescriptor.\r
 264    */\r
 265   public org.exolab.castor.xml.TypeValidator getValidator() {\r
 266     return this;\r
 267   }\r
 268 \r
 269   /**\r
 270    * Method getXMLName.\r
 271    * \r
 272    * @return the XML Name for the Class being described.\r
 273    */\r
 274   public java.lang.String getXMLName() {\r
 275     return _xmlName;\r
 276   }\r
 277 \r
 278   /**\r
 279    * Method isElementDefinition.\r
 280    * \r
 281    * @return true if XML schema definition of this Class is that of a global\r
 282    *         element or element with anonymous type definition.\r
 283    */\r
 284   public boolean isElementDefinition() {\r
 285     return _elementDefinition;\r
 286   }\r
 287 \r
 288 }\r