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