src/jalview/schemabinding/version2/AlcodonFrame.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
   4  * Schema.
   5  * $Id$
   6  */
   7
   8 package jalview.schemabinding.version2;
   9
  10   //---------------------------------/
  11  //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import org.exolab.castor.xml.Marshaller;
  15 import org.exolab.castor.xml.Unmarshaller;
  16
  17 /**
  18  * Class AlcodonFrame.
  19  *
  20  * @version $Revision$ $Date$
  21  */
  22 public class AlcodonFrame implements java.io.Serializable {
  23
  24
  25       //--------------------------/
  26      //- Class/Member Variables -/
  27     //--------------------------/
  28
  29     /**
  30      * Field _alcodonList.
  31      */
  32     private java.util.Vector _alcodonList;
  33
  34     /**
  35      * Field _alcodMapList.
  36      */
  37     private java.util.Vector _alcodMapList;
  38
  39
  40       //----------------/
  41      //- Constructors -/
  42     //----------------/
  43
  44     public AlcodonFrame() {
  45         super();
  46         this._alcodonList = new java.util.Vector();
  47         this._alcodMapList = new java.util.Vector();
  48     }
  49
  50
  51       //-----------/
  52      //- Methods -/
  53     //-----------/
  54
  55     /**
  56      *
  57      *
  58      * @param vAlcodMap
  59      * @throws java.lang.IndexOutOfBoundsException if the index
  60      * given is outside the bounds of the collection
  61      */
  62     public void addAlcodMap(
  63             final jalview.schemabinding.version2.AlcodMap vAlcodMap)
  64     throws java.lang.IndexOutOfBoundsException {
  65         this._alcodMapList.addElement(vAlcodMap);
  66     }
  67
  68     /**
  69      *
  70      *
  71      * @param index
  72      * @param vAlcodMap
  73      * @throws java.lang.IndexOutOfBoundsException if the index
  74      * given is outside the bounds of the collection
  75      */
  76     public void addAlcodMap(
  77             final int index,
  78             final jalview.schemabinding.version2.AlcodMap vAlcodMap)
  79     throws java.lang.IndexOutOfBoundsException {
  80         this._alcodMapList.add(index, vAlcodMap);
  81     }
  82
  83     /**
  84      *
  85      *
  86      * @param vAlcodon
  87      * @throws java.lang.IndexOutOfBoundsException if the index
  88      * given is outside the bounds of the collection
  89      */
  90     public void addAlcodon(
  91             final jalview.schemabinding.version2.Alcodon vAlcodon)
  92     throws java.lang.IndexOutOfBoundsException {
  93         this._alcodonList.addElement(vAlcodon);
  94     }
  95
  96     /**
  97      *
  98      *
  99      * @param index
 100      * @param vAlcodon
 101      * @throws java.lang.IndexOutOfBoundsException if the index
 102      * given is outside the bounds of the collection
 103      */
 104     public void addAlcodon(
 105             final int index,
 106             final jalview.schemabinding.version2.Alcodon vAlcodon)
 107     throws java.lang.IndexOutOfBoundsException {
 108         this._alcodonList.add(index, vAlcodon);
 109     }
 110
 111     /**
 112      * Method enumerateAlcodMap.
 113      *
 114      * @return an Enumeration over all
 115      * jalview.schemabinding.version2.AlcodMap elements
 116      */
 117     public java.util.Enumeration enumerateAlcodMap(
 118     ) {
 119         return this._alcodMapList.elements();
 120     }
 121
 122     /**
 123      * Method enumerateAlcodon.
 124      *
 125      * @return an Enumeration over all
 126      * jalview.schemabinding.version2.Alcodon elements
 127      */
 128     public java.util.Enumeration enumerateAlcodon(
 129     ) {
 130         return this._alcodonList.elements();
 131     }
 132
 133     /**
 134      * Method getAlcodMap.
 135      *
 136      * @param index
 137      * @throws java.lang.IndexOutOfBoundsException if the index
 138      * given is outside the bounds of the collection
 139      * @return the value of the
 140      * jalview.schemabinding.version2.AlcodMap at the given index
 141      */
 142     public jalview.schemabinding.version2.AlcodMap getAlcodMap(
 143             final int index)
 144     throws java.lang.IndexOutOfBoundsException {
 145         // check bounds for index
 146         if (index < 0 || index >= this._alcodMapList.size()) {
 147             throw new IndexOutOfBoundsException("getAlcodMap: Index value '" + index + "' not in range [0.." + (this._alcodMapList.size() - 1) + "]");
 148         }
 149
 150         return (jalview.schemabinding.version2.AlcodMap) _alcodMapList.get(index);
 151     }
 152
 153     /**
 154      * Method getAlcodMap.Returns the contents of the collection in
 155      * an Array.  <p>Note:  Just in case the collection contents
 156      * are changing in another thread, we pass a 0-length Array of
 157      * the correct type into the API call.  This way we <i>know</i>
 158      * that the Array returned is of exactly the correct length.
 159      *
 160      * @return this collection as an Array
 161      */
 162     public jalview.schemabinding.version2.AlcodMap[] getAlcodMap(
 163     ) {
 164         jalview.schemabinding.version2.AlcodMap[] array = new jalview.schemabinding.version2.AlcodMap[0];
 165         return (jalview.schemabinding.version2.AlcodMap[]) this._alcodMapList.toArray(array);
 166     }
 167
 168     /**
 169      * Method getAlcodMapCount.
 170      *
 171      * @return the size of this collection
 172      */
 173     public int getAlcodMapCount(
 174     ) {
 175         return this._alcodMapList.size();
 176     }
 177
 178     /**
 179      * Method getAlcodon.
 180      *
 181      * @param index
 182      * @throws java.lang.IndexOutOfBoundsException if the index
 183      * given is outside the bounds of the collection
 184      * @return the value of the
 185      * jalview.schemabinding.version2.Alcodon at the given index
 186      */
 187     public jalview.schemabinding.version2.Alcodon getAlcodon(
 188             final int index)
 189     throws java.lang.IndexOutOfBoundsException {
 190         // check bounds for index
 191         if (index < 0 || index >= this._alcodonList.size()) {
 192             throw new IndexOutOfBoundsException("getAlcodon: Index value '" + index + "' not in range [0.." + (this._alcodonList.size() - 1) + "]");
 193         }
 194
 195         return (jalview.schemabinding.version2.Alcodon) _alcodonList.get(index);
 196     }
 197
 198     /**
 199      * Method getAlcodon.Returns the contents of the collection in
 200      * an Array.  <p>Note:  Just in case the collection contents
 201      * are changing in another thread, we pass a 0-length Array of
 202      * the correct type into the API call.  This way we <i>know</i>
 203      * that the Array returned is of exactly the correct length.
 204      *
 205      * @return this collection as an Array
 206      */
 207     public jalview.schemabinding.version2.Alcodon[] getAlcodon(
 208     ) {
 209         jalview.schemabinding.version2.Alcodon[] array = new jalview.schemabinding.version2.Alcodon[0];
 210         return (jalview.schemabinding.version2.Alcodon[]) this._alcodonList.toArray(array);
 211     }
 212
 213     /**
 214      * Method getAlcodonCount.
 215      *
 216      * @return the size of this collection
 217      */
 218     public int getAlcodonCount(
 219     ) {
 220         return this._alcodonList.size();
 221     }
 222
 223     /**
 224      * Method isValid.
 225      *
 226      * @return true if this object is valid according to the schema
 227      */
 228     public boolean isValid(
 229     ) {
 230         try {
 231             validate();
 232         } catch (org.exolab.castor.xml.ValidationException vex) {
 233             return false;
 234         }
 235         return true;
 236     }
 237
 238     /**
 239      *
 240      *
 241      * @param out
 242      * @throws org.exolab.castor.xml.MarshalException if object is
 243      * null or if any SAXException is thrown during marshaling
 244      * @throws org.exolab.castor.xml.ValidationException if this
 245      * object is an invalid instance according to the schema
 246      */
 247     public void marshal(
 248             final java.io.Writer out)
 249     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 250         Marshaller.marshal(this, out);
 251     }
 252
 253     /**
 254      *
 255      *
 256      * @param handler
 257      * @throws java.io.IOException if an IOException occurs during
 258      * marshaling
 259      * @throws org.exolab.castor.xml.ValidationException if this
 260      * object is an invalid instance according to the schema
 261      * @throws org.exolab.castor.xml.MarshalException if object is
 262      * null or if any SAXException is thrown during marshaling
 263      */
 264     public void marshal(
 265             final org.xml.sax.ContentHandler handler)
 266     throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 267         Marshaller.marshal(this, handler);
 268     }
 269
 270     /**
 271      * Method removeAlcodMap.
 272      *
 273      * @param vAlcodMap
 274      * @return true if the object was removed from the collection.
 275      */
 276     public boolean removeAlcodMap(
 277             final jalview.schemabinding.version2.AlcodMap vAlcodMap) {
 278         boolean removed = _alcodMapList.remove(vAlcodMap);
 279         return removed;
 280     }
 281
 282     /**
 283      * Method removeAlcodMapAt.
 284      *
 285      * @param index
 286      * @return the element removed from the collection
 287      */
 288     public jalview.schemabinding.version2.AlcodMap removeAlcodMapAt(
 289             final int index) {
 290         java.lang.Object obj = this._alcodMapList.remove(index);
 291         return (jalview.schemabinding.version2.AlcodMap) obj;
 292     }
 293
 294     /**
 295      * Method removeAlcodon.
 296      *
 297      * @param vAlcodon
 298      * @return true if the object was removed from the collection.
 299      */
 300     public boolean removeAlcodon(
 301             final jalview.schemabinding.version2.Alcodon vAlcodon) {
 302         boolean removed = _alcodonList.remove(vAlcodon);
 303         return removed;
 304     }
 305
 306     /**
 307      * Method removeAlcodonAt.
 308      *
 309      * @param index
 310      * @return the element removed from the collection
 311      */
 312     public jalview.schemabinding.version2.Alcodon removeAlcodonAt(
 313             final int index) {
 314         java.lang.Object obj = this._alcodonList.remove(index);
 315         return (jalview.schemabinding.version2.Alcodon) obj;
 316     }
 317
 318     /**
 319      */
 320     public void removeAllAlcodMap(
 321     ) {
 322         this._alcodMapList.clear();
 323     }
 324
 325     /**
 326      */
 327     public void removeAllAlcodon(
 328     ) {
 329         this._alcodonList.clear();
 330     }
 331
 332     /**
 333      *
 334      *
 335      * @param index
 336      * @param vAlcodMap
 337      * @throws java.lang.IndexOutOfBoundsException if the index
 338      * given is outside the bounds of the collection
 339      */
 340     public void setAlcodMap(
 341             final int index,
 342             final jalview.schemabinding.version2.AlcodMap vAlcodMap)
 343     throws java.lang.IndexOutOfBoundsException {
 344         // check bounds for index
 345         if (index < 0 || index >= this._alcodMapList.size()) {
 346             throw new IndexOutOfBoundsException("setAlcodMap: Index value '" + index + "' not in range [0.." + (this._alcodMapList.size() - 1) + "]");
 347         }
 348
 349         this._alcodMapList.set(index, vAlcodMap);
 350     }
 351
 352     /**
 353      *
 354      *
 355      * @param vAlcodMapArray
 356      */
 357     public void setAlcodMap(
 358             final jalview.schemabinding.version2.AlcodMap[] vAlcodMapArray) {
 359         //-- copy array
 360         _alcodMapList.clear();
 361
 362         for (int i = 0; i < vAlcodMapArray.length; i++) {
 363                 this._alcodMapList.add(vAlcodMapArray[i]);
 364         }
 365     }
 366
 367     /**
 368      *
 369      *
 370      * @param index
 371      * @param vAlcodon
 372      * @throws java.lang.IndexOutOfBoundsException if the index
 373      * given is outside the bounds of the collection
 374      */
 375     public void setAlcodon(
 376             final int index,
 377             final jalview.schemabinding.version2.Alcodon vAlcodon)
 378     throws java.lang.IndexOutOfBoundsException {
 379         // check bounds for index
 380         if (index < 0 || index >= this._alcodonList.size()) {
 381             throw new IndexOutOfBoundsException("setAlcodon: Index value '" + index + "' not in range [0.." + (this._alcodonList.size() - 1) + "]");
 382         }
 383
 384         this._alcodonList.set(index, vAlcodon);
 385     }
 386
 387     /**
 388      *
 389      *
 390      * @param vAlcodonArray
 391      */
 392     public void setAlcodon(
 393             final jalview.schemabinding.version2.Alcodon[] vAlcodonArray) {
 394         //-- copy array
 395         _alcodonList.clear();
 396
 397         for (int i = 0; i < vAlcodonArray.length; i++) {
 398                 this._alcodonList.add(vAlcodonArray[i]);
 399         }
 400     }
 401
 402     /**
 403      * Method unmarshal.
 404      *
 405      * @param reader
 406      * @throws org.exolab.castor.xml.MarshalException if object is
 407      * null or if any SAXException is thrown during marshaling
 408      * @throws org.exolab.castor.xml.ValidationException if this
 409      * object is an invalid instance according to the schema
 410      * @return the unmarshaled
 411      * jalview.schemabinding.version2.AlcodonFrame
 412      */
 413     public static jalview.schemabinding.version2.AlcodonFrame unmarshal(
 414             final java.io.Reader reader)
 415     throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
 416         return (jalview.schemabinding.version2.AlcodonFrame) Unmarshaller.unmarshal(jalview.schemabinding.version2.AlcodonFrame.class, reader);
 417     }
 418
 419     /**
 420      *
 421      *
 422      * @throws org.exolab.castor.xml.ValidationException if this
 423      * object is an invalid instance according to the schema
 424      */
 425     public void validate(
 426     )
 427     throws org.exolab.castor.xml.ValidationException {
 428         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 429         validator.validate(this);
 430     }
 431
 432 }