src/org/vamsas/objects/core/DataSetAnnotations.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 org.vamsas.objects.core;\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 DataSetAnnotations.\r
  28  * \r
  29  * @version $Revision$ $Date$\r
  30  */\r
  31 public class DataSetAnnotations implements java.io.Serializable {\r
  32 \r
  33 \r
  34       //--------------------------/\r
  35      //- Class/Member Variables -/\r
  36     //--------------------------/\r
  37 \r
  38     /**\r
  39      * Field _type\r
  40      */\r
  41     private java.lang.String _type;\r
  42 \r
  43     /**\r
  44      * Field _end\r
  45      */\r
  46     private int _end;\r
  47 \r
  48     /**\r
  49      * keeps track of state for field: _end\r
  50      */\r
  51     private boolean _has_end;\r
  52 \r
  53     /**\r
  54      * Field _begin\r
  55      */\r
  56     private int _begin;\r
  57 \r
  58     /**\r
  59      * keeps track of state for field: _begin\r
  60      */\r
  61     private boolean _has_begin;\r
  62 \r
  63     /**\r
  64      * Field _seqRef\r
  65      */\r
  66     private java.lang.Object _seqRef;\r
  67 \r
  68     /**\r
  69      * Field _id\r
  70      */\r
  71     private java.lang.String _id;\r
  72 \r
  73     /**\r
  74      * Field _description\r
  75      */\r
  76     private java.lang.String _description;\r
  77 \r
  78     /**\r
  79      * Field _status\r
  80      */\r
  81     private java.lang.String _status;\r
  82 \r
  83     /**\r
  84      * Field _annotationElementList\r
  85      */\r
  86     private java.util.Vector _annotationElementList;\r
  87 \r
  88     /**\r
  89      * Field _provenanceList\r
  90      */\r
  91     private java.util.Vector _provenanceList;\r
  92 \r
  93 \r
  94       //----------------/\r
  95      //- Constructors -/\r
  96     //----------------/\r
  97 \r
  98     public DataSetAnnotations() {\r
  99         super();\r
 100         _annotationElementList = new Vector();\r
 101         _provenanceList = new Vector();\r
 102     } //-- org.vamsas.objects.core.DataSetAnnotations()\r
 103 \r
 104 \r
 105       //-----------/\r
 106      //- Methods -/\r
 107     //-----------/\r
 108 \r
 109     /**\r
 110      * Method addAnnotationElement\r
 111      * \r
 112      * \r
 113      * \r
 114      * @param vAnnotationElement\r
 115      */\r
 116     public void addAnnotationElement(org.vamsas.objects.core.AnnotationElement vAnnotationElement)\r
 117         throws java.lang.IndexOutOfBoundsException\r
 118     {\r
 119         _annotationElementList.addElement(vAnnotationElement);\r
 120     } //-- void addAnnotationElement(org.vamsas.objects.core.AnnotationElement) \r
 121 \r
 122     /**\r
 123      * Method addAnnotationElement\r
 124      * \r
 125      * \r
 126      * \r
 127      * @param index\r
 128      * @param vAnnotationElement\r
 129      */\r
 130     public void addAnnotationElement(int index, org.vamsas.objects.core.AnnotationElement vAnnotationElement)\r
 131         throws java.lang.IndexOutOfBoundsException\r
 132     {\r
 133         _annotationElementList.insertElementAt(vAnnotationElement, index);\r
 134     } //-- void addAnnotationElement(int, org.vamsas.objects.core.AnnotationElement) \r
 135 \r
 136     /**\r
 137      * Method addProvenance\r
 138      * \r
 139      * \r
 140      * \r
 141      * @param vProvenance\r
 142      */\r
 143     public void addProvenance(org.vamsas.objects.core.Provenance vProvenance)\r
 144         throws java.lang.IndexOutOfBoundsException\r
 145     {\r
 146         _provenanceList.addElement(vProvenance);\r
 147     } //-- void addProvenance(org.vamsas.objects.core.Provenance) \r
 148 \r
 149     /**\r
 150      * Method addProvenance\r
 151      * \r
 152      * \r
 153      * \r
 154      * @param index\r
 155      * @param vProvenance\r
 156      */\r
 157     public void addProvenance(int index, org.vamsas.objects.core.Provenance vProvenance)\r
 158         throws java.lang.IndexOutOfBoundsException\r
 159     {\r
 160         _provenanceList.insertElementAt(vProvenance, index);\r
 161     } //-- void addProvenance(int, org.vamsas.objects.core.Provenance) \r
 162 \r
 163     /**\r
 164      * Method deleteBegin\r
 165      * \r
 166      */\r
 167     public void deleteBegin()\r
 168     {\r
 169         this._has_begin= false;\r
 170     } //-- void deleteBegin() \r
 171 \r
 172     /**\r
 173      * Method deleteEnd\r
 174      * \r
 175      */\r
 176     public void deleteEnd()\r
 177     {\r
 178         this._has_end= false;\r
 179     } //-- void deleteEnd() \r
 180 \r
 181     /**\r
 182      * Method enumerateAnnotationElement\r
 183      * \r
 184      * \r
 185      * \r
 186      * @return Enumeration\r
 187      */\r
 188     public java.util.Enumeration enumerateAnnotationElement()\r
 189     {\r
 190         return _annotationElementList.elements();\r
 191     } //-- java.util.Enumeration enumerateAnnotationElement() \r
 192 \r
 193     /**\r
 194      * Method enumerateProvenance\r
 195      * \r
 196      * \r
 197      * \r
 198      * @return Enumeration\r
 199      */\r
 200     public java.util.Enumeration enumerateProvenance()\r
 201     {\r
 202         return _provenanceList.elements();\r
 203     } //-- java.util.Enumeration enumerateProvenance() \r
 204 \r
 205     /**\r
 206      * Method getAnnotationElement\r
 207      * \r
 208      * \r
 209      * \r
 210      * @param index\r
 211      * @return AnnotationElement\r
 212      */\r
 213     public org.vamsas.objects.core.AnnotationElement getAnnotationElement(int index)\r
 214         throws java.lang.IndexOutOfBoundsException\r
 215     {\r
 216         //-- check bounds for index\r
 217         if ((index < 0) || (index > _annotationElementList.size())) {\r
 218             throw new IndexOutOfBoundsException();\r
 219         }\r
 220         \r
 221         return (org.vamsas.objects.core.AnnotationElement) _annotationElementList.elementAt(index);\r
 222     } //-- org.vamsas.objects.core.AnnotationElement getAnnotationElement(int) \r
 223 \r
 224     /**\r
 225      * Method getAnnotationElement\r
 226      * \r
 227      * \r
 228      * \r
 229      * @return AnnotationElement\r
 230      */\r
 231     public org.vamsas.objects.core.AnnotationElement[] getAnnotationElement()\r
 232     {\r
 233         int size = _annotationElementList.size();\r
 234         org.vamsas.objects.core.AnnotationElement[] mArray = new org.vamsas.objects.core.AnnotationElement[size];\r
 235         for (int index = 0; index < size; index++) {\r
 236             mArray[index] = (org.vamsas.objects.core.AnnotationElement) _annotationElementList.elementAt(index);\r
 237         }\r
 238         return mArray;\r
 239     } //-- org.vamsas.objects.core.AnnotationElement[] getAnnotationElement() \r
 240 \r
 241     /**\r
 242      * Method getAnnotationElementCount\r
 243      * \r
 244      * \r
 245      * \r
 246      * @return int\r
 247      */\r
 248     public int getAnnotationElementCount()\r
 249     {\r
 250         return _annotationElementList.size();\r
 251     } //-- int getAnnotationElementCount() \r
 252 \r
 253     /**\r
 254      * Returns the value of field 'begin'.\r
 255      * \r
 256      * @return int\r
 257      * @return the value of field 'begin'.\r
 258      */\r
 259     public int getBegin()\r
 260     {\r
 261         return this._begin;\r
 262     } //-- int getBegin() \r
 263 \r
 264     /**\r
 265      * Returns the value of field 'description'.\r
 266      * \r
 267      * @return String\r
 268      * @return the value of field 'description'.\r
 269      */\r
 270     public java.lang.String getDescription()\r
 271     {\r
 272         return this._description;\r
 273     } //-- java.lang.String getDescription() \r
 274 \r
 275     /**\r
 276      * Returns the value of field 'end'.\r
 277      * \r
 278      * @return int\r
 279      * @return the value of field 'end'.\r
 280      */\r
 281     public int getEnd()\r
 282     {\r
 283         return this._end;\r
 284     } //-- int getEnd() \r
 285 \r
 286     /**\r
 287      * Returns the value of field 'id'.\r
 288      * \r
 289      * @return String\r
 290      * @return the value of field 'id'.\r
 291      */\r
 292     public java.lang.String getId()\r
 293     {\r
 294         return this._id;\r
 295     } //-- java.lang.String getId() \r
 296 \r
 297     /**\r
 298      * Method getProvenance\r
 299      * \r
 300      * \r
 301      * \r
 302      * @param index\r
 303      * @return Provenance\r
 304      */\r
 305     public org.vamsas.objects.core.Provenance getProvenance(int index)\r
 306         throws java.lang.IndexOutOfBoundsException\r
 307     {\r
 308         //-- check bounds for index\r
 309         if ((index < 0) || (index > _provenanceList.size())) {\r
 310             throw new IndexOutOfBoundsException();\r
 311         }\r
 312         \r
 313         return (org.vamsas.objects.core.Provenance) _provenanceList.elementAt(index);\r
 314     } //-- org.vamsas.objects.core.Provenance getProvenance(int) \r
 315 \r
 316     /**\r
 317      * Method getProvenance\r
 318      * \r
 319      * \r
 320      * \r
 321      * @return Provenance\r
 322      */\r
 323     public org.vamsas.objects.core.Provenance[] getProvenance()\r
 324     {\r
 325         int size = _provenanceList.size();\r
 326         org.vamsas.objects.core.Provenance[] mArray = new org.vamsas.objects.core.Provenance[size];\r
 327         for (int index = 0; index < size; index++) {\r
 328             mArray[index] = (org.vamsas.objects.core.Provenance) _provenanceList.elementAt(index);\r
 329         }\r
 330         return mArray;\r
 331     } //-- org.vamsas.objects.core.Provenance[] getProvenance() \r
 332 \r
 333     /**\r
 334      * Method getProvenanceCount\r
 335      * \r
 336      * \r
 337      * \r
 338      * @return int\r
 339      */\r
 340     public int getProvenanceCount()\r
 341     {\r
 342         return _provenanceList.size();\r
 343     } //-- int getProvenanceCount() \r
 344 \r
 345     /**\r
 346      * Returns the value of field 'seqRef'.\r
 347      * \r
 348      * @return Object\r
 349      * @return the value of field 'seqRef'.\r
 350      */\r
 351     public java.lang.Object getSeqRef()\r
 352     {\r
 353         return this._seqRef;\r
 354     } //-- java.lang.Object getSeqRef() \r
 355 \r
 356     /**\r
 357      * Returns the value of field 'status'.\r
 358      * \r
 359      * @return String\r
 360      * @return the value of field 'status'.\r
 361      */\r
 362     public java.lang.String getStatus()\r
 363     {\r
 364         return this._status;\r
 365     } //-- java.lang.String getStatus() \r
 366 \r
 367     /**\r
 368      * Returns the value of field 'type'.\r
 369      * \r
 370      * @return String\r
 371      * @return the value of field 'type'.\r
 372      */\r
 373     public java.lang.String getType()\r
 374     {\r
 375         return this._type;\r
 376     } //-- java.lang.String getType() \r
 377 \r
 378     /**\r
 379      * Method hasBegin\r
 380      * \r
 381      * \r
 382      * \r
 383      * @return boolean\r
 384      */\r
 385     public boolean hasBegin()\r
 386     {\r
 387         return this._has_begin;\r
 388     } //-- boolean hasBegin() \r
 389 \r
 390     /**\r
 391      * Method hasEnd\r
 392      * \r
 393      * \r
 394      * \r
 395      * @return boolean\r
 396      */\r
 397     public boolean hasEnd()\r
 398     {\r
 399         return this._has_end;\r
 400     } //-- boolean hasEnd() \r
 401 \r
 402     /**\r
 403      * Method isValid\r
 404      * \r
 405      * \r
 406      * \r
 407      * @return boolean\r
 408      */\r
 409     public boolean isValid()\r
 410     {\r
 411         try {\r
 412             validate();\r
 413         }\r
 414         catch (org.exolab.castor.xml.ValidationException vex) {\r
 415             return false;\r
 416         }\r
 417         return true;\r
 418     } //-- boolean isValid() \r
 419 \r
 420     /**\r
 421      * Method marshal\r
 422      * \r
 423      * \r
 424      * \r
 425      * @param out\r
 426      */\r
 427     public void marshal(java.io.Writer out)\r
 428         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 429     {\r
 430         \r
 431         Marshaller.marshal(this, out);\r
 432     } //-- void marshal(java.io.Writer) \r
 433 \r
 434     /**\r
 435      * Method marshal\r
 436      * \r
 437      * \r
 438      * \r
 439      * @param handler\r
 440      */\r
 441     public void marshal(org.xml.sax.ContentHandler handler)\r
 442         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 443     {\r
 444         \r
 445         Marshaller.marshal(this, handler);\r
 446     } //-- void marshal(org.xml.sax.ContentHandler) \r
 447 \r
 448     /**\r
 449      * Method removeAllAnnotationElement\r
 450      * \r
 451      */\r
 452     public void removeAllAnnotationElement()\r
 453     {\r
 454         _annotationElementList.removeAllElements();\r
 455     } //-- void removeAllAnnotationElement() \r
 456 \r
 457     /**\r
 458      * Method removeAllProvenance\r
 459      * \r
 460      */\r
 461     public void removeAllProvenance()\r
 462     {\r
 463         _provenanceList.removeAllElements();\r
 464     } //-- void removeAllProvenance() \r
 465 \r
 466     /**\r
 467      * Method removeAnnotationElement\r
 468      * \r
 469      * \r
 470      * \r
 471      * @param index\r
 472      * @return AnnotationElement\r
 473      */\r
 474     public org.vamsas.objects.core.AnnotationElement removeAnnotationElement(int index)\r
 475     {\r
 476         java.lang.Object obj = _annotationElementList.elementAt(index);\r
 477         _annotationElementList.removeElementAt(index);\r
 478         return (org.vamsas.objects.core.AnnotationElement) obj;\r
 479     } //-- org.vamsas.objects.core.AnnotationElement removeAnnotationElement(int) \r
 480 \r
 481     /**\r
 482      * Method removeProvenance\r
 483      * \r
 484      * \r
 485      * \r
 486      * @param index\r
 487      * @return Provenance\r
 488      */\r
 489     public org.vamsas.objects.core.Provenance removeProvenance(int index)\r
 490     {\r
 491         java.lang.Object obj = _provenanceList.elementAt(index);\r
 492         _provenanceList.removeElementAt(index);\r
 493         return (org.vamsas.objects.core.Provenance) obj;\r
 494     } //-- org.vamsas.objects.core.Provenance removeProvenance(int) \r
 495 \r
 496     /**\r
 497      * Method setAnnotationElement\r
 498      * \r
 499      * \r
 500      * \r
 501      * @param index\r
 502      * @param vAnnotationElement\r
 503      */\r
 504     public void setAnnotationElement(int index, org.vamsas.objects.core.AnnotationElement vAnnotationElement)\r
 505         throws java.lang.IndexOutOfBoundsException\r
 506     {\r
 507         //-- check bounds for index\r
 508         if ((index < 0) || (index > _annotationElementList.size())) {\r
 509             throw new IndexOutOfBoundsException();\r
 510         }\r
 511         _annotationElementList.setElementAt(vAnnotationElement, index);\r
 512     } //-- void setAnnotationElement(int, org.vamsas.objects.core.AnnotationElement) \r
 513 \r
 514     /**\r
 515      * Method setAnnotationElement\r
 516      * \r
 517      * \r
 518      * \r
 519      * @param annotationElementArray\r
 520      */\r
 521     public void setAnnotationElement(org.vamsas.objects.core.AnnotationElement[] annotationElementArray)\r
 522     {\r
 523         //-- copy array\r
 524         _annotationElementList.removeAllElements();\r
 525         for (int i = 0; i < annotationElementArray.length; i++) {\r
 526             _annotationElementList.addElement(annotationElementArray[i]);\r
 527         }\r
 528     } //-- void setAnnotationElement(org.vamsas.objects.core.AnnotationElement) \r
 529 \r
 530     /**\r
 531      * Sets the value of field 'begin'.\r
 532      * \r
 533      * @param begin the value of field 'begin'.\r
 534      */\r
 535     public void setBegin(int begin)\r
 536     {\r
 537         this._begin = begin;\r
 538         this._has_begin = true;\r
 539     } //-- void setBegin(int) \r
 540 \r
 541     /**\r
 542      * Sets the value of field 'description'.\r
 543      * \r
 544      * @param description the value of field 'description'.\r
 545      */\r
 546     public void setDescription(java.lang.String description)\r
 547     {\r
 548         this._description = description;\r
 549     } //-- void setDescription(java.lang.String) \r
 550 \r
 551     /**\r
 552      * Sets the value of field 'end'.\r
 553      * \r
 554      * @param end the value of field 'end'.\r
 555      */\r
 556     public void setEnd(int end)\r
 557     {\r
 558         this._end = end;\r
 559         this._has_end = true;\r
 560     } //-- void setEnd(int) \r
 561 \r
 562     /**\r
 563      * Sets the value of field 'id'.\r
 564      * \r
 565      * @param id the value of field 'id'.\r
 566      */\r
 567     public void setId(java.lang.String id)\r
 568     {\r
 569         this._id = id;\r
 570     } //-- void setId(java.lang.String) \r
 571 \r
 572     /**\r
 573      * Method setProvenance\r
 574      * \r
 575      * \r
 576      * \r
 577      * @param index\r
 578      * @param vProvenance\r
 579      */\r
 580     public void setProvenance(int index, org.vamsas.objects.core.Provenance vProvenance)\r
 581         throws java.lang.IndexOutOfBoundsException\r
 582     {\r
 583         //-- check bounds for index\r
 584         if ((index < 0) || (index > _provenanceList.size())) {\r
 585             throw new IndexOutOfBoundsException();\r
 586         }\r
 587         _provenanceList.setElementAt(vProvenance, index);\r
 588     } //-- void setProvenance(int, org.vamsas.objects.core.Provenance) \r
 589 \r
 590     /**\r
 591      * Method setProvenance\r
 592      * \r
 593      * \r
 594      * \r
 595      * @param provenanceArray\r
 596      */\r
 597     public void setProvenance(org.vamsas.objects.core.Provenance[] provenanceArray)\r
 598     {\r
 599         //-- copy array\r
 600         _provenanceList.removeAllElements();\r
 601         for (int i = 0; i < provenanceArray.length; i++) {\r
 602             _provenanceList.addElement(provenanceArray[i]);\r
 603         }\r
 604     } //-- void setProvenance(org.vamsas.objects.core.Provenance) \r
 605 \r
 606     /**\r
 607      * Sets the value of field 'seqRef'.\r
 608      * \r
 609      * @param seqRef the value of field 'seqRef'.\r
 610      */\r
 611     public void setSeqRef(java.lang.Object seqRef)\r
 612     {\r
 613         this._seqRef = seqRef;\r
 614     } //-- void setSeqRef(java.lang.Object) \r
 615 \r
 616     /**\r
 617      * Sets the value of field 'status'.\r
 618      * \r
 619      * @param status the value of field 'status'.\r
 620      */\r
 621     public void setStatus(java.lang.String status)\r
 622     {\r
 623         this._status = status;\r
 624     } //-- void setStatus(java.lang.String) \r
 625 \r
 626     /**\r
 627      * Sets the value of field 'type'.\r
 628      * \r
 629      * @param type the value of field 'type'.\r
 630      */\r
 631     public void setType(java.lang.String type)\r
 632     {\r
 633         this._type = type;\r
 634     } //-- void setType(java.lang.String) \r
 635 \r
 636     /**\r
 637      * Method unmarshal\r
 638      * \r
 639      * \r
 640      * \r
 641      * @param reader\r
 642      * @return Object\r
 643      */\r
 644     public static java.lang.Object unmarshal(java.io.Reader reader)\r
 645         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException\r
 646     {\r
 647         return (org.vamsas.objects.core.DataSetAnnotations) Unmarshaller.unmarshal(org.vamsas.objects.core.DataSetAnnotations.class, reader);\r
 648     } //-- java.lang.Object unmarshal(java.io.Reader) \r
 649 \r
 650     /**\r
 651      * Method validate\r
 652      * \r
 653      */\r
 654     public void validate()\r
 655         throws org.exolab.castor.xml.ValidationException\r
 656     {\r
 657         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
 658         validator.validate(this);\r
 659     } //-- void validate() \r
 660 \r
 661 }\r