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