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       //----------------/\r
  55      //- Constructors -/\r
  56     //----------------/\r
  57 \r
  58     public SequenceSet() {\r
  59         super();\r
  60         _sequenceList = new Vector();\r
  61         _annotationList = new Vector();\r
  62     } //-- jalview.schemabinding.version2.SequenceSet()\r
  63 \r
  64 \r
  65       //-----------/\r
  66      //- Methods -/\r
  67     //-----------/\r
  68 \r
  69     /**\r
  70      * Method addAnnotation\r
  71      * \r
  72      * \r
  73      * \r
  74      * @param vAnnotation\r
  75      */\r
  76     public void addAnnotation(jalview.schemabinding.version2.Annotation vAnnotation)\r
  77         throws java.lang.IndexOutOfBoundsException\r
  78     {\r
  79         _annotationList.addElement(vAnnotation);\r
  80     } //-- void addAnnotation(jalview.schemabinding.version2.Annotation) \r
  81 \r
  82     /**\r
  83      * Method addAnnotation\r
  84      * \r
  85      * \r
  86      * \r
  87      * @param index\r
  88      * @param vAnnotation\r
  89      */\r
  90     public void addAnnotation(int index, jalview.schemabinding.version2.Annotation vAnnotation)\r
  91         throws java.lang.IndexOutOfBoundsException\r
  92     {\r
  93         _annotationList.insertElementAt(vAnnotation, index);\r
  94     } //-- void addAnnotation(int, jalview.schemabinding.version2.Annotation) \r
  95 \r
  96     /**\r
  97      * Method addSequence\r
  98      * \r
  99      * \r
 100      * \r
 101      * @param vSequence\r
 102      */\r
 103     public void addSequence(jalview.schemabinding.version2.Sequence vSequence)\r
 104         throws java.lang.IndexOutOfBoundsException\r
 105     {\r
 106         _sequenceList.addElement(vSequence);\r
 107     } //-- void addSequence(jalview.schemabinding.version2.Sequence) \r
 108 \r
 109     /**\r
 110      * Method addSequence\r
 111      * \r
 112      * \r
 113      * \r
 114      * @param index\r
 115      * @param vSequence\r
 116      */\r
 117     public void addSequence(int index, jalview.schemabinding.version2.Sequence vSequence)\r
 118         throws java.lang.IndexOutOfBoundsException\r
 119     {\r
 120         _sequenceList.insertElementAt(vSequence, index);\r
 121     } //-- void addSequence(int, jalview.schemabinding.version2.Sequence) \r
 122 \r
 123     /**\r
 124      * Method enumerateAnnotation\r
 125      * \r
 126      * \r
 127      * \r
 128      * @return Enumeration\r
 129      */\r
 130     public java.util.Enumeration enumerateAnnotation()\r
 131     {\r
 132         return _annotationList.elements();\r
 133     } //-- java.util.Enumeration enumerateAnnotation() \r
 134 \r
 135     /**\r
 136      * Method enumerateSequence\r
 137      * \r
 138      * \r
 139      * \r
 140      * @return Enumeration\r
 141      */\r
 142     public java.util.Enumeration enumerateSequence()\r
 143     {\r
 144         return _sequenceList.elements();\r
 145     } //-- java.util.Enumeration enumerateSequence() \r
 146 \r
 147     /**\r
 148      * Method getAnnotation\r
 149      * \r
 150      * \r
 151      * \r
 152      * @param index\r
 153      * @return Annotation\r
 154      */\r
 155     public jalview.schemabinding.version2.Annotation getAnnotation(int index)\r
 156         throws java.lang.IndexOutOfBoundsException\r
 157     {\r
 158         //-- check bounds for index\r
 159         if ((index < 0) || (index > _annotationList.size())) {\r
 160             throw new IndexOutOfBoundsException();\r
 161         }\r
 162         \r
 163         return (jalview.schemabinding.version2.Annotation) _annotationList.elementAt(index);\r
 164     } //-- jalview.schemabinding.version2.Annotation getAnnotation(int) \r
 165 \r
 166     /**\r
 167      * Method getAnnotation\r
 168      * \r
 169      * \r
 170      * \r
 171      * @return Annotation\r
 172      */\r
 173     public jalview.schemabinding.version2.Annotation[] getAnnotation()\r
 174     {\r
 175         int size = _annotationList.size();\r
 176         jalview.schemabinding.version2.Annotation[] mArray = new jalview.schemabinding.version2.Annotation[size];\r
 177         for (int index = 0; index < size; index++) {\r
 178             mArray[index] = (jalview.schemabinding.version2.Annotation) _annotationList.elementAt(index);\r
 179         }\r
 180         return mArray;\r
 181     } //-- jalview.schemabinding.version2.Annotation[] getAnnotation() \r
 182 \r
 183     /**\r
 184      * Method getAnnotationCount\r
 185      * \r
 186      * \r
 187      * \r
 188      * @return int\r
 189      */\r
 190     public int getAnnotationCount()\r
 191     {\r
 192         return _annotationList.size();\r
 193     } //-- int getAnnotationCount() \r
 194 \r
 195     /**\r
 196      * Returns the value of field 'gapChar'.\r
 197      * \r
 198      * @return String\r
 199      * @return the value of field 'gapChar'.\r
 200      */\r
 201     public java.lang.String getGapChar()\r
 202     {\r
 203         return this._gapChar;\r
 204     } //-- java.lang.String getGapChar() \r
 205 \r
 206     /**\r
 207      * Method getSequence\r
 208      * \r
 209      * \r
 210      * \r
 211      * @param index\r
 212      * @return Sequence\r
 213      */\r
 214     public jalview.schemabinding.version2.Sequence getSequence(int index)\r
 215         throws java.lang.IndexOutOfBoundsException\r
 216     {\r
 217         //-- check bounds for index\r
 218         if ((index < 0) || (index > _sequenceList.size())) {\r
 219             throw new IndexOutOfBoundsException();\r
 220         }\r
 221         \r
 222         return (jalview.schemabinding.version2.Sequence) _sequenceList.elementAt(index);\r
 223     } //-- jalview.schemabinding.version2.Sequence getSequence(int) \r
 224 \r
 225     /**\r
 226      * Method getSequence\r
 227      * \r
 228      * \r
 229      * \r
 230      * @return Sequence\r
 231      */\r
 232     public jalview.schemabinding.version2.Sequence[] getSequence()\r
 233     {\r
 234         int size = _sequenceList.size();\r
 235         jalview.schemabinding.version2.Sequence[] mArray = new jalview.schemabinding.version2.Sequence[size];\r
 236         for (int index = 0; index < size; index++) {\r
 237             mArray[index] = (jalview.schemabinding.version2.Sequence) _sequenceList.elementAt(index);\r
 238         }\r
 239         return mArray;\r
 240     } //-- jalview.schemabinding.version2.Sequence[] getSequence() \r
 241 \r
 242     /**\r
 243      * Method getSequenceCount\r
 244      * \r
 245      * \r
 246      * \r
 247      * @return int\r
 248      */\r
 249     public int getSequenceCount()\r
 250     {\r
 251         return _sequenceList.size();\r
 252     } //-- int getSequenceCount() \r
 253 \r
 254     /**\r
 255      * Method isValid\r
 256      * \r
 257      * \r
 258      * \r
 259      * @return boolean\r
 260      */\r
 261     public boolean isValid()\r
 262     {\r
 263         try {\r
 264             validate();\r
 265         }\r
 266         catch (org.exolab.castor.xml.ValidationException vex) {\r
 267             return false;\r
 268         }\r
 269         return true;\r
 270     } //-- boolean isValid() \r
 271 \r
 272     /**\r
 273      * Method marshal\r
 274      * \r
 275      * \r
 276      * \r
 277      * @param out\r
 278      */\r
 279     public void marshal(java.io.Writer out)\r
 280         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 281     {\r
 282         \r
 283         Marshaller.marshal(this, out);\r
 284     } //-- void marshal(java.io.Writer) \r
 285 \r
 286     /**\r
 287      * Method marshal\r
 288      * \r
 289      * \r
 290      * \r
 291      * @param handler\r
 292      */\r
 293     public void marshal(org.xml.sax.ContentHandler handler)\r
 294         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 295     {\r
 296         \r
 297         Marshaller.marshal(this, handler);\r
 298     } //-- void marshal(org.xml.sax.ContentHandler) \r
 299 \r
 300     /**\r
 301      * Method removeAllAnnotation\r
 302      * \r
 303      */\r
 304     public void removeAllAnnotation()\r
 305     {\r
 306         _annotationList.removeAllElements();\r
 307     } //-- void removeAllAnnotation() \r
 308 \r
 309     /**\r
 310      * Method removeAllSequence\r
 311      * \r
 312      */\r
 313     public void removeAllSequence()\r
 314     {\r
 315         _sequenceList.removeAllElements();\r
 316     } //-- void removeAllSequence() \r
 317 \r
 318     /**\r
 319      * Method removeAnnotation\r
 320      * \r
 321      * \r
 322      * \r
 323      * @param index\r
 324      * @return Annotation\r
 325      */\r
 326     public jalview.schemabinding.version2.Annotation removeAnnotation(int index)\r
 327     {\r
 328         java.lang.Object obj = _annotationList.elementAt(index);\r
 329         _annotationList.removeElementAt(index);\r
 330         return (jalview.schemabinding.version2.Annotation) obj;\r
 331     } //-- jalview.schemabinding.version2.Annotation removeAnnotation(int) \r
 332 \r
 333     /**\r
 334      * Method removeSequence\r
 335      * \r
 336      * \r
 337      * \r
 338      * @param index\r
 339      * @return Sequence\r
 340      */\r
 341     public jalview.schemabinding.version2.Sequence removeSequence(int index)\r
 342     {\r
 343         java.lang.Object obj = _sequenceList.elementAt(index);\r
 344         _sequenceList.removeElementAt(index);\r
 345         return (jalview.schemabinding.version2.Sequence) obj;\r
 346     } //-- jalview.schemabinding.version2.Sequence removeSequence(int) \r
 347 \r
 348     /**\r
 349      * Method setAnnotation\r
 350      * \r
 351      * \r
 352      * \r
 353      * @param index\r
 354      * @param vAnnotation\r
 355      */\r
 356     public void setAnnotation(int index, jalview.schemabinding.version2.Annotation vAnnotation)\r
 357         throws java.lang.IndexOutOfBoundsException\r
 358     {\r
 359         //-- check bounds for index\r
 360         if ((index < 0) || (index > _annotationList.size())) {\r
 361             throw new IndexOutOfBoundsException();\r
 362         }\r
 363         _annotationList.setElementAt(vAnnotation, index);\r
 364     } //-- void setAnnotation(int, jalview.schemabinding.version2.Annotation) \r
 365 \r
 366     /**\r
 367      * Method setAnnotation\r
 368      * \r
 369      * \r
 370      * \r
 371      * @param annotationArray\r
 372      */\r
 373     public void setAnnotation(jalview.schemabinding.version2.Annotation[] annotationArray)\r
 374     {\r
 375         //-- copy array\r
 376         _annotationList.removeAllElements();\r
 377         for (int i = 0; i < annotationArray.length; i++) {\r
 378             _annotationList.addElement(annotationArray[i]);\r
 379         }\r
 380     } //-- void setAnnotation(jalview.schemabinding.version2.Annotation) \r
 381 \r
 382     /**\r
 383      * Sets the value of field 'gapChar'.\r
 384      * \r
 385      * @param gapChar the value of field 'gapChar'.\r
 386      */\r
 387     public void setGapChar(java.lang.String gapChar)\r
 388     {\r
 389         this._gapChar = gapChar;\r
 390     } //-- void setGapChar(java.lang.String) \r
 391 \r
 392     /**\r
 393      * Method setSequence\r
 394      * \r
 395      * \r
 396      * \r
 397      * @param index\r
 398      * @param vSequence\r
 399      */\r
 400     public void setSequence(int index, jalview.schemabinding.version2.Sequence vSequence)\r
 401         throws java.lang.IndexOutOfBoundsException\r
 402     {\r
 403         //-- check bounds for index\r
 404         if ((index < 0) || (index > _sequenceList.size())) {\r
 405             throw new IndexOutOfBoundsException();\r
 406         }\r
 407         _sequenceList.setElementAt(vSequence, index);\r
 408     } //-- void setSequence(int, jalview.schemabinding.version2.Sequence) \r
 409 \r
 410     /**\r
 411      * Method setSequence\r
 412      * \r
 413      * \r
 414      * \r
 415      * @param sequenceArray\r
 416      */\r
 417     public void setSequence(jalview.schemabinding.version2.Sequence[] sequenceArray)\r
 418     {\r
 419         //-- copy array\r
 420         _sequenceList.removeAllElements();\r
 421         for (int i = 0; i < sequenceArray.length; i++) {\r
 422             _sequenceList.addElement(sequenceArray[i]);\r
 423         }\r
 424     } //-- void setSequence(jalview.schemabinding.version2.Sequence) \r
 425 \r
 426     /**\r
 427      * Method unmarshal\r
 428      * \r
 429      * \r
 430      * \r
 431      * @param reader\r
 432      * @return Object\r
 433      */\r
 434     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 435         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 436     {\r
 437         return (jalview.schemabinding.version2.SequenceSet) Unmarshaller.unmarshal(jalview.schemabinding.version2.SequenceSet.class, reader);\r
 438     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 439 \r
 440     /**\r
 441      * Method validate\r
 442      * \r
 443      */\r
 444     public void validate()\r
 445         throws org.exolab.castor.xml.ValidationException\r
 446     {\r
 447         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 448         validator.validate(this);\r
 449     } //-- void validate() \r
 450 \r
 451 }\r