rebult for castor-1.1(vamsas version)
[vamsas.git] / src / uk / ac / vamsas / objects / core / DataSetAnnotations.java
index 0507d37..2d1c91a 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This class was automatically generated with 
- * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML
+ * <a href="http://www.castor.org">Castor 1.1</a>, using an XML
  * Schema.
  * $Id$
  */
@@ -11,15 +11,8 @@ package uk.ac.vamsas.objects.core;
  //- Imported classes and packages -/
 //---------------------------------/
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Serializable;
-import java.io.Writer;
-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 DataSetAnnotations.
@@ -42,7 +35,7 @@ implements java.io.Serializable
     private java.lang.Object _seqRef;
 
     /**
-     * Field _provenance
+     * Field _provenance.
      */
     private uk.ac.vamsas.objects.core.Provenance _provenance;
 
@@ -51,10 +44,9 @@ implements java.io.Serializable
      //- Constructors -/
     //----------------/
 
-    public DataSetAnnotations() 
-     {
+    public DataSetAnnotations() {
         super();
-    } //-- uk.ac.vamsas.objects.core.DataSetAnnotations()
+    }
 
 
       //-----------/
@@ -62,13 +54,13 @@ implements java.io.Serializable
     //-----------/
 
     /**
-     * Note: hashCode() has not been overriden
+     * Overrides the java.lang.Object.equals method.
      * 
      * @param obj
-     * @return boolean
+     * @return true if the objects are equal.
      */
-    public boolean equals(java.lang.Object obj)
-    {
+    public boolean equals(
+            final java.lang.Object obj) {
         if ( this == obj )
             return true;
         
@@ -95,87 +87,109 @@ implements java.io.Serializable
             return true;
         }
         return false;
-    } //-- boolean equals(java.lang.Object) 
+    }
 
     /**
      * Returns the value of field 'provenance'.
      * 
-     * @return Provenance
-     * @return the value of field 'provenance'.
+     * @return the value of field 'Provenance'.
      */
-    public uk.ac.vamsas.objects.core.Provenance getProvenance()
-    {
+    public uk.ac.vamsas.objects.core.Provenance getProvenance(
+    ) {
         return this._provenance;
-    } //-- uk.ac.vamsas.objects.core.Provenance getProvenance() 
+    }
 
     /**
      * Returns the value of field 'seqRef'. The field 'seqRef' has
      * the following description: annotation is associated with a
      *  particular dataset sequence 
      * 
-     * @return Object
-     * @return the value of field 'seqRef'.
+     * @return the value of field 'SeqRef'.
      */
-    public java.lang.Object getSeqRef()
-    {
+    public java.lang.Object getSeqRef(
+    ) {
         return this._seqRef;
-    } //-- java.lang.Object getSeqRef() 
+    }
 
     /**
-     * Method isValid
-     * 
+     * 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 boolean
+     * @return true if this object is valid according to the schema
      */
-    public boolean isValid()
-    {
+    public boolean isValid(
+    ) {
         try {
             validate();
-        }
-        catch (org.exolab.castor.xml.ValidationException vex) {
+        } catch (org.exolab.castor.xml.ValidationException vex) {
             return false;
         }
         return true;
-    } //-- boolean isValid() 
+    }
 
     /**
-     * Method marshal
-     * 
      * 
      * 
      * @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(java.io.Writer out)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    public void marshal(
+            final 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
+     * @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(org.xml.sax.ContentHandler handler)
-        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        
+    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);
-    } //-- void marshal(org.xml.sax.ContentHandler) 
+    }
 
     /**
      * Sets the value of field 'provenance'.
      * 
      * @param provenance the value of field 'provenance'.
      */
-    public void setProvenance(uk.ac.vamsas.objects.core.Provenance provenance)
-    {
+    public void setProvenance(
+            final uk.ac.vamsas.objects.core.Provenance provenance) {
         this._provenance = provenance;
-    } //-- void setProvenance(uk.ac.vamsas.objects.core.Provenance) 
+    }
 
     /**
      * Sets the value of field 'seqRef'. The field 'seqRef' has the
@@ -184,34 +198,38 @@ implements java.io.Serializable
      * 
      * @param seqRef the value of field 'seqRef'.
      */
-    public void setSeqRef(java.lang.Object seqRef)
-    {
+    public void setSeqRef(
+            final java.lang.Object seqRef) {
         this._seqRef = seqRef;
-    } //-- void setSeqRef(java.lang.Object) 
+    }
 
     /**
-     * Method unmarshal
-     * 
-     * 
+     * Method unmarshal.
      * 
      * @param reader
-     * @return RangeType
+     * @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(java.io.Reader reader)
-        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
-    {
-        return (uk.ac.vamsas.objects.core.DataSetAnnotations) Unmarshaller.unmarshal(uk.ac.vamsas.objects.core.DataSetAnnotations.class, reader);
-    } //-- uk.ac.vamsas.objects.core.RangeType unmarshal(java.io.Reader) 
+    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);
+    }
 
     /**
-     * Method validate
      * 
+     * 
+     * @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
-    {
+    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() 
+    }
 
 }