src/jalview/schemabinding/version2/SequenceSet.java

   1 /*\r
   2  * This class was automatically generated with \r
   3  * <a href="http://www.castor.org">Castor 0.9.6</a>, using an XML\r
   4  * Schema.\r
   5  * $Id$\r
   6  */\r
   7 \r
   8 package jalview.schemabinding.version2;\r
   9 \r
  10   //---------------------------------/\r
  11  //- Imported classes and packages -/\r
  12 //---------------------------------/\r
  13 \r
  14 import java.io.IOException;\r
  15 import java.io.Reader;\r
  16 import java.io.Serializable;\r
  17 import java.io.Writer;\r
  18 import java.util.Enumeration;\r
  19 import java.util.Vector;\r
  20 import org.exolab.castor.xml.MarshalException;\r
  21 import org.exolab.castor.xml.Marshaller;\r
  22 import org.exolab.castor.xml.Unmarshaller;\r
  23 import org.exolab.castor.xml.ValidationException;\r
  24 import org.xml.sax.ContentHandler;\r
  25 \r
  26 /**\r
  27  * Class SequenceSet.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class SequenceSet implements java.io.Serializable {\r
  32 \r
  33 \r
  34       //--------------------------/\r
  35      //- Class/Member Variables -/\r
  36     //--------------------------/\r
  37 \r
  38     /**\r
  39      * Field _gapChar\r
  40      */\r
  41     private java.lang.String _gapChar;\r
  42 \r
  43     /**\r
  44      * Field _sequenceList\r
  45      */\r
  46     private java.util.Vector _sequenceList;\r
  47 \r
  48     /**\r
  49      * Field _annotationList\r
  50      */\r
  51     private java.util.Vector _annotationList;\r
  52 \r
  53     /**\r
  54      * Field _sequenceSetPropertiesList\r
  55      */\r
  56     private java.util.Vector _sequenceSetPropertiesList;\r
  57 \r
  58 \r
  59       //----------------/\r
  60      //- Constructors -/\r
  61     //----------------/\r
  62 \r
  63     public SequenceSet() {\r
  64         super();\r
  65         _sequenceList = new Vector();\r
  66         _annotationList = new Vector();\r
  67         _sequenceSetPropertiesList = new Vector();\r
  68     } //-- jalview.schemabinding.version2.SequenceSet()\r
  69 \r
  70 \r
  71       //-----------/\r
  72      //- Methods -/\r
  73     //-----------/\r
  74 \r
  75     /**\r
  76      * Method addAnnotation\r
  77      * \r
  78      * \r
  79      * \r
  80      * @param vAnnotation\r
  81      */\r
  82     public void addAnnotation(jalview.schemabinding.version2.Annotation vAnnotation)\r
  83         throws java.lang.IndexOutOfBoundsException\r
  84     {\r
  85         _annotationList.addElement(vAnnotation);\r
  86     } //-- void addAnnotation(jalview.schemabinding.version2.Annotation) \r
  87 \r
  88     /**\r
  89      * Method addAnnotation\r
  90      * \r
  91      * \r
  92      * \r
  93      * @param index\r
  94      * @param vAnnotation\r
  95      */\r
  96     public void addAnnotation(int index, jalview.schemabinding.version2.Annotation vAnnotation)\r
  97         throws java.lang.IndexOutOfBoundsException\r
  98     {\r
  99         _annotationList.insertElementAt(vAnnotation, index);\r
 100     } //-- void addAnnotation(int, jalview.schemabinding.version2.Annotation) \r
 101 \r
 102     /**\r
 103      * Method addSequence\r
 104      * \r
 105      * \r
 106      * \r
 107      * @param vSequence\r
 108      */\r
 109     public void addSequence(jalview.schemabinding.version2.Sequence vSequence)\r
 110         throws java.lang.IndexOutOfBoundsException\r
 111     {\r
 112         _sequenceList.addElement(vSequence);\r
 113     } //-- void addSequence(jalview.schemabinding.version2.Sequence) \r
 114 \r
 115     /**\r
 116      * Method addSequence\r
 117      * \r
 118      * \r
 119      * \r
 120      * @param index\r
 121      * @param vSequence\r
 122      */\r
 123     public void addSequence(int index, jalview.schemabinding.version2.Sequence vSequence)\r
 124         throws java.lang.IndexOutOfBoundsException\r
 125     {\r
 126         _sequenceList.insertElementAt(vSequence, index);\r
 127     } //-- void addSequence(int, jalview.schemabinding.version2.Sequence) \r
 128 \r
 129     /**\r
 130      * Method addSequenceSetProperties\r
 131      * \r
 132      * \r
 133      * \r
 134      * @param vSequenceSetProperties\r
 135      */\r
 136     public void addSequenceSetProperties(jalview.schemabinding.version2.SequenceSetProperties vSequenceSetProperties)\r
 137         throws java.lang.IndexOutOfBoundsException\r
 138     {\r
 139         _sequenceSetPropertiesList.addElement(vSequenceSetProperties);\r
 140     } //-- void addSequenceSetProperties(jalview.schemabinding.version2.SequenceSetProperties) \r
 141 \r
 142     /**\r
 143      * Method addSequenceSetProperties\r
 144      * \r
 145      * \r
 146      * \r
 147      * @param index\r
 148      * @param vSequenceSetProperties\r
 149      */\r
 150     public void addSequenceSetProperties(int index, jalview.schemabinding.version2.SequenceSetProperties vSequenceSetProperties)\r
 151         throws java.lang.IndexOutOfBoundsException\r
 152     {\r
 153         _sequenceSetPropertiesList.insertElementAt(vSequenceSetProperties, index);\r
 154     } //-- void addSequenceSetProperties(int, jalview.schemabinding.version2.SequenceSetProperties) \r
 155 \r
 156     /**\r
 157      * Method enumerateAnnotation\r
 158      * \r
 159      * \r
 160      * \r
 161      * @return Enumeration\r
 162      */\r
 163     public java.util.Enumeration enumerateAnnotation()\r
 164     {\r
 165         return _annotationList.elements();\r
 166     } //-- java.util.Enumeration enumerateAnnotation() \r
 167 \r
 168     /**\r
 169      * Method enumerateSequence\r
 170      * \r
 171      * \r
 172      * \r
 173      * @return Enumeration\r
 174      */\r
 175     public java.util.Enumeration enumerateSequence()\r
 176     {\r
 177         return _sequenceList.elements();\r
 178     } //-- java.util.Enumeration enumerateSequence() \r
 179 \r
 180     /**\r
 181      * Method enumerateSequenceSetProperties\r
 182      * \r
 183      * \r
 184      * \r
 185      * @return Enumeration\r
 186      */\r
 187     public java.util.Enumeration enumerateSequenceSetProperties()\r
 188     {\r
 189         return _sequenceSetPropertiesList.elements();\r
 190     } //-- java.util.Enumeration enumerateSequenceSetProperties() \r
 191 \r
 192     /**\r
 193      * Method getAnnotation\r
 194      * \r
 195      * \r
 196      * \r
 197      * @param index\r
 198      * @return Annotation\r
 199      */\r
 200     public jalview.schemabinding.version2.Annotation getAnnotation(int index)\r
 201         throws java.lang.IndexOutOfBoundsException\r
 202     {\r
 203         //-- check bounds for index\r
 204         if ((index < 0) || (index > _annotationList.size())) {\r
 205             throw new IndexOutOfBoundsException();\r
 206         }\r
 207         \r
 208         return (jalview.schemabinding.version2.Annotation) _annotationList.elementAt(index);\r
 209     } //-- jalview.schemabinding.version2.Annotation getAnnotation(int) \r
 210 \r
 211     /**\r
 212      * Method getAnnotation\r
 213      * \r
 214      * \r
 215      * \r
 216      * @return Annotation\r
 217      */\r
 218     public jalview.schemabinding.version2.Annotation[] getAnnotation()\r
 219     {\r
 220         int size = _annotationList.size();\r
 221         jalview.schemabinding.version2.Annotation[] mArray = new jalview.schemabinding.version2.Annotation[size];\r
 222         for (int index = 0; index < size; index++) {\r
 223             mArray[index] = (jalview.schemabinding.version2.Annotation) _annotationList.elementAt(index);\r
 224         }\r
 225         return mArray;\r
 226     } //-- jalview.schemabinding.version2.Annotation[] getAnnotation() \r
 227 \r
 228     /**\r
 229      * Method getAnnotationCount\r
 230      * \r
 231      * \r
 232      * \r
 233      * @return int\r
 234      */\r
 235     public int getAnnotationCount()\r
 236     {\r
 237         return _annotationList.size();\r
 238     } //-- int getAnnotationCount() \r
 239 \r
 240     /**\r
 241      * Returns the value of field 'gapChar'.\r
 242      * \r
 243      * @return String\r
 244      * @return the value of field 'gapChar'.\r
 245      */\r
 246     public java.lang.String getGapChar()\r
 247     {\r
 248         return this._gapChar;\r
 249     } //-- java.lang.String getGapChar() \r
 250 \r
 251     /**\r
 252      * Method getSequence\r
 253      * \r
 254      * \r
 255      * \r
 256      * @param index\r
 257      * @return Sequence\r
 258      */\r
 259     public jalview.schemabinding.version2.Sequence getSequence(int index)\r
 260         throws java.lang.IndexOutOfBoundsException\r
 261     {\r
 262         //-- check bounds for index\r
 263         if ((index < 0) || (index > _sequenceList.size())) {\r
 264             throw new IndexOutOfBoundsException();\r
 265         }\r
 266         \r
 267         return (jalview.schemabinding.version2.Sequence) _sequenceList.elementAt(index);\r
 268     } //-- jalview.schemabinding.version2.Sequence getSequence(int) \r
 269 \r
 270     /**\r
 271      * Method getSequence\r
 272      * \r
 273      * \r
 274      * \r
 275      * @return Sequence\r
 276      */\r
 277     public jalview.schemabinding.version2.Sequence[] getSequence()\r
 278     {\r
 279         int size = _sequenceList.size();\r
 280         jalview.schemabinding.version2.Sequence[] mArray = new jalview.schemabinding.version2.Sequence[size];\r
 281         for (int index = 0; index < size; index++) {\r
 282             mArray[index] = (jalview.schemabinding.version2.Sequence) _sequenceList.elementAt(index);\r
 283         }\r
 284         return mArray;\r
 285     } //-- jalview.schemabinding.version2.Sequence[] getSequence() \r
 286 \r
 287     /**\r
 288      * Method getSequenceCount\r
 289      * \r
 290      * \r
 291      * \r
 292      * @return int\r
 293      */\r
 294     public int getSequenceCount()\r
 295     {\r
 296         return _sequenceList.size();\r
 297     } //-- int getSequenceCount() \r
 298 \r
 299     /**\r
 300      * Method getSequenceSetProperties\r
 301      * \r
 302      * \r
 303      * \r
 304      * @param index\r
 305      * @return SequenceSetProperties\r
 306      */\r
 307     public jalview.schemabinding.version2.SequenceSetProperties getSequenceSetProperties(int index)\r
 308         throws java.lang.IndexOutOfBoundsException\r
 309     {\r
 310         //-- check bounds for index\r
 311         if ((index < 0) || (index > _sequenceSetPropertiesList.size())) {\r
 312             throw new IndexOutOfBoundsException();\r
 313         }\r
 314         \r
 315         return (jalview.schemabinding.version2.SequenceSetProperties) _sequenceSetPropertiesList.elementAt(index);\r
 316     } //-- jalview.schemabinding.version2.SequenceSetProperties getSequenceSetProperties(int) \r
 317 \r
 318     /**\r
 319      * Method getSequenceSetProperties\r
 320      * \r
 321      * \r
 322      * \r
 323      * @return SequenceSetProperties\r
 324      */\r
 325     public jalview.schemabinding.version2.SequenceSetProperties[] getSequenceSetProperties()\r
 326     {\r
 327         int size = _sequenceSetPropertiesList.size();\r
 328         jalview.schemabinding.version2.SequenceSetProperties[] mArray = new jalview.schemabinding.version2.SequenceSetProperties[size];\r
 329         for (int index = 0; index < size; index++) {\r
 330             mArray[index] = (jalview.schemabinding.version2.SequenceSetProperties) _sequenceSetPropertiesList.elementAt(index);\r
 331         }\r
 332         return mArray;\r
 333     } //-- jalview.schemabinding.version2.SequenceSetProperties[] getSequenceSetProperties() \r
 334 \r
 335     /**\r
 336      * Method getSequenceSetPropertiesCount\r
 337      * \r
 338      * \r
 339      * \r
 340      * @return int\r
 341      */\r
 342     public int getSequenceSetPropertiesCount()\r
 343     {\r
 344         return _sequenceSetPropertiesList.size();\r
 345     } //-- int getSequenceSetPropertiesCount() \r
 346 \r
 347     /**\r
 348      * Method isValid\r
 349      * \r
 350      * \r
 351      * \r
 352      * @return boolean\r
 353      */\r
 354     public boolean isValid()\r
 355     {\r
 356         try {\r
 357             validate();\r
 358         }\r
 359         catch (org.exolab.castor.xml.ValidationException vex) {\r
 360             return false;\r
 361         }\r
 362         return true;\r
 363     } //-- boolean isValid() \r
 364 \r
 365     /**\r
 366      * Method marshal\r
 367      * \r
 368      * \r
 369      * \r
 370      * @param out\r
 371      */\r
 372     public void marshal(java.io.Writer out)\r
 373         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 374     {\r
 375         \r
 376         Marshaller.marshal(this, out);\r
 377     } //-- void marshal(java.io.Writer) \r
 378 \r
 379     /**\r
 380      * Method marshal\r
 381      * \r
 382      * \r
 383      * \r
 384      * @param handler\r
 385      */\r
 386     public void marshal(org.xml.sax.ContentHandler handler)\r
 387         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 388     {\r
 389         \r
 390         Marshaller.marshal(this, handler);\r
 391     } //-- void marshal(org.xml.sax.ContentHandler) \r
 392 \r
 393     /**\r
 394      * Method removeAllAnnotation\r
 395      * \r
 396      */\r
 397     public void removeAllAnnotation()\r
 398     {\r
 399         _annotationList.removeAllElements();\r
 400     } //-- void removeAllAnnotation() \r
 401 \r
 402     /**\r
 403      * Method removeAllSequence\r
 404      * \r
 405      */\r
 406     public void removeAllSequence()\r
 407     {\r
 408         _sequenceList.removeAllElements();\r
 409     } //-- void removeAllSequence() \r
 410 \r
 411     /**\r
 412      * Method removeAllSequenceSetProperties\r
 413      * \r
 414      */\r
 415     public void removeAllSequenceSetProperties()\r
 416     {\r
 417         _sequenceSetPropertiesList.removeAllElements();\r
 418     } //-- void removeAllSequenceSetProperties() \r
 419 \r
 420     /**\r
 421      * Method removeAnnotation\r
 422      * \r
 423      * \r
 424      * \r
 425      * @param index\r
 426      * @return Annotation\r
 427      */\r
 428     public jalview.schemabinding.version2.Annotation removeAnnotation(int index)\r
 429     {\r
 430         java.lang.Object obj = _annotationList.elementAt(index);\r
 431         _annotationList.removeElementAt(index);\r
 432         return (jalview.schemabinding.version2.Annotation) obj;\r
 433     } //-- jalview.schemabinding.version2.Annotation removeAnnotation(int) \r
 434 \r
 435     /**\r
 436      * Method removeSequence\r
 437      * \r
 438      * \r
 439      * \r
 440      * @param index\r
 441      * @return Sequence\r
 442      */\r
 443     public jalview.schemabinding.version2.Sequence removeSequence(int index)\r
 444     {\r
 445         java.lang.Object obj = _sequenceList.elementAt(index);\r
 446         _sequenceList.removeElementAt(index);\r
 447         return (jalview.schemabinding.version2.Sequence) obj;\r
 448     } //-- jalview.schemabinding.version2.Sequence removeSequence(int) \r
 449 \r
 450     /**\r
 451      * Method removeSequenceSetProperties\r
 452      * \r
 453      * \r
 454      * \r
 455      * @param index\r
 456      * @return SequenceSetProperties\r
 457      */\r
 458     public jalview.schemabinding.version2.SequenceSetProperties removeSequenceSetProperties(int index)\r
 459     {\r
 460         java.lang.Object obj = _sequenceSetPropertiesList.elementAt(index);\r
 461         _sequenceSetPropertiesList.removeElementAt(index);\r
 462         return (jalview.schemabinding.version2.SequenceSetProperties) obj;\r
 463     } //-- jalview.schemabinding.version2.SequenceSetProperties removeSequenceSetProperties(int) \r
 464 \r
 465     /**\r
 466      * Method setAnnotation\r
 467      * \r
 468      * \r
 469      * \r
 470      * @param index\r
 471      * @param vAnnotation\r
 472      */\r
 473     public void setAnnotation(int index, jalview.schemabinding.version2.Annotation vAnnotation)\r
 474         throws java.lang.IndexOutOfBoundsException\r
 475     {\r
 476         //-- check bounds for index\r
 477         if ((index < 0) || (index > _annotationList.size())) {\r
 478             throw new IndexOutOfBoundsException();\r
 479         }\r
 480         _annotationList.setElementAt(vAnnotation, index);\r
 481     } //-- void setAnnotation(int, jalview.schemabinding.version2.Annotation) \r
 482 \r
 483     /**\r
 484      * Method setAnnotation\r
 485      * \r
 486      * \r
 487      * \r
 488      * @param annotationArray\r
 489      */\r
 490     public void setAnnotation(jalview.schemabinding.version2.Annotation[] annotationArray)\r
 491     {\r
 492         //-- copy array\r
 493         _annotationList.removeAllElements();\r
 494         for (int i = 0; i < annotationArray.length; i++) {\r
 495             _annotationList.addElement(annotationArray[i]);\r
 496         }\r
 497     } //-- void setAnnotation(jalview.schemabinding.version2.Annotation) \r
 498 \r
 499     /**\r
 500      * Sets the value of field 'gapChar'.\r
 501      * \r
 502      * @param gapChar the value of field 'gapChar'.\r
 503      */\r
 504     public void setGapChar(java.lang.String gapChar)\r
 505     {\r
 506         this._gapChar = gapChar;\r
 507     } //-- void setGapChar(java.lang.String) \r
 508 \r
 509     /**\r
 510      * Method setSequence\r
 511      * \r
 512      * \r
 513      * \r
 514      * @param index\r
 515      * @param vSequence\r
 516      */\r
 517     public void setSequence(int index, jalview.schemabinding.version2.Sequence vSequence)\r
 518         throws java.lang.IndexOutOfBoundsException\r
 519     {\r
 520         //-- check bounds for index\r
 521         if ((index < 0) || (index > _sequenceList.size())) {\r
 522             throw new IndexOutOfBoundsException();\r
 523         }\r
 524         _sequenceList.setElementAt(vSequence, index);\r
 525     } //-- void setSequence(int, jalview.schemabinding.version2.Sequence) \r
 526 \r
 527     /**\r
 528      * Method setSequence\r
 529      * \r
 530      * \r
 531      * \r
 532      * @param sequenceArray\r
 533      */\r
 534     public void setSequence(jalview.schemabinding.version2.Sequence[] sequenceArray)\r
 535     {\r
 536         //-- copy array\r
 537         _sequenceList.removeAllElements();\r
 538         for (int i = 0; i < sequenceArray.length; i++) {\r
 539             _sequenceList.addElement(sequenceArray[i]);\r
 540         }\r
 541     } //-- void setSequence(jalview.schemabinding.version2.Sequence) \r
 542 \r
 543     /**\r
 544      * Method setSequenceSetProperties\r
 545      * \r
 546      * \r
 547      * \r
 548      * @param index\r
 549      * @param vSequenceSetProperties\r
 550      */\r
 551     public void setSequenceSetProperties(int index, jalview.schemabinding.version2.SequenceSetProperties vSequenceSetProperties)\r
 552         throws java.lang.IndexOutOfBoundsException\r
 553     {\r
 554         //-- check bounds for index\r
 555         if ((index < 0) || (index > _sequenceSetPropertiesList.size())) {\r
 556             throw new IndexOutOfBoundsException();\r
 557         }\r
 558         _sequenceSetPropertiesList.setElementAt(vSequenceSetProperties, index);\r
 559     } //-- void setSequenceSetProperties(int, jalview.schemabinding.version2.SequenceSetProperties) \r
 560 \r
 561     /**\r
 562      * Method setSequenceSetProperties\r
 563      * \r
 564      * \r
 565      * \r
 566      * @param sequenceSetPropertiesArray\r
 567      */\r
 568     public void setSequenceSetProperties(jalview.schemabinding.version2.SequenceSetProperties[] sequenceSetPropertiesArray)\r
 569     {\r
 570         //-- copy array\r
 571         _sequenceSetPropertiesList.removeAllElements();\r
 572         for (int i = 0; i < sequenceSetPropertiesArray.length; i++) {\r
 573             _sequenceSetPropertiesList.addElement(sequenceSetPropertiesArray[i]);\r
 574         }\r
 575     } //-- void setSequenceSetProperties(jalview.schemabinding.version2.SequenceSetProperties) \r
 576 \r
 577     /**\r
 578      * Method unmarshal\r
 579      * \r
 580      * \r
 581      * \r
 582      * @param reader\r
 583      * @return Object\r
 584      */\r
 585     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 586         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 587     {\r
 588         return (jalview.schemabinding.version2.SequenceSet) Unmarshaller.unmarshal(jalview.schemabinding.version2.SequenceSet.class, reader);\r
 589     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 590 \r
 591     /**\r
 592      * Method validate\r
 593      * \r
 594      */\r
 595     public void validate()\r
 596         throws org.exolab.castor.xml.ValidationException\r
 597     {\r
 598         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 599         validator.validate(this);\r
 600     } //-- void validate() \r
 601 \r
 602 }\r