src/jalview/schemabinding/version2/descriptors/SequenceSetDescriptor.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.2b1)
   3  * Copyright (C) 2014 The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.schemabinding.version2.descriptors;
  22
  23 //---------------------------------/
  24 //- Imported classes and packages -/
  25 //---------------------------------/
  26
  27 import jalview.schemabinding.version2.SequenceSet;
  28
  29 /**
  30  * Class SequenceSetDescriptor.
  31  *
  32  * @version $Revision$ $Date$
  33  */
  34 public class SequenceSetDescriptor extends
  35         org.exolab.castor.xml.util.XMLClassDescriptorImpl
  36 {
  37
  38   // --------------------------/
  39   // - Class/Member Variables -/
  40   // --------------------------/
  41
  42   /**
  43    * Field _elementDefinition.
  44    */
  45   private boolean _elementDefinition;
  46
  47   /**
  48    * Field _nsPrefix.
  49    */
  50   private java.lang.String _nsPrefix;
  51
  52   /**
  53    * Field _nsURI.
  54    */
  55   private java.lang.String _nsURI;
  56
  57   /**
  58    * Field _xmlName.
  59    */
  60   private java.lang.String _xmlName;
  61
  62   // ----------------/
  63   // - Constructors -/
  64   // ----------------/
  65
  66   public SequenceSetDescriptor()
  67   {
  68     super();
  69     _nsURI = "www.vamsas.ac.uk/jalview/version2";
  70     _xmlName = "SequenceSet";
  71     _elementDefinition = true;
  72
  73     // -- set grouping compositor
  74     setCompositorAsSequence();
  75     org.exolab.castor.xml.util.XMLFieldDescriptorImpl desc = null;
  76     org.exolab.castor.mapping.FieldHandler handler = null;
  77     org.exolab.castor.xml.FieldValidator fieldValidator = null;
  78     // -- initialize attribute descriptors
  79
  80     // -- _gapChar
  81     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
  82             java.lang.String.class, "_gapChar", "gapChar",
  83             org.exolab.castor.xml.NodeType.Attribute);
  84     desc.setImmutable(true);
  85     handler = new org.exolab.castor.xml.XMLFieldHandler()
  86     {
  87       public java.lang.Object getValue(java.lang.Object object)
  88               throws IllegalStateException
  89       {
  90         SequenceSet target = (SequenceSet) object;
  91         return target.getGapChar();
  92       }
  93
  94       public void setValue(java.lang.Object object, java.lang.Object value)
  95               throws IllegalStateException, IllegalArgumentException
  96       {
  97         try
  98         {
  99           SequenceSet target = (SequenceSet) object;
 100           target.setGapChar((java.lang.String) value);
 101         } catch (java.lang.Exception ex)
 102         {
 103           throw new IllegalStateException(ex.toString());
 104         }
 105       }
 106
 107       public java.lang.Object newInstance(java.lang.Object parent)
 108       {
 109         return null;
 110       }
 111     };
 112     desc.setHandler(handler);
 113     desc.setRequired(true);
 114     desc.setMultivalued(false);
 115     addFieldDescriptor(desc);
 116
 117     // -- validation code for: _gapChar
 118     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 119     fieldValidator.setMinOccurs(1);
 120     { // -- local scope
 121       org.exolab.castor.xml.validators.StringValidator typeValidator;
 122       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
 123       fieldValidator.setValidator(typeValidator);
 124       typeValidator.setWhiteSpace("preserve");
 125     }
 126     desc.setValidator(fieldValidator);
 127     // -- _datasetId
 128     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
 129             java.lang.String.class, "_datasetId", "datasetId",
 130             org.exolab.castor.xml.NodeType.Attribute);
 131     desc.setImmutable(true);
 132     handler = new org.exolab.castor.xml.XMLFieldHandler()
 133     {
 134       public java.lang.Object getValue(java.lang.Object object)
 135               throws IllegalStateException
 136       {
 137         SequenceSet target = (SequenceSet) object;
 138         return target.getDatasetId();
 139       }
 140
 141       public void setValue(java.lang.Object object, java.lang.Object value)
 142               throws IllegalStateException, IllegalArgumentException
 143       {
 144         try
 145         {
 146           SequenceSet target = (SequenceSet) object;
 147           target.setDatasetId((java.lang.String) value);
 148         } catch (java.lang.Exception ex)
 149         {
 150           throw new IllegalStateException(ex.toString());
 151         }
 152       }
 153
 154       public java.lang.Object newInstance(java.lang.Object parent)
 155       {
 156         return null;
 157       }
 158     };
 159     desc.setHandler(handler);
 160     desc.setMultivalued(false);
 161     addFieldDescriptor(desc);
 162
 163     // -- validation code for: _datasetId
 164     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 165     { // -- local scope
 166       org.exolab.castor.xml.validators.StringValidator typeValidator;
 167       typeValidator = new org.exolab.castor.xml.validators.StringValidator();
 168       fieldValidator.setValidator(typeValidator);
 169       typeValidator.setWhiteSpace("preserve");
 170     }
 171     desc.setValidator(fieldValidator);
 172     // -- initialize element descriptors
 173
 174     // -- _sequenceList
 175     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
 176             jalview.schemabinding.version2.Sequence.class, "_sequenceList",
 177             "Sequence", org.exolab.castor.xml.NodeType.Element);
 178     handler = new org.exolab.castor.xml.XMLFieldHandler()
 179     {
 180       public java.lang.Object getValue(java.lang.Object object)
 181               throws IllegalStateException
 182       {
 183         SequenceSet target = (SequenceSet) object;
 184         return target.getSequence();
 185       }
 186
 187       public void setValue(java.lang.Object object, java.lang.Object value)
 188               throws IllegalStateException, IllegalArgumentException
 189       {
 190         try
 191         {
 192           SequenceSet target = (SequenceSet) object;
 193           target.addSequence((jalview.schemabinding.version2.Sequence) value);
 194         } catch (java.lang.Exception ex)
 195         {
 196           throw new IllegalStateException(ex.toString());
 197         }
 198       }
 199
 200       public void resetValue(Object object) throws IllegalStateException,
 201               IllegalArgumentException
 202       {
 203         try
 204         {
 205           SequenceSet target = (SequenceSet) object;
 206           target.removeAllSequence();
 207         } catch (java.lang.Exception ex)
 208         {
 209           throw new IllegalStateException(ex.toString());
 210         }
 211       }
 212
 213       public java.lang.Object newInstance(java.lang.Object parent)
 214       {
 215         return new jalview.schemabinding.version2.Sequence();
 216       }
 217     };
 218     desc.setHandler(handler);
 219     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
 220     desc.setMultivalued(true);
 221     addFieldDescriptor(desc);
 222
 223     // -- validation code for: _sequenceList
 224     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 225     fieldValidator.setMinOccurs(0);
 226     { // -- local scope
 227     }
 228     desc.setValidator(fieldValidator);
 229     // -- _annotationList
 230     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
 231             jalview.schemabinding.version2.Annotation.class,
 232             "_annotationList", "Annotation",
 233             org.exolab.castor.xml.NodeType.Element);
 234     handler = new org.exolab.castor.xml.XMLFieldHandler()
 235     {
 236       public java.lang.Object getValue(java.lang.Object object)
 237               throws IllegalStateException
 238       {
 239         SequenceSet target = (SequenceSet) object;
 240         return target.getAnnotation();
 241       }
 242
 243       public void setValue(java.lang.Object object, java.lang.Object value)
 244               throws IllegalStateException, IllegalArgumentException
 245       {
 246         try
 247         {
 248           SequenceSet target = (SequenceSet) object;
 249           target.addAnnotation((jalview.schemabinding.version2.Annotation) value);
 250         } catch (java.lang.Exception ex)
 251         {
 252           throw new IllegalStateException(ex.toString());
 253         }
 254       }
 255
 256       public void resetValue(Object object) throws IllegalStateException,
 257               IllegalArgumentException
 258       {
 259         try
 260         {
 261           SequenceSet target = (SequenceSet) object;
 262           target.removeAllAnnotation();
 263         } catch (java.lang.Exception ex)
 264         {
 265           throw new IllegalStateException(ex.toString());
 266         }
 267       }
 268
 269       public java.lang.Object newInstance(java.lang.Object parent)
 270       {
 271         return new jalview.schemabinding.version2.Annotation();
 272       }
 273     };
 274     desc.setHandler(handler);
 275     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
 276     desc.setMultivalued(true);
 277     addFieldDescriptor(desc);
 278
 279     // -- validation code for: _annotationList
 280     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 281     fieldValidator.setMinOccurs(0);
 282     { // -- local scope
 283     }
 284     desc.setValidator(fieldValidator);
 285     // -- _sequenceSetPropertiesList
 286     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
 287             jalview.schemabinding.version2.SequenceSetProperties.class,
 288             "_sequenceSetPropertiesList", "sequenceSetProperties",
 289             org.exolab.castor.xml.NodeType.Element);
 290     handler = new org.exolab.castor.xml.XMLFieldHandler()
 291     {
 292       public java.lang.Object getValue(java.lang.Object object)
 293               throws IllegalStateException
 294       {
 295         SequenceSet target = (SequenceSet) object;
 296         return target.getSequenceSetProperties();
 297       }
 298
 299       public void setValue(java.lang.Object object, java.lang.Object value)
 300               throws IllegalStateException, IllegalArgumentException
 301       {
 302         try
 303         {
 304           SequenceSet target = (SequenceSet) object;
 305           target.addSequenceSetProperties((jalview.schemabinding.version2.SequenceSetProperties) value);
 306         } catch (java.lang.Exception ex)
 307         {
 308           throw new IllegalStateException(ex.toString());
 309         }
 310       }
 311
 312       public void resetValue(Object object) throws IllegalStateException,
 313               IllegalArgumentException
 314       {
 315         try
 316         {
 317           SequenceSet target = (SequenceSet) object;
 318           target.removeAllSequenceSetProperties();
 319         } catch (java.lang.Exception ex)
 320         {
 321           throw new IllegalStateException(ex.toString());
 322         }
 323       }
 324
 325       public java.lang.Object newInstance(java.lang.Object parent)
 326       {
 327         return new jalview.schemabinding.version2.SequenceSetProperties();
 328       }
 329     };
 330     desc.setHandler(handler);
 331     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
 332     desc.setMultivalued(true);
 333     addFieldDescriptor(desc);
 334
 335     // -- validation code for: _sequenceSetPropertiesList
 336     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 337     fieldValidator.setMinOccurs(0);
 338     { // -- local scope
 339     }
 340     desc.setValidator(fieldValidator);
 341     // -- _alcodonFrameList
 342     desc = new org.exolab.castor.xml.util.XMLFieldDescriptorImpl(
 343             jalview.schemabinding.version2.AlcodonFrame.class,
 344             "_alcodonFrameList", "AlcodonFrame",
 345             org.exolab.castor.xml.NodeType.Element);
 346     handler = new org.exolab.castor.xml.XMLFieldHandler()
 347     {
 348       public java.lang.Object getValue(java.lang.Object object)
 349               throws IllegalStateException
 350       {
 351         SequenceSet target = (SequenceSet) object;
 352         return target.getAlcodonFrame();
 353       }
 354
 355       public void setValue(java.lang.Object object, java.lang.Object value)
 356               throws IllegalStateException, IllegalArgumentException
 357       {
 358         try
 359         {
 360           SequenceSet target = (SequenceSet) object;
 361           target.addAlcodonFrame((jalview.schemabinding.version2.AlcodonFrame) value);
 362         } catch (java.lang.Exception ex)
 363         {
 364           throw new IllegalStateException(ex.toString());
 365         }
 366       }
 367
 368       public void resetValue(Object object) throws IllegalStateException,
 369               IllegalArgumentException
 370       {
 371         try
 372         {
 373           SequenceSet target = (SequenceSet) object;
 374           target.removeAllAlcodonFrame();
 375         } catch (java.lang.Exception ex)
 376         {
 377           throw new IllegalStateException(ex.toString());
 378         }
 379       }
 380
 381       public java.lang.Object newInstance(java.lang.Object parent)
 382       {
 383         return new jalview.schemabinding.version2.AlcodonFrame();
 384       }
 385     };
 386     desc.setHandler(handler);
 387     desc.setNameSpaceURI("www.vamsas.ac.uk/jalview/version2");
 388     desc.setMultivalued(true);
 389     addFieldDescriptor(desc);
 390
 391     // -- validation code for: _alcodonFrameList
 392     fieldValidator = new org.exolab.castor.xml.FieldValidator();
 393     fieldValidator.setMinOccurs(0);
 394     { // -- local scope
 395     }
 396     desc.setValidator(fieldValidator);
 397   }
 398
 399   // -----------/
 400   // - Methods -/
 401   // -----------/
 402
 403   /**
 404    * Method getAccessMode.
 405    *
 406    * @return the access mode specified for this class.
 407    */
 408   public org.exolab.castor.mapping.AccessMode getAccessMode()
 409   {
 410     return null;
 411   }
 412
 413   /**
 414    * Method getIdentity.
 415    *
 416    * @return the identity field, null if this class has no identity.
 417    */
 418   public org.exolab.castor.mapping.FieldDescriptor getIdentity()
 419   {
 420     return super.getIdentity();
 421   }
 422
 423   /**
 424    * Method getJavaClass.
 425    *
 426    * @return the Java class represented by this descriptor.
 427    */
 428   public java.lang.Class getJavaClass()
 429   {
 430     return jalview.schemabinding.version2.SequenceSet.class;
 431   }
 432
 433   /**
 434    * Method getNameSpacePrefix.
 435    *
 436    * @return the namespace prefix to use when marshaling as XML.
 437    */
 438   public java.lang.String getNameSpacePrefix()
 439   {
 440     return _nsPrefix;
 441   }
 442
 443   /**
 444    * Method getNameSpaceURI.
 445    *
 446    * @return the namespace URI used when marshaling and unmarshaling as XML.
 447    */
 448   public java.lang.String getNameSpaceURI()
 449   {
 450     return _nsURI;
 451   }
 452
 453   /**
 454    * Method getValidator.
 455    *
 456    * @return a specific validator for the class described by this
 457    *         ClassDescriptor.
 458    */
 459   public org.exolab.castor.xml.TypeValidator getValidator()
 460   {
 461     return this;
 462   }
 463
 464   /**
 465    * Method getXMLName.
 466    *
 467    * @return the XML Name for the Class being described.
 468    */
 469   public java.lang.String getXMLName()
 470   {
 471     return _xmlName;
 472   }
 473
 474   /**
 475    * Method isElementDefinition.
 476    *
 477    * @return true if XML schema definition of this Class is that of a global
 478    *         element or element with anonymous type definition.
 479    */
 480   public boolean isElementDefinition()
 481   {
 482     return _elementDefinition;
 483   }
 484
 485 }