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

package uk.ac.vamsas.objects.core;

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

import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;

/**
 * Class DataSetAnnotations.
 * 
 * @version $Revision$ $Date$
 */
public class DataSetAnnotations extends uk.ac.vamsas.objects.core.RangeAnnotation 
implements java.io.Serializable
{


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

    /**
     * annotation is associated with a
     *  particular dataset sequence 
     */
    private java.lang.Object _seqRef;

    /**
     * Field _provenance.
     */
    private uk.ac.vamsas.objects.core.Provenance _provenance;


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

    public DataSetAnnotations() {
        super();
    }


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

    /**
     * Overrides the java.lang.Object.equals method.
     * 
     * @param obj
     * @return true if the objects are equal.
     */
    public boolean equals(
            final java.lang.Object obj) {
        if ( this == obj )
            return true;
        
        if (super.equals(obj)==false)
            return false;
        
        if (obj instanceof DataSetAnnotations) {
        
            DataSetAnnotations temp = (DataSetAnnotations)obj;
            if (this._seqRef != null) {
                if (temp._seqRef == null) return false;
                else if (!(this._seqRef.equals(temp._seqRef))) 
                    return false;
            }
            else if (temp._seqRef != null)
                return false;
            if (this._provenance != null) {
                if (temp._provenance == null) return false;
                else if (!(this._provenance.equals(temp._provenance))) 
                    return false;
            }
            else if (temp._provenance != null)
                return false;
            return true;
        }
        return false;
    }

    /**
     * Returns the value of field 'provenance'.
     * 
     * @return the value of field 'Provenance'.
     */
    public uk.ac.vamsas.objects.core.Provenance getProvenance(
    ) {
        return this._provenance;
    }

    /**
     * Returns the value of field 'seqRef'. The field 'seqRef' has
     * the following description: annotation is associated with a
     *  particular dataset sequence 
     * 
     * @return the value of field 'SeqRef'.
     */
    public java.lang.Object getSeqRef(
    ) {
        return this._seqRef;
    }

    /**
     * Overrides the java.lang.Object.hashCode method.
     * <p>
     * The following steps came from <b>Effective Java Programming
     * Language Guide</b> by Joshua Bloch, Chapter 3
     * 
     * @return a hash code value for the object.
     */
    public int hashCode(
    ) {
        int result = super.hashCode();
        
        long tmp;
        if (_seqRef != null) {
           result = 37 * result + _seqRef.hashCode();
        }
        if (_provenance != null) {
           result = 37 * result + _provenance.hashCode();
        }
        
        return result;
    }

    /**
     * Method isValid.
     * 
     * @return true if this object is valid according to the schema
     */
    public boolean isValid(
    ) {
        try {
            validate();
        } catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    }

    /**
     * 
     * 
     * @param out
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void marshal(
            final java.io.Writer out)
    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        Marshaller.marshal(this, out);
    }

    /**
     * 
     * 
     * @param handler
     * @throws java.io.IOException if an IOException occurs during
     * marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     */
    public void marshal(
            final org.xml.sax.ContentHandler handler)
    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        Marshaller.marshal(this, handler);
    }

    /**
     * Sets the value of field 'provenance'.
     * 
     * @param provenance the value of field 'provenance'.
     */
    public void setProvenance(
            final uk.ac.vamsas.objects.core.Provenance provenance) {
        this._provenance = provenance;
    }

    /**
     * Sets the value of field 'seqRef'. The field 'seqRef' has the
     * following description: annotation is associated with a
     *  particular dataset sequence 
     * 
     * @param seqRef the value of field 'seqRef'.
     */
    public void setSeqRef(
            final java.lang.Object seqRef) {
        this._seqRef = seqRef;
    }

    /**
     * Method unmarshal.
     * 
     * @param reader
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @return the unmarshaled uk.ac.vamsas.objects.core.RangeType
     */
    public static uk.ac.vamsas.objects.core.RangeType unmarshal(
            final java.io.Reader reader)
    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        return (uk.ac.vamsas.objects.core.RangeType) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.DataSetAnnotations.class, reader);
    }

    /**
     * 
     * 
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void validate(
    )
    throws org.exolab.castor.xml.ValidationException {
        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
        validator.validate(this);
    }

}