/*
 * 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 Entry.
 * 
 * @version $Revision$ $Date$
 */
public class Entry extends org.vamsas.client.Vobject 
implements java.io.Serializable
{


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

    /**
     * Primary Key for vamsas object
     *  referencing
     *  
     */
    private java.lang.String _id;

    /**
     * Who
     *  
     */
    private java.lang.String _user;

    /**
     * With which application
     *  
     */
    private java.lang.String _app;

    /**
     * Did what
     *  
     */
    private java.lang.String _action;

    /**
     * When
     *  
     */
    private org.exolab.castor.types.Date _date;

    /**
     * additional information
     *  
     */
    private java.util.Vector _propertyList;

    /**
     * parameter for the action
     *  
     */
    private java.util.Vector _paramList;

    /**
     * bioinformatic objects input to
     *  action
     *  
     */
    private java.util.Vector _inputList;


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

    public Entry() 
     {
        super();
        _propertyList = new Vector();
        _paramList = new Vector();
        _inputList = new Vector();
    } //-- org.vamsas.objects.core.Entry()


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

    /**
     * Method addInput
     * 
     * 
     * 
     * @param vInput
     */
    public void addInput(org.vamsas.objects.core.Input vInput)
        throws java.lang.IndexOutOfBoundsException
    {
        _inputList.addElement(vInput);
    } //-- void addInput(org.vamsas.objects.core.Input) 

    /**
     * Method addInput
     * 
     * 
     * 
     * @param index
     * @param vInput
     */
    public void addInput(int index, org.vamsas.objects.core.Input vInput)
        throws java.lang.IndexOutOfBoundsException
    {
        _inputList.insertElementAt(vInput, index);
    } //-- void addInput(int, org.vamsas.objects.core.Input) 

    /**
     * Method addParam
     * 
     * 
     * 
     * @param vParam
     */
    public void addParam(org.vamsas.objects.core.Param vParam)
        throws java.lang.IndexOutOfBoundsException
    {
        _paramList.addElement(vParam);
    } //-- void addParam(org.vamsas.objects.core.Param) 

    /**
     * Method addParam
     * 
     * 
     * 
     * @param index
     * @param vParam
     */
    public void addParam(int index, org.vamsas.objects.core.Param vParam)
        throws java.lang.IndexOutOfBoundsException
    {
        _paramList.insertElementAt(vParam, index);
    } //-- void addParam(int, org.vamsas.objects.core.Param) 

    /**
     * Method addProperty
     * 
     * 
     * 
     * @param vProperty
     */
    public void addProperty(org.vamsas.objects.core.Property vProperty)
        throws java.lang.IndexOutOfBoundsException
    {
        _propertyList.addElement(vProperty);
    } //-- void addProperty(org.vamsas.objects.core.Property) 

    /**
     * Method addProperty
     * 
     * 
     * 
     * @param index
     * @param vProperty
     */
    public void addProperty(int index, org.vamsas.objects.core.Property vProperty)
        throws java.lang.IndexOutOfBoundsException
    {
        _propertyList.insertElementAt(vProperty, index);
    } //-- void addProperty(int, org.vamsas.objects.core.Property) 

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

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

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

    /**
     * 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 Entry) {
        
            Entry temp = (Entry)obj;
            if (this._id != null) {
                if (temp._id == null) return false;
                else if (!(this._id.equals(temp._id))) 
                    return false;
            }
            else if (temp._id != null)
                return false;
            if (this._user != null) {
                if (temp._user == null) return false;
                else if (!(this._user.equals(temp._user))) 
                    return false;
            }
            else if (temp._user != null)
                return false;
            if (this._app != null) {
                if (temp._app == null) return false;
                else if (!(this._app.equals(temp._app))) 
                    return false;
            }
            else if (temp._app != null)
                return false;
            if (this._action != null) {
                if (temp._action == null) return false;
                else if (!(this._action.equals(temp._action))) 
                    return false;
            }
            else if (temp._action != null)
                return false;
            if (this._date != null) {
                if (temp._date == null) return false;
                else if (!(this._date.equals(temp._date))) 
                    return false;
            }
            else if (temp._date != null)
                return false;
            if (this._propertyList != null) {
                if (temp._propertyList == null) return false;
                else if (!(this._propertyList.equals(temp._propertyList))) 
                    return false;
            }
            else if (temp._propertyList != null)
                return false;
            if (this._paramList != null) {
                if (temp._paramList == null) return false;
                else if (!(this._paramList.equals(temp._paramList))) 
                    return false;
            }
            else if (temp._paramList != null)
                return false;
            if (this._inputList != null) {
                if (temp._inputList == null) return false;
                else if (!(this._inputList.equals(temp._inputList))) 
                    return false;
            }
            else if (temp._inputList != null)
                return false;
            return true;
        }
        return false;
    } //-- boolean equals(java.lang.Object) 

    /**
     * Returns the value of field 'action'. The field 'action' has
     * the following description: Did what
     *  
     * 
     * @return String
     * @return the value of field 'action'.
     */
    public java.lang.String getAction()
    {
        return this._action;
    } //-- java.lang.String getAction() 

    /**
     * Returns the value of field 'app'. The field 'app' has the
     * following description: With which application
     *  
     * 
     * @return String
     * @return the value of field 'app'.
     */
    public java.lang.String getApp()
    {
        return this._app;
    } //-- java.lang.String getApp() 

    /**
     * Returns the value of field 'date'. The field 'date' has the
     * following description: When
     *  
     * 
     * @return Date
     * @return the value of field 'date'.
     */
    public org.exolab.castor.types.Date getDate()
    {
        return this._date;
    } //-- org.exolab.castor.types.Date getDate() 

    /**
     * Returns the value of field 'id'. The field 'id' has the
     * following description: Primary Key for vamsas object
     *  referencing
     *  
     * 
     * @return String
     * @return the value of field 'id'.
     */
    public java.lang.String getId()
    {
        return this._id;
    } //-- java.lang.String getId() 

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

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

    /**
     * Method getInputCount
     * 
     * 
     * 
     * @return int
     */
    public int getInputCount()
    {
        return _inputList.size();
    } //-- int getInputCount() 

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

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

    /**
     * Method getParamCount
     * 
     * 
     * 
     * @return int
     */
    public int getParamCount()
    {
        return _paramList.size();
    } //-- int getParamCount() 

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

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

    /**
     * Method getPropertyCount
     * 
     * 
     * 
     * @return int
     */
    public int getPropertyCount()
    {
        return _propertyList.size();
    } //-- int getPropertyCount() 

    /**
     * Returns the value of field 'user'. The field 'user' has the
     * following description: Who
     *  
     * 
     * @return String
     * @return the value of field 'user'.
     */
    public java.lang.String getUser()
    {
        return this._user;
    } //-- java.lang.String getUser() 

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

    /**
     * Method removeAllParam
     * 
     */
    public void removeAllParam()
    {
        _paramList.removeAllElements();
    } //-- void removeAllParam() 

    /**
     * Method removeAllProperty
     * 
     */
    public void removeAllProperty()
    {
        _propertyList.removeAllElements();
    } //-- void removeAllProperty() 

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

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

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

    /**
     * Sets the value of field 'action'. The field 'action' has the
     * following description: Did what
     *  
     * 
     * @param action the value of field 'action'.
     */
    public void setAction(java.lang.String action)
    {
        this._action = action;
    } //-- void setAction(java.lang.String) 

    /**
     * Sets the value of field 'app'. The field 'app' has the
     * following description: With which application
     *  
     * 
     * @param app the value of field 'app'.
     */
    public void setApp(java.lang.String app)
    {
        this._app = app;
    } //-- void setApp(java.lang.String) 

    /**
     * Sets the value of field 'date'. The field 'date' has the
     * following description: When
     *  
     * 
     * @param date the value of field 'date'.
     */
    public void setDate(org.exolab.castor.types.Date date)
    {
        this._date = date;
    } //-- void setDate(org.exolab.castor.types.Date) 

    /**
     * Sets the value of field 'id'. The field 'id' has the
     * following description: Primary Key for vamsas object
     *  referencing
     *  
     * 
     * @param id the value of field 'id'.
     */
    public void setId(java.lang.String id)
    {
        this._id = id;
    } //-- void setId(java.lang.String) 

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

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

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

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

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

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

    /**
     * Sets the value of field 'user'. The field 'user' has the
     * following description: Who
     *  
     * 
     * @param user the value of field 'user'.
     */
    public void setUser(java.lang.String user)
    {
        this._user = user;
    } //-- void setUser(java.lang.String) 

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

}