src/jalview/schemabinding/version2/Sequence.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 Sequence.\r
  20  *\r
  21  * @version $Revision$ $Date$\r
  22  */\r
  23 public class Sequence\r
  24     extends jalview.schemabinding.version2.SequenceType implements java.io.\r
  25     Serializable\r
  26 {\r
  27 \r
  28   //--------------------------/\r
  29   //- Class/Member Variables -/\r
  30   //--------------------------/\r
  31 \r
  32   /**\r
  33    * Field _DBRefList\r
  34    */\r
  35   private java.util.Vector _DBRefList;\r
  36 \r
  37   //----------------/\r
  38   //- Constructors -/\r
  39   //----------------/\r
  40 \r
  41   public Sequence()\r
  42   {\r
  43     super();\r
  44     _DBRefList = new Vector();\r
  45   } //-- jalview.schemabinding.version2.Sequence()\r
  46 \r
  47   //-----------/\r
  48   //- Methods -/\r
  49   //-----------/\r
  50 \r
  51   /**\r
  52    * Method addDBRef\r
  53    *\r
  54    *\r
  55    *\r
  56    * @param vDBRef\r
  57    */\r
  58   public void addDBRef(jalview.schemabinding.version2.DBRef vDBRef)\r
  59       throws java.lang.IndexOutOfBoundsException\r
  60   {\r
  61     _DBRefList.addElement(vDBRef);\r
  62   } //-- void addDBRef(jalview.schemabinding.version2.DBRef)\r
  63 \r
  64   /**\r
  65    * Method addDBRef\r
  66    *\r
  67    *\r
  68    *\r
  69    * @param index\r
  70    * @param vDBRef\r
  71    */\r
  72   public void addDBRef(int index, jalview.schemabinding.version2.DBRef vDBRef)\r
  73       throws java.lang.IndexOutOfBoundsException\r
  74   {\r
  75     _DBRefList.insertElementAt(vDBRef, index);\r
  76   } //-- void addDBRef(int, jalview.schemabinding.version2.DBRef)\r
  77 \r
  78   /**\r
  79    * Method enumerateDBRef\r
  80    *\r
  81    *\r
  82    *\r
  83    * @return Enumeration\r
  84    */\r
  85   public java.util.Enumeration enumerateDBRef()\r
  86   {\r
  87     return _DBRefList.elements();\r
  88   } //-- java.util.Enumeration enumerateDBRef()\r
  89 \r
  90   /**\r
  91    * Method getDBRef\r
  92    *\r
  93    *\r
  94    *\r
  95    * @param index\r
  96    * @return DBRef\r
  97    */\r
  98   public jalview.schemabinding.version2.DBRef getDBRef(int index)\r
  99       throws java.lang.IndexOutOfBoundsException\r
 100   {\r
 101     //-- check bounds for index\r
 102     if ( (index < 0) || (index > _DBRefList.size()))\r
 103     {\r
 104       throw new IndexOutOfBoundsException();\r
 105     }\r
 106 \r
 107     return (jalview.schemabinding.version2.DBRef) _DBRefList.elementAt(index);\r
 108   } //-- jalview.schemabinding.version2.DBRef getDBRef(int)\r
 109 \r
 110   /**\r
 111    * Method getDBRef\r
 112    *\r
 113    *\r
 114    *\r
 115    * @return DBRef\r
 116    */\r
 117   public jalview.schemabinding.version2.DBRef[] getDBRef()\r
 118   {\r
 119     int size = _DBRefList.size();\r
 120     jalview.schemabinding.version2.DBRef[] mArray = new jalview.schemabinding.\r
 121         version2.DBRef[size];\r
 122     for (int index = 0; index < size; index++)\r
 123     {\r
 124       mArray[index] = (jalview.schemabinding.version2.DBRef) _DBRefList.\r
 125           elementAt(index);\r
 126     }\r
 127     return mArray;\r
 128   } //-- jalview.schemabinding.version2.DBRef[] getDBRef()\r
 129 \r
 130   /**\r
 131    * Method getDBRefCount\r
 132    *\r
 133    *\r
 134    *\r
 135    * @return int\r
 136    */\r
 137   public int getDBRefCount()\r
 138   {\r
 139     return _DBRefList.size();\r
 140   } //-- int getDBRefCount()\r
 141 \r
 142   /**\r
 143    * Method isValid\r
 144    *\r
 145    *\r
 146    *\r
 147    * @return boolean\r
 148    */\r
 149   public boolean isValid()\r
 150   {\r
 151     try\r
 152     {\r
 153       validate();\r
 154     }\r
 155     catch (org.exolab.castor.xml.ValidationException vex)\r
 156     {\r
 157       return false;\r
 158     }\r
 159     return true;\r
 160   } //-- boolean isValid()\r
 161 \r
 162   /**\r
 163    * Method marshal\r
 164    *\r
 165    *\r
 166    *\r
 167    * @param out\r
 168    */\r
 169   public void marshal(java.io.Writer out)\r
 170       throws org.exolab.castor.xml.MarshalException,\r
 171       org.exolab.castor.xml.ValidationException\r
 172   {\r
 173 \r
 174     Marshaller.marshal(this, out);\r
 175   } //-- void marshal(java.io.Writer)\r
 176 \r
 177   /**\r
 178    * Method marshal\r
 179    *\r
 180    *\r
 181    *\r
 182    * @param handler\r
 183    */\r
 184   public void marshal(org.xml.sax.ContentHandler handler)\r
 185       throws java.io.IOException, org.exolab.castor.xml.MarshalException,\r
 186       org.exolab.castor.xml.ValidationException\r
 187   {\r
 188 \r
 189     Marshaller.marshal(this, handler);\r
 190   } //-- void marshal(org.xml.sax.ContentHandler)\r
 191 \r
 192   /**\r
 193    * Method removeAllDBRef\r
 194    *\r
 195    */\r
 196   public void removeAllDBRef()\r
 197   {\r
 198     _DBRefList.removeAllElements();\r
 199   } //-- void removeAllDBRef()\r
 200 \r
 201   /**\r
 202    * Method removeDBRef\r
 203    *\r
 204    *\r
 205    *\r
 206    * @param index\r
 207    * @return DBRef\r
 208    */\r
 209   public jalview.schemabinding.version2.DBRef removeDBRef(int index)\r
 210   {\r
 211     java.lang.Object obj = _DBRefList.elementAt(index);\r
 212     _DBRefList.removeElementAt(index);\r
 213     return (jalview.schemabinding.version2.DBRef) obj;\r
 214   } //-- jalview.schemabinding.version2.DBRef removeDBRef(int)\r
 215 \r
 216   /**\r
 217    * Method setDBRef\r
 218    *\r
 219    *\r
 220    *\r
 221    * @param index\r
 222    * @param vDBRef\r
 223    */\r
 224   public void setDBRef(int index, jalview.schemabinding.version2.DBRef vDBRef)\r
 225       throws java.lang.IndexOutOfBoundsException\r
 226   {\r
 227     //-- check bounds for index\r
 228     if ( (index < 0) || (index > _DBRefList.size()))\r
 229     {\r
 230       throw new IndexOutOfBoundsException();\r
 231     }\r
 232     _DBRefList.setElementAt(vDBRef, index);\r
 233   } //-- void setDBRef(int, jalview.schemabinding.version2.DBRef)\r
 234 \r
 235   /**\r
 236    * Method setDBRef\r
 237    *\r
 238    *\r
 239    *\r
 240    * @param DBRefArray\r
 241    */\r
 242   public void setDBRef(jalview.schemabinding.version2.DBRef[] DBRefArray)\r
 243   {\r
 244     //-- copy array\r
 245     _DBRefList.removeAllElements();\r
 246     for (int i = 0; i < DBRefArray.length; i++)\r
 247     {\r
 248       _DBRefList.addElement(DBRefArray[i]);\r
 249     }\r
 250   } //-- void setDBRef(jalview.schemabinding.version2.DBRef)\r
 251 \r
 252   /**\r
 253    * Method unmarshal\r
 254    *\r
 255    *\r
 256    *\r
 257    * @param reader\r
 258    * @return Object\r
 259    */\r
 260   public static java.lang.Object unmarshal(java.io.Reader reader)\r
 261       throws org.exolab.castor.xml.MarshalException,\r
 262       org.exolab.castor.xml.ValidationException\r
 263   {\r
 264     return (jalview.schemabinding.version2.Sequence) Unmarshaller.unmarshal(\r
 265         jalview.schemabinding.version2.Sequence.class, reader);\r
 266   } //-- java.lang.Object unmarshal(java.io.Reader)\r
 267 \r
 268   /**\r
 269    * Method validate\r
 270    *\r
 271    */\r
 272   public void validate()\r
 273       throws org.exolab.castor.xml.ValidationException\r
 274   {\r
 275     org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.\r
 276         Validator();\r
 277     validator.validate(this);\r
 278   } //-- void validate()\r
 279 \r
 280 }\r