src/jalview/binding/JalviewModelSequence2.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 * Jalview - A Sequence Alignment Editor and Viewer\r
   9 * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
  10 *\r
  11 * This program is free software; you can redistribute it and/or\r
  12 * modify it under the terms of the GNU General Public License\r
  13 * as published by the Free Software Foundation; either version 2\r
  14 * of the License, or (at your option) any later version.\r
  15 *\r
  16 * This program is distributed in the hope that it will be useful,\r
  17 * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  19 * GNU General Public License for more details.\r
  20 *\r
  21 * You should have received a copy of the GNU General Public License\r
  22 * along with this program; if not, write to the Free Software\r
  23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
  24 */\r
  25 package jalview.binding;\r
  26 \r
  27 import org.exolab.castor.xml.MarshalException;\r
  28 import org.exolab.castor.xml.Marshaller;\r
  29 import org.exolab.castor.xml.Unmarshaller;\r
  30 import org.exolab.castor.xml.ValidationException;\r
  31 \r
  32 import org.xml.sax.ContentHandler;\r
  33 \r
  34 //---------------------------------/\r
  35 //- Imported classes and packages -/\r
  36 //---------------------------------/\r
  37 import java.io.IOException;\r
  38 import java.io.Reader;\r
  39 import java.io.Serializable;\r
  40 import java.io.Writer;\r
  41 \r
  42 import java.util.Enumeration;\r
  43 import java.util.Vector;\r
  44 \r
  45 \r
  46 /**\r
  47  * Class JalviewModelSequence2.\r
  48  *\r
  49  * @version $Revision$ $Date$\r
  50  */\r
  51 public class JalviewModelSequence2 implements java.io.Serializable {\r
  52     //--------------------------/\r
  53     //- Class/Member Variables -/\r
  54     //--------------------------/\r
  55 \r
  56     /**\r
  57      * Field _items\r
  58      */\r
  59     private java.util.Vector _items;\r
  60 \r
  61     //----------------/\r
  62     //- Constructors -/\r
  63     //----------------/\r
  64     public JalviewModelSequence2() {\r
  65         super();\r
  66         _items = new Vector();\r
  67     }\r
  68      //-- jalview.binding.JalviewModelSequence2()\r
  69  //-----------/\r
  70 \r
  71     public void addJalviewModelSequence2Item(\r
  72         jalview.binding.JalviewModelSequence2Item vJalviewModelSequence2Item)\r
  73         throws java.lang.IndexOutOfBoundsException {\r
  74         _items.addElement(vJalviewModelSequence2Item);\r
  75     }\r
  76      //-- void addJalviewModelSequence2Item(jalview.binding.JalviewModelSequence2Item)\r
  77 \r
  78     /**\r
  79      * Method addJalviewModelSequence2Item\r
  80      *\r
  81      *\r
  82      *\r
  83      * @param index\r
  84      * @param vJalviewModelSequence2Item\r
  85      */\r
  86     public void addJalviewModelSequence2Item(int index,\r
  87         jalview.binding.JalviewModelSequence2Item vJalviewModelSequence2Item)\r
  88         throws java.lang.IndexOutOfBoundsException {\r
  89         _items.insertElementAt(vJalviewModelSequence2Item, index);\r
  90     }\r
  91      //-- void addJalviewModelSequence2Item(int, jalview.binding.JalviewModelSequence2Item)\r
  92 \r
  93     /**\r
  94      * Method enumerateJalviewModelSequence2Item\r
  95      *\r
  96      *\r
  97      *\r
  98      * @return Enumeration\r
  99      */\r
 100     public java.util.Enumeration enumerateJalviewModelSequence2Item() {\r
 101         return _items.elements();\r
 102     }\r
 103      //-- java.util.Enumeration enumerateJalviewModelSequence2Item()\r
 104 \r
 105     /**\r
 106      * Method getJalviewModelSequence2Item\r
 107      *\r
 108      *\r
 109      *\r
 110      * @param index\r
 111      * @return JalviewModelSequence2Item\r
 112      */\r
 113     public jalview.binding.JalviewModelSequence2Item getJalviewModelSequence2Item(\r
 114         int index) throws java.lang.IndexOutOfBoundsException {\r
 115         //-- check bounds for index\r
 116         if ((index < 0) || (index > _items.size())) {\r
 117             throw new IndexOutOfBoundsException();\r
 118         }\r
 119 \r
 120         return (jalview.binding.JalviewModelSequence2Item) _items.elementAt(index);\r
 121     }\r
 122      //-- jalview.binding.JalviewModelSequence2Item getJalviewModelSequence2Item(int)\r
 123 \r
 124     /**\r
 125      * Method getJalviewModelSequence2Item\r
 126      *\r
 127      *\r
 128      *\r
 129      * @return JalviewModelSequence2Item\r
 130      */\r
 131     public jalview.binding.JalviewModelSequence2Item[] getJalviewModelSequence2Item() {\r
 132         int size = _items.size();\r
 133         jalview.binding.JalviewModelSequence2Item[] mArray = new jalview.binding.JalviewModelSequence2Item[size];\r
 134 \r
 135         for (int index = 0; index < size; index++) {\r
 136             mArray[index] = (jalview.binding.JalviewModelSequence2Item) _items.elementAt(index);\r
 137         }\r
 138 \r
 139         return mArray;\r
 140     }\r
 141      //-- jalview.binding.JalviewModelSequence2Item[] getJalviewModelSequence2Item()\r
 142 \r
 143     /**\r
 144      * Method getJalviewModelSequence2ItemCount\r
 145      *\r
 146      *\r
 147      *\r
 148      * @return int\r
 149      */\r
 150     public int getJalviewModelSequence2ItemCount() {\r
 151         return _items.size();\r
 152     }\r
 153      //-- int getJalviewModelSequence2ItemCount()\r
 154 \r
 155     /**\r
 156      * Method isValid\r
 157      *\r
 158      *\r
 159      *\r
 160      * @return boolean\r
 161      */\r
 162     public boolean isValid() {\r
 163         try {\r
 164             validate();\r
 165         } catch (org.exolab.castor.xml.ValidationException vex) {\r
 166             return false;\r
 167         }\r
 168 \r
 169         return true;\r
 170     }\r
 171      //-- boolean isValid()\r
 172 \r
 173     /**\r
 174      * Method marshal\r
 175      *\r
 176      *\r
 177      *\r
 178      * @param out\r
 179      */\r
 180     public void marshal(java.io.Writer out)\r
 181         throws org.exolab.castor.xml.MarshalException, \r
 182             org.exolab.castor.xml.ValidationException {\r
 183         Marshaller.marshal(this, out);\r
 184     }\r
 185      //-- void marshal(java.io.Writer)\r
 186 \r
 187     /**\r
 188      * Method marshal\r
 189      *\r
 190      *\r
 191      *\r
 192      * @param handler\r
 193      */\r
 194     public void marshal(org.xml.sax.ContentHandler handler)\r
 195         throws java.io.IOException, org.exolab.castor.xml.MarshalException, \r
 196             org.exolab.castor.xml.ValidationException {\r
 197         Marshaller.marshal(this, handler);\r
 198     }\r
 199      //-- void marshal(org.xml.sax.ContentHandler)\r
 200 \r
 201     /**\r
 202      * Method removeAllJalviewModelSequence2Item\r
 203      *\r
 204      */\r
 205     public void removeAllJalviewModelSequence2Item() {\r
 206         _items.removeAllElements();\r
 207     }\r
 208      //-- void removeAllJalviewModelSequence2Item()\r
 209 \r
 210     /**\r
 211      * Method removeJalviewModelSequence2Item\r
 212      *\r
 213      *\r
 214      *\r
 215      * @param index\r
 216      * @return JalviewModelSequence2Item\r
 217      */\r
 218     public jalview.binding.JalviewModelSequence2Item removeJalviewModelSequence2Item(\r
 219         int index) {\r
 220         java.lang.Object obj = _items.elementAt(index);\r
 221         _items.removeElementAt(index);\r
 222 \r
 223         return (jalview.binding.JalviewModelSequence2Item) obj;\r
 224     }\r
 225      //-- jalview.binding.JalviewModelSequence2Item removeJalviewModelSequence2Item(int)\r
 226 \r
 227     /**\r
 228      * Method setJalviewModelSequence2Item\r
 229      *\r
 230      *\r
 231      *\r
 232      * @param index\r
 233      * @param vJalviewModelSequence2Item\r
 234      */\r
 235     public void setJalviewModelSequence2Item(int index,\r
 236         jalview.binding.JalviewModelSequence2Item vJalviewModelSequence2Item)\r
 237         throws java.lang.IndexOutOfBoundsException {\r
 238         //-- check bounds for index\r
 239         if ((index < 0) || (index > _items.size())) {\r
 240             throw new IndexOutOfBoundsException();\r
 241         }\r
 242 \r
 243         _items.setElementAt(vJalviewModelSequence2Item, index);\r
 244     }\r
 245      //-- void setJalviewModelSequence2Item(int, jalview.binding.JalviewModelSequence2Item)\r
 246 \r
 247     /**\r
 248      * Method setJalviewModelSequence2Item\r
 249      *\r
 250      *\r
 251      *\r
 252      * @param jalviewModelSequence2ItemArray\r
 253      */\r
 254     public void setJalviewModelSequence2Item(\r
 255         jalview.binding.JalviewModelSequence2Item[] jalviewModelSequence2ItemArray) {\r
 256         //-- copy array\r
 257         _items.removeAllElements();\r
 258 \r
 259         for (int i = 0; i < jalviewModelSequence2ItemArray.length; i++) {\r
 260             _items.addElement(jalviewModelSequence2ItemArray[i]);\r
 261         }\r
 262     }\r
 263      //-- void setJalviewModelSequence2Item(jalview.binding.JalviewModelSequence2Item)\r
 264 \r
 265     /**\r
 266      * Method unmarshal\r
 267      *\r
 268      *\r
 269      *\r
 270      * @param reader\r
 271      * @return Object\r
 272      */\r
 273     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 274         throws org.exolab.castor.xml.MarshalException, \r
 275             org.exolab.castor.xml.ValidationException {\r
 276         return (jalview.binding.JalviewModelSequence2) Unmarshaller.unmarshal(jalview.binding.JalviewModelSequence2.class,\r
 277             reader);\r
 278     }\r
 279      //-- java.lang.Object unmarshal(java.io.Reader)\r
 280 \r
 281     /**\r
 282      * Method validate\r
 283      *\r
 284      */\r
 285     public void validate() throws org.exolab.castor.xml.ValidationException {\r
 286         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 287         validator.validate(this);\r
 288     }\r
 289      //-- void validate()\r
 290 }\r