src/jalview/schemabinding/version2/Pdbentry.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 Pdbentry.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class Pdbentry implements java.io.Serializable {\r
  32 \r
  33 \r
  34       //--------------------------/\r
  35      //- Class/Member Variables -/\r
  36     //--------------------------/\r
  37 \r
  38     /**\r
  39      * Field _id\r
  40      */\r
  41     private java.lang.String _id;\r
  42 \r
  43     /**\r
  44      * Field _type\r
  45      */\r
  46     private java.lang.String _type;\r
  47 \r
  48     /**\r
  49      * Field _file\r
  50      */\r
  51     private java.lang.String _file;\r
  52 \r
  53     /**\r
  54      * Field _items\r
  55      */\r
  56     private java.util.Vector _items;\r
  57 \r
  58 \r
  59       //----------------/\r
  60      //- Constructors -/\r
  61     //----------------/\r
  62 \r
  63     public Pdbentry() {\r
  64         super();\r
  65         _items = new Vector();\r
  66     } //-- jalview.schemabinding.version2.Pdbentry()\r
  67 \r
  68 \r
  69       //-----------/\r
  70      //- Methods -/\r
  71     //-----------/\r
  72 \r
  73     /**\r
  74      * Method addPdbentryItem\r
  75      * \r
  76      * \r
  77      * \r
  78      * @param vPdbentryItem\r
  79      */\r
  80     public void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
  81         throws java.lang.IndexOutOfBoundsException\r
  82     {\r
  83         _items.addElement(vPdbentryItem);\r
  84     } //-- void addPdbentryItem(jalview.schemabinding.version2.PdbentryItem) \r
  85 \r
  86     /**\r
  87      * Method addPdbentryItem\r
  88      * \r
  89      * \r
  90      * \r
  91      * @param index\r
  92      * @param vPdbentryItem\r
  93      */\r
  94     public void addPdbentryItem(int index, jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
  95         throws java.lang.IndexOutOfBoundsException\r
  96     {\r
  97         _items.insertElementAt(vPdbentryItem, index);\r
  98     } //-- void addPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem) \r
  99 \r
 100     /**\r
 101      * Method enumeratePdbentryItem\r
 102      * \r
 103      * \r
 104      * \r
 105      * @return Enumeration\r
 106      */\r
 107     public java.util.Enumeration enumeratePdbentryItem()\r
 108     {\r
 109         return _items.elements();\r
 110     } //-- java.util.Enumeration enumeratePdbentryItem() \r
 111 \r
 112     /**\r
 113      * Returns the value of field 'file'.\r
 114      * \r
 115      * @return String\r
 116      * @return the value of field 'file'.\r
 117      */\r
 118     public java.lang.String getFile()\r
 119     {\r
 120         return this._file;\r
 121     } //-- java.lang.String getFile() \r
 122 \r
 123     /**\r
 124      * Returns the value of field 'id'.\r
 125      * \r
 126      * @return String\r
 127      * @return the value of field 'id'.\r
 128      */\r
 129     public java.lang.String getId()\r
 130     {\r
 131         return this._id;\r
 132     } //-- java.lang.String getId() \r
 133 \r
 134     /**\r
 135      * Method getPdbentryItem\r
 136      * \r
 137      * \r
 138      * \r
 139      * @param index\r
 140      * @return PdbentryItem\r
 141      */\r
 142     public jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int index)\r
 143         throws java.lang.IndexOutOfBoundsException\r
 144     {\r
 145         //-- check bounds for index\r
 146         if ((index < 0) || (index > _items.size())) {\r
 147             throw new IndexOutOfBoundsException();\r
 148         }\r
 149         \r
 150         return (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
 151     } //-- jalview.schemabinding.version2.PdbentryItem getPdbentryItem(int) \r
 152 \r
 153     /**\r
 154      * Method getPdbentryItem\r
 155      * \r
 156      * \r
 157      * \r
 158      * @return PdbentryItem\r
 159      */\r
 160     public jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem()\r
 161     {\r
 162         int size = _items.size();\r
 163         jalview.schemabinding.version2.PdbentryItem[] mArray = new jalview.schemabinding.version2.PdbentryItem[size];\r
 164         for (int index = 0; index < size; index++) {\r
 165             mArray[index] = (jalview.schemabinding.version2.PdbentryItem) _items.elementAt(index);\r
 166         }\r
 167         return mArray;\r
 168     } //-- jalview.schemabinding.version2.PdbentryItem[] getPdbentryItem() \r
 169 \r
 170     /**\r
 171      * Method getPdbentryItemCount\r
 172      * \r
 173      * \r
 174      * \r
 175      * @return int\r
 176      */\r
 177     public int getPdbentryItemCount()\r
 178     {\r
 179         return _items.size();\r
 180     } //-- int getPdbentryItemCount() \r
 181 \r
 182     /**\r
 183      * Returns the value of field 'type'.\r
 184      * \r
 185      * @return String\r
 186      * @return the value of field 'type'.\r
 187      */\r
 188     public java.lang.String getType()\r
 189     {\r
 190         return this._type;\r
 191     } //-- java.lang.String getType() \r
 192 \r
 193     /**\r
 194      * Method isValid\r
 195      * \r
 196      * \r
 197      * \r
 198      * @return boolean\r
 199      */\r
 200     public boolean isValid()\r
 201     {\r
 202         try {\r
 203             validate();\r
 204         }\r
 205         catch (org.exolab.castor.xml.ValidationException vex) {\r
 206             return false;\r
 207         }\r
 208         return true;\r
 209     } //-- boolean isValid() \r
 210 \r
 211     /**\r
 212      * Method marshal\r
 213      * \r
 214      * \r
 215      * \r
 216      * @param out\r
 217      */\r
 218     public void marshal(java.io.Writer out)\r
 219         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 220     {\r
 221         \r
 222         Marshaller.marshal(this, out);\r
 223     } //-- void marshal(java.io.Writer) \r
 224 \r
 225     /**\r
 226      * Method marshal\r
 227      * \r
 228      * \r
 229      * \r
 230      * @param handler\r
 231      */\r
 232     public void marshal(org.xml.sax.ContentHandler handler)\r
 233         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 234     {\r
 235         \r
 236         Marshaller.marshal(this, handler);\r
 237     } //-- void marshal(org.xml.sax.ContentHandler) \r
 238 \r
 239     /**\r
 240      * Method removeAllPdbentryItem\r
 241      * \r
 242      */\r
 243     public void removeAllPdbentryItem()\r
 244     {\r
 245         _items.removeAllElements();\r
 246     } //-- void removeAllPdbentryItem() \r
 247 \r
 248     /**\r
 249      * Method removePdbentryItem\r
 250      * \r
 251      * \r
 252      * \r
 253      * @param index\r
 254      * @return PdbentryItem\r
 255      */\r
 256     public jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int index)\r
 257     {\r
 258         java.lang.Object obj = _items.elementAt(index);\r
 259         _items.removeElementAt(index);\r
 260         return (jalview.schemabinding.version2.PdbentryItem) obj;\r
 261     } //-- jalview.schemabinding.version2.PdbentryItem removePdbentryItem(int) \r
 262 \r
 263     /**\r
 264      * Sets the value of field 'file'.\r
 265      * \r
 266      * @param file the value of field 'file'.\r
 267      */\r
 268     public void setFile(java.lang.String file)\r
 269     {\r
 270         this._file = file;\r
 271     } //-- void setFile(java.lang.String) \r
 272 \r
 273     /**\r
 274      * Sets the value of field 'id'.\r
 275      * \r
 276      * @param id the value of field 'id'.\r
 277      */\r
 278     public void setId(java.lang.String id)\r
 279     {\r
 280         this._id = id;\r
 281     } //-- void setId(java.lang.String) \r
 282 \r
 283     /**\r
 284      * Method setPdbentryItem\r
 285      * \r
 286      * \r
 287      * \r
 288      * @param index\r
 289      * @param vPdbentryItem\r
 290      */\r
 291     public void setPdbentryItem(int index, jalview.schemabinding.version2.PdbentryItem vPdbentryItem)\r
 292         throws java.lang.IndexOutOfBoundsException\r
 293     {\r
 294         //-- check bounds for index\r
 295         if ((index < 0) || (index > _items.size())) {\r
 296             throw new IndexOutOfBoundsException();\r
 297         }\r
 298         _items.setElementAt(vPdbentryItem, index);\r
 299     } //-- void setPdbentryItem(int, jalview.schemabinding.version2.PdbentryItem) \r
 300 \r
 301     /**\r
 302      * Method setPdbentryItem\r
 303      * \r
 304      * \r
 305      * \r
 306      * @param pdbentryItemArray\r
 307      */\r
 308     public void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem[] pdbentryItemArray)\r
 309     {\r
 310         //-- copy array\r
 311         _items.removeAllElements();\r
 312         for (int i = 0; i < pdbentryItemArray.length; i++) {\r
 313             _items.addElement(pdbentryItemArray[i]);\r
 314         }\r
 315     } //-- void setPdbentryItem(jalview.schemabinding.version2.PdbentryItem) \r
 316 \r
 317     /**\r
 318      * Sets the value of field 'type'.\r
 319      * \r
 320      * @param type the value of field 'type'.\r
 321      */\r
 322     public void setType(java.lang.String type)\r
 323     {\r
 324         this._type = type;\r
 325     } //-- void setType(java.lang.String) \r
 326 \r
 327     /**\r
 328      * Method unmarshal\r
 329      * \r
 330      * \r
 331      * \r
 332      * @param reader\r
 333      * @return Object\r
 334      */\r
 335     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 336         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 337     {\r
 338         return (jalview.schemabinding.version2.Pdbentry) Unmarshaller.unmarshal(jalview.schemabinding.version2.Pdbentry.class, reader);\r
 339     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 340 \r
 341     /**\r
 342      * Method validate\r
 343      * \r
 344      */\r
 345     public void validate()\r
 346         throws org.exolab.castor.xml.ValidationException\r
 347     {\r
 348         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 349         validator.validate(this);\r
 350     } //-- void validate() \r
 351 \r
 352 }\r