/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 0.9.9M1</a>, using an XML
 * Schema.
 * $Id$
 */

package org.vamsas.client.objects;

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;
import java.io.Writer;
import java.util.Enumeration;
import java.util.Vector;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.xml.sax.ContentHandler;

/**
 * Class Provenance.
 * 
 * @version $Revision$ $Date$
 */
public class Provenance extends org.vamsas.client.object 
implements java.io.Serializable
{


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * Field _items
     */
    private java.util.Vector _items;


      //----------------/
     //- Constructors -/
    //----------------/

    public Provenance() 
     {
        super();
        _items = new Vector();
    } //-- org.vamsas.client.objects.Provenance()


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method addProvenanceItem
     * 
     * 
     * 
     * @param vProvenanceItem
     */
    public void addProvenanceItem(org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
        throws java.lang.IndexOutOfBoundsException
    {
        _items.addElement(vProvenanceItem);
    } //-- void addProvenanceItem(org.vamsas.client.objects.ProvenanceItem) 

    /**
     * Method addProvenanceItem
     * 
     * 
     * 
     * @param index
     * @param vProvenanceItem
     */
    public void addProvenanceItem(int index, org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
        throws java.lang.IndexOutOfBoundsException
    {
        _items.insertElementAt(vProvenanceItem, index);
    } //-- void addProvenanceItem(int, org.vamsas.client.objects.ProvenanceItem) 

    /**
     * Method enumerateProvenanceItem
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateProvenanceItem()
    {
        return _items.elements();
    } //-- java.util.Enumeration enumerateProvenanceItem() 

    /**
     * Note: hashCode() has not been overriden
     * 
     * @param obj
     * @return boolean
     */
    public boolean equals(java.lang.Object obj)
    {
        if ( this == obj )
            return true;
        
        if (super.equals(obj)==false)
            return false;
        
        if (obj instanceof Provenance) {
        
            Provenance temp = (Provenance)obj;
            if (this._items != null) {
                if (temp._items == null) return false;
                else if (!(this._items.equals(temp._items))) 
                    return false;
            }
            else if (temp._items != null)
                return false;
            return true;
        }
        return false;
    } //-- boolean equals(java.lang.Object) 

    /**
     * Method getProvenanceItem
     * 
     * 
     * 
     * @param index
     * @return ProvenanceItem
     */
    public org.vamsas.client.objects.ProvenanceItem getProvenanceItem(int index)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _items.size())) {
            throw new IndexOutOfBoundsException("getProvenanceItem: Index value '"+index+"' not in range [0.."+_items.size()+ "]");
        }
        
        return (org.vamsas.client.objects.ProvenanceItem) _items.elementAt(index);
    } //-- org.vamsas.client.objects.ProvenanceItem getProvenanceItem(int) 

    /**
     * Method getProvenanceItem
     * 
     * 
     * 
     * @return ProvenanceItem
     */
    public org.vamsas.client.objects.ProvenanceItem[] getProvenanceItem()
    {
        int size = _items.size();
        org.vamsas.client.objects.ProvenanceItem[] mArray = new org.vamsas.client.objects.ProvenanceItem[size];
        for (int index = 0; index < size; index++) {
            mArray[index] = (org.vamsas.client.objects.ProvenanceItem) _items.elementAt(index);
        }
        return mArray;
    } //-- org.vamsas.client.objects.ProvenanceItem[] getProvenanceItem() 

    /**
     * Method getProvenanceItemAsReference
     * 
     * Returns a reference to 'provenanceItem'. No type checking is
     * performed on any modications to the Vector.
     * 
     * @return Vector
     * @return returns a reference to the Vector.
     */
    public java.util.Vector getProvenanceItemAsReference()
    {
        return _items;
    } //-- java.util.Vector getProvenanceItemAsReference() 

    /**
     * Method getProvenanceItemCount
     * 
     * 
     * 
     * @return int
     */
    public int getProvenanceItemCount()
    {
        return _items.size();
    } //-- int getProvenanceItemCount() 

    /**
     * Method isValid
     * 
     * 
     * 
     * @return boolean
     */
    public boolean isValid()
    {
        try {
            validate();
        }
        catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    } //-- boolean isValid() 

    /**
     * Method marshal
     * 
     * 
     * 
     * @param out
     */
    public void marshal(java.io.Writer out)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, out);
    } //-- void marshal(java.io.Writer) 

    /**
     * Method marshal
     * 
     * 
     * 
     * @param handler
     */
    public void marshal(org.xml.sax.ContentHandler handler)
        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, handler);
    } //-- void marshal(org.xml.sax.ContentHandler) 

    /**
     * Method removeAllProvenanceItem
     * 
     */
    public void removeAllProvenanceItem()
    {
        _items.removeAllElements();
    } //-- void removeAllProvenanceItem() 

    /**
     * Method removeProvenanceItem
     * 
     * 
     * 
     * @param index
     * @return ProvenanceItem
     */
    public org.vamsas.client.objects.ProvenanceItem removeProvenanceItem(int index)
    {
        java.lang.Object obj = _items.elementAt(index);
        _items.removeElementAt(index);
        return (org.vamsas.client.objects.ProvenanceItem) obj;
    } //-- org.vamsas.client.objects.ProvenanceItem removeProvenanceItem(int) 

    /**
     * Method setProvenanceItem
     * 
     * 
     * 
     * @param index
     * @param vProvenanceItem
     */
    public void setProvenanceItem(int index, org.vamsas.client.objects.ProvenanceItem vProvenanceItem)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _items.size())) {
            throw new IndexOutOfBoundsException("setProvenanceItem: Index value '"+index+"' not in range [0.."+_items.size()+ "]");
        }
        _items.setElementAt(vProvenanceItem, index);
    } //-- void setProvenanceItem(int, org.vamsas.client.objects.ProvenanceItem) 

    /**
     * Method setProvenanceItem
     * 
     * 
     * 
     * @param provenanceItemArray
     */
    public void setProvenanceItem(org.vamsas.client.objects.ProvenanceItem[] provenanceItemArray)
    {
        //-- copy array
        _items.removeAllElements();
        for (int i = 0; i < provenanceItemArray.length; i++) {
            _items.addElement(provenanceItemArray[i]);
        }
    } //-- void setProvenanceItem(org.vamsas.client.objects.ProvenanceItem) 

    /**
     * Method setProvenanceItem
     * 
     * Sets the value of 'provenanceItem' by copying the given
     * Vector.
     * 
     * @param provenanceItemVector the Vector to copy.
     */
    public void setProvenanceItem(java.util.Vector provenanceItemVector)
    {
        //-- copy vector
        _items.removeAllElements();
        for (int i = 0; i < provenanceItemVector.size(); i++) {
            _items.addElement((org.vamsas.client.objects.ProvenanceItem)provenanceItemVector.elementAt(i));
        }
    } //-- void setProvenanceItem(java.util.Vector) 

    /**
     * Method setProvenanceItemAsReference
     * 
     * Sets the value of 'provenanceItem' by setting it to the
     * given Vector. No type checking is performed.
     * 
     * @param provenanceItemVector the Vector to copy.
     */
    public void setProvenanceItemAsReference(java.util.Vector provenanceItemVector)
    {
        _items = provenanceItemVector;
    } //-- void setProvenanceItemAsReference(java.util.Vector) 

    /**
     * Method unmarshal
     * 
     * 
     * 
     * @param reader
     * @return Provenance
     */
    public static org.vamsas.client.objects.Provenance unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (org.vamsas.client.objects.Provenance) Unmarshaller.unmarshal(org.vamsas.client.objects.Provenance.class, reader);
    } //-- org.vamsas.client.objects.Provenance unmarshal(java.io.Reader) 

    /**
     * Method validate
     * 
     */
    public void validate()
        throws org.exolab.castor.xml.ValidationException
    {
        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
        validator.validate(this);
    } //-- void validate() 

}