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

package org.vamsas.objects.core;

  //---------------------------------/
 //- 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 _entryList
     */
    private java.util.Vector _entryList;


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

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


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

    /**
     * Method addEntry
     * 
     * 
     * 
     * @param vEntry
     */
    public void addEntry(org.vamsas.objects.core.Entry vEntry)
        throws java.lang.IndexOutOfBoundsException
    {
        _entryList.addElement(vEntry);
    } //-- void addEntry(org.vamsas.objects.core.Entry) 

    /**
     * Method addEntry
     * 
     * 
     * 
     * @param index
     * @param vEntry
     */
    public void addEntry(int index, org.vamsas.objects.core.Entry vEntry)
        throws java.lang.IndexOutOfBoundsException
    {
        _entryList.insertElementAt(vEntry, index);
    } //-- void addEntry(int, org.vamsas.objects.core.Entry) 

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

    /**
     * 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._entryList != null) {
                if (temp._entryList == null) return false;
                else if (!(this._entryList.equals(temp._entryList))) 
                    return false;
            }
            else if (temp._entryList != null)
                return false;
            return true;
        }
        return false;
    } //-- boolean equals(java.lang.Object) 

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

    /**
     * Method getEntry
     * 
     * 
     * 
     * @return Entry
     */
    public org.vamsas.objects.core.Entry[] getEntry()
    {
        int size = _entryList.size();
        org.vamsas.objects.core.Entry[] mArray = new org.vamsas.objects.core.Entry[size];
        for (int index = 0; index < size; index++) {
            mArray[index] = (org.vamsas.objects.core.Entry) _entryList.elementAt(index);
        }
        return mArray;
    } //-- org.vamsas.objects.core.Entry[] getEntry() 

    /**
     * Method getEntryCount
     * 
     * 
     * 
     * @return int
     */
    public int getEntryCount()
    {
        return _entryList.size();
    } //-- int getEntryCount() 

    /**
     * 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 removeAllEntry
     * 
     */
    public void removeAllEntry()
    {
        _entryList.removeAllElements();
    } //-- void removeAllEntry() 

    /**
     * Method removeEntry
     * 
     * 
     * 
     * @param index
     * @return Entry
     */
    public org.vamsas.objects.core.Entry removeEntry(int index)
    {
        java.lang.Object obj = _entryList.elementAt(index);
        _entryList.removeElementAt(index);
        return (org.vamsas.objects.core.Entry) obj;
    } //-- org.vamsas.objects.core.Entry removeEntry(int) 

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

    /**
     * Method setEntry
     * 
     * 
     * 
     * @param entryArray
     */
    public void setEntry(org.vamsas.objects.core.Entry[] entryArray)
    {
        //-- copy array
        _entryList.removeAllElements();
        for (int i = 0; i < entryArray.length; i++) {
            _entryList.addElement(entryArray[i]);
        }
    } //-- void setEntry(org.vamsas.objects.core.Entry) 

    /**
     * Method unmarshal
     * 
     * 
     * 
     * @param reader
     * @return Provenance
     */
    public static org.vamsas.objects.core.Provenance unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (org.vamsas.objects.core.Provenance) Unmarshaller.unmarshal(org.vamsas.objects.core.Provenance.class, reader);
    } //-- org.vamsas.objects.core.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() 

}