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

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