src/org/vamsas/client/objects/Provenance.java

   1 /*
   2  * This class was automatically generated with
   3  * <a href="http://www.castor.org">Castor 0.9.9M1</a>, using an XML
   4  * Schema.
   5  * $Id$
   6  */
   7
   8 package org.vamsas.client.objects;
   9
  10   //---------------------------------/
  11  //- Imported classes and packages -/
  12 //---------------------------------/
  13
  14 import java.io.IOException;
  15 import java.io.Reader;
  16 import java.io.Serializable;
  17 import java.io.Writer;
  18 import java.util.Enumeration;
  19 import java.util.Vector;
  20 import org.exolab.castor.xml.MarshalException;
  21 import org.exolab.castor.xml.Marshaller;
  22 import org.exolab.castor.xml.Unmarshaller;
  23 import org.exolab.castor.xml.ValidationException;
  24 import org.xml.sax.ContentHandler;
  25
  26 /**
  27  * Class Provenance.
  28  *
  29  * @version $Revision$ $Date$
  30  */
  31 public class Provenance extends org.vamsas.client.object
  32 implements java.io.Serializable
  33 {
  34
  35
  36       //--------------------------/
  37      //- Class/Member Variables -/
  38     //--------------------------/
  39
  40     /**
  41      * Field _items
  42      */
  43     private java.util.Vector _items;
  44
  45
  46       //----------------/
  47      //- Constructors -/
  48     //----------------/
  49
  50     public Provenance()
  51      {
  52         super();
  53         _items = new Vector();
  54     } //-- org.vamsas.client.objects.Provenance()
  55
  56
  57       //-----------/
  58      //- Methods -/
  59     //-----------/
  60
  61     /**
  62      * Method addProvenanceItem
  63      *
  64      *
  65      *
  66      * @param vProvenanceItem
  67      */
  68     public void addProvenanceItem(org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
  69         throws java.lang.IndexOutOfBoundsException
  70     {
  71         _items.addElement(vProvenanceItem);
  72     } //-- void addProvenanceItem(org.vamsas.client.objects.ProvenanceItem)
  73
  74     /**
  75      * Method addProvenanceItem
  76      *
  77      *
  78      *
  79      * @param index
  80      * @param vProvenanceItem
  81      */
  82     public void addProvenanceItem(int index, org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
  83         throws java.lang.IndexOutOfBoundsException
  84     {
  85         _items.insertElementAt(vProvenanceItem, index);
  86     } //-- void addProvenanceItem(int, org.vamsas.client.objects.ProvenanceItem)
  87
  88     /**
  89      * Method enumerateProvenanceItem
  90      *
  91      *
  92      *
  93      * @return Enumeration
  94      */
  95     public java.util.Enumeration enumerateProvenanceItem()
  96     {
  97         return _items.elements();
  98     } //-- java.util.Enumeration enumerateProvenanceItem()
  99
 100     /**
 101      * Note: hashCode() has not been overriden
 102      *
 103      * @param obj
 104      * @return boolean
 105      */
 106     public boolean equals(java.lang.Object obj)
 107     {
 108         if ( this == obj )
 109             return true;
 110
 111         if (super.equals(obj)==false)
 112             return false;
 113
 114         if (obj instanceof Provenance) {
 115
 116             Provenance temp = (Provenance)obj;
 117             if (this._items != null) {
 118                 if (temp._items == null) return false;
 119                 else if (!(this._items.equals(temp._items)))
 120                     return false;
 121             }
 122             else if (temp._items != null)
 123                 return false;
 124             return true;
 125         }
 126         return false;
 127     } //-- boolean equals(java.lang.Object)
 128
 129     /**
 130      * Method getProvenanceItem
 131      *
 132      *
 133      *
 134      * @param index
 135      * @return ProvenanceItem
 136      */
 137     public org.vamsas.client.objects.ProvenanceItem getProvenanceItem(int index)
 138         throws java.lang.IndexOutOfBoundsException
 139     {
 140         //-- check bounds for index
 141         if ((index < 0) || (index > _items.size())) {
 142             throw new IndexOutOfBoundsException("getProvenanceItem: Index value '"+index+"' not in range [0.."+_items.size()+ "]");
 143         }
 144
 145         return (org.vamsas.client.objects.ProvenanceItem) _items.elementAt(index);
 146     } //-- org.vamsas.client.objects.ProvenanceItem getProvenanceItem(int)
 147
 148     /**
 149      * Method getProvenanceItem
 150      *
 151      *
 152      *
 153      * @return ProvenanceItem
 154      */
 155     public org.vamsas.client.objects.ProvenanceItem[] getProvenanceItem()
 156     {
 157         int size = _items.size();
 158         org.vamsas.client.objects.ProvenanceItem[] mArray = new org.vamsas.client.objects.ProvenanceItem[size];
 159         for (int index = 0; index < size; index++) {
 160             mArray[index] = (org.vamsas.client.objects.ProvenanceItem) _items.elementAt(index);
 161         }
 162         return mArray;
 163     } //-- org.vamsas.client.objects.ProvenanceItem[] getProvenanceItem()
 164
 165     /**
 166      * Method getProvenanceItemAsReference
 167      *
 168      * Returns a reference to 'provenanceItem'. No type checking is
 169      * performed on any modications to the Vector.
 170      *
 171      * @return Vector
 172      * @return returns a reference to the Vector.
 173      */
 174     public java.util.Vector getProvenanceItemAsReference()
 175     {
 176         return _items;
 177     } //-- java.util.Vector getProvenanceItemAsReference()
 178
 179     /**
 180      * Method getProvenanceItemCount
 181      *
 182      *
 183      *
 184      * @return int
 185      */
 186     public int getProvenanceItemCount()
 187     {
 188         return _items.size();
 189     } //-- int getProvenanceItemCount()
 190
 191     /**
 192      * Method isValid
 193      *
 194      *
 195      *
 196      * @return boolean
 197      */
 198     public boolean isValid()
 199     {
 200         try {
 201             validate();
 202         }
 203         catch (org.exolab.castor.xml.ValidationException vex) {
 204             return false;
 205         }
 206         return true;
 207     } //-- boolean isValid()
 208
 209     /**
 210      * Method marshal
 211      *
 212      *
 213      *
 214      * @param out
 215      */
 216     public void marshal(java.io.Writer out)
 217         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 218     {
 219
 220         Marshaller.marshal(this, out);
 221     } //-- void marshal(java.io.Writer)
 222
 223     /**
 224      * Method marshal
 225      *
 226      *
 227      *
 228      * @param handler
 229      */
 230     public void marshal(org.xml.sax.ContentHandler handler)
 231         throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 232     {
 233
 234         Marshaller.marshal(this, handler);
 235     } //-- void marshal(org.xml.sax.ContentHandler)
 236
 237     /**
 238      * Method removeAllProvenanceItem
 239      *
 240      */
 241     public void removeAllProvenanceItem()
 242     {
 243         _items.removeAllElements();
 244     } //-- void removeAllProvenanceItem()
 245
 246     /**
 247      * Method removeProvenanceItem
 248      *
 249      *
 250      *
 251      * @param index
 252      * @return ProvenanceItem
 253      */
 254     public org.vamsas.client.objects.ProvenanceItem removeProvenanceItem(int index)
 255     {
 256         java.lang.Object obj = _items.elementAt(index);
 257         _items.removeElementAt(index);
 258         return (org.vamsas.client.objects.ProvenanceItem) obj;
 259     } //-- org.vamsas.client.objects.ProvenanceItem removeProvenanceItem(int)
 260
 261     /**
 262      * Method setProvenanceItem
 263      *
 264      *
 265      *
 266      * @param index
 267      * @param vProvenanceItem
 268      */
 269     public void setProvenanceItem(int index, org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
 270         throws java.lang.IndexOutOfBoundsException
 271     {
 272         //-- check bounds for index
 273         if ((index < 0) || (index > _items.size())) {
 274             throw new IndexOutOfBoundsException("setProvenanceItem: Index value '"+index+"' not in range [0.."+_items.size()+ "]");
 275         }
 276         _items.setElementAt(vProvenanceItem, index);
 277     } //-- void setProvenanceItem(int, org.vamsas.client.objects.ProvenanceItem)
 278
 279     /**
 280      * Method setProvenanceItem
 281      *
 282      *
 283      *
 284      * @param provenanceItemArray
 285      */
 286     public void setProvenanceItem(org.vamsas.client.objects.ProvenanceItem[] provenanceItemArray)
 287     {
 288         //-- copy array
 289         _items.removeAllElements();
 290         for (int i = 0; i < provenanceItemArray.length; i++) {
 291             _items.addElement(provenanceItemArray[i]);
 292         }
 293     } //-- void setProvenanceItem(org.vamsas.client.objects.ProvenanceItem)
 294
 295     /**
 296      * Method setProvenanceItem
 297      *
 298      * Sets the value of 'provenanceItem' by copying the given
 299      * Vector.
 300      *
 301      * @param provenanceItemVector the Vector to copy.
 302      */
 303     public void setProvenanceItem(java.util.Vector provenanceItemVector)
 304     {
 305         //-- copy vector
 306         _items.removeAllElements();
 307         for (int i = 0; i < provenanceItemVector.size(); i++) {
 308             _items.addElement((org.vamsas.client.objects.ProvenanceItem)provenanceItemVector.elementAt(i));
 309         }
 310     } //-- void setProvenanceItem(java.util.Vector)
 311
 312     /**
 313      * Method setProvenanceItemAsReference
 314      *
 315      * Sets the value of 'provenanceItem' by setting it to the
 316      * given Vector. No type checking is performed.
 317      *
 318      * @param provenanceItemVector the Vector to copy.
 319      */
 320     public void setProvenanceItemAsReference(java.util.Vector provenanceItemVector)
 321     {
 322         _items = provenanceItemVector;
 323     } //-- void setProvenanceItemAsReference(java.util.Vector)
 324
 325     /**
 326      * Method unmarshal
 327      *
 328      *
 329      *
 330      * @param reader
 331      * @return Provenance
 332      */
 333     public static org.vamsas.client.objects.Provenance unmarshal(java.io.Reader reader)
 334         throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
 335     {
 336         return (org.vamsas.client.objects.Provenance) Unmarshaller.unmarshal(org.vamsas.client.objects.Provenance.class, reader);
 337     } //-- org.vamsas.client.objects.Provenance unmarshal(java.io.Reader)
 338
 339     /**
 340      * Method validate
 341      *
 342      */
 343     public void validate()
 344         throws org.exolab.castor.xml.ValidationException
 345     {
 346         org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
 347         validator.validate(this);
 348     } //-- void validate()
 349
 350 }