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