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