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